Spring Programmatic Transaction Management

In this article, we will explore about programmatic transaction management. This means that you have manage the transaction with the help of programming. That gives you extreme flexibility, but it is difficult to maintain.

Programmatic transaction management

It is usually a good idea only if you have a small number of transactional operations. For example, if you have a web application that require transactions only for certain update operations, you may not want to set up transactional proxies using Spring or any other technology. In this case, using the TransactionTemplate may be a good approach. Being able to set the transaction name explicitly is also something that can only be done using the programmatic approach to transaction management.

On the other hand, if your application has numerous transactional operations, declarative transaction management is usually worthwhile. It keeps transaction management out of business logic, and is not difficult to configure. When using the Spring Framework, rather than EJB CMT, the configuration cost of declarative transaction management is greatly reduced.

Let us see how above mentioned steps work but before we begin, it is important to have at least one database tables on which we can perform various CRUD operations with the help of transactions. Let us take Employee table, which can be created in MySQL DAVDB database with the following DDL:

CREATE TABLE Employee(
   EMPID   INT NOT NULL AUTO_INCREMENT,
   NAME VARCHAR(26) NOT NULL,
   AGE  INT NOT NULL,
   SALARY BIGINT NOT NULL,
   PRIMARY KEY (EMPID)
);

1. Create a project with a name SpringTMDemo and create a package com.dineshonjava.sdnext under the src folder in the created project.

Spring Programmatic Transaction Management

2. Add required Spring libraries using Add User Libs option as explained in the Spring Hello World Example chapter.
3. Add other required libraries mysql-connector-java.jar
4.Create DAO interface EmpDAO and list down all the required methods. Though it is not required and you can directly write EmployeeDaoImpl class, but as a good practice, let’s do it.
EmpDAO.java

package com.dineshonjava.sdnext.dao;

import java.util.List;

import com.dineshonjava.sdnext.domain.Employee;

/**
 * @author Dinesh Rajput
 *
 */
public interface EmpDao {
 
 /** 
  * This is the method to be used to create
  * a record in the Employee table.
  */
 void create(String name, Integer age, Long salary);
 /** 
  * This is the method to be used to list down
  * a record from the Employee table corresponding
  * to a passed Employee id.
  */
 Employee getEmployee(Integer empid);
 /** 
  * This is the method to be used to list down
  * all the records from the Employee table.
  */
 List listEmployees();
 /** 
  * This is the method to be used to delete
  * a record from the Employee table corresponding
  * to a passed Employee id.
  */
 void delete(Integer empid);
 /** 
  * This is the method to be used to update
  * a record into the Employee table.
  */
 void update(Integer empid, Integer age);
}

EmployeeDaoImpl.java

package com.dineshonjava.sdnext.dao.impl;

import java.util.List;

import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.core.support.JdbcDaoSupport;
import org.springframework.stereotype.Component;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.TransactionDefinition;
import org.springframework.transaction.TransactionStatus;
import org.springframework.transaction.support.DefaultTransactionDefinition;

import com.dineshonjava.sdnext.dao.EmpDao;
import com.dineshonjava.sdnext.domain.Employee;
import com.dineshonjava.sdnext.jdbc.utils.EmployeeMapper;

/**
 * @author Dinesh Rajput
 *
 */
@Component
public class EmployeeDaoImpl extends JdbcDaoSupport implements EmpDao {
// @Autowired
// private JdbcTemplate jdbcTemplateObject;
// 
// /**
//  * @param jdbcTemplateObject the jdbcTemplateObject to set
//  */
// public void setJdbcTemplateObject(JdbcTemplate jdbcTemplateObject) {
//  this.jdbcTemplateObject = jdbcTemplateObject;
// }

private PlatformTransactionManager transactionManage;

 public void setTransactionManager(
      PlatformTransactionManager transactionManager) {
      this.transactionManager = transactionManager;
   }

@Override
public void create(String name, Integer age, Long salary) {
  TransactionDefinition def = new DefaultTransactionDefinition();
  TransactionStatus status = transactionManager.getTransaction(def);
try {
 String SQL = "INSERT INTO Employee (name, age, salary) VALUES (?, ?, ?)";
 getJdbcTemplate().update(SQL, new Object[]{name, age, salary} );
 transactionManager.commit(status);
System.out.println("Created Record Name = " + name + " Age = " + age+ " Salary = " + salary);
 // to simulate the exception.
 throw new RuntimeException("simulate Error condition") ;
  } catch (DataAccessException e) {
       System.out.println("Error in creating record, rolling back");
       transactionManager.rollback(status);       
       throw e;
    }
}

 @Override
 public Employee getEmployee(Integer empid) {
  String SQL = "SELECT * FROM Employee WHERE empid = ?";
  Employee employee = (Employee) getJdbcTemplate().queryForObject(SQL, new Object[]{empid}, new EmployeeMapper());
     return employee;
 }

 @Override
 public List listEmployees() {
  String SQL = "SELECT * FROM Employee";
  List employees = (List) getJdbcTemplate().query(SQL, new EmployeeMapper());
     return null;
 }

 @Override
 public void delete(Integer empid) {
  String SQL = "DELETE FROM Employee WHERE empid = ?";
  getJdbcTemplate().update(SQL, new Object[]{empid});
  System.out.println("Deleted Record with EMPID = " + empid );
 }

 @Override
 public void update(Integer empid, Integer age) {
   String SQL = "UPDATE Employee SET age = ? WHERE empid = ?";
   getJdbcTemplate().update(SQL, new Object[]{age, empid});
   System.out.println("Updated Record with EMPID = " + empid );
 }
}

5. Create other required Java classes Employee, EmployeeMapper and EmpMainApp under the com.dineshonjava.sdnext package. You can create rest of the POJO classes if required.
Employee.java

package com.dineshonjava.sdnext.domain;



/**

 * @author Dinesh Rajput

 *

 */

public class Employee {

 private int empid;

 private String name;

 private int age;

 private long salary;

 /**

  * @return the empid

  */

 public int getEmpid() {

  return empid;

 }

 /**

  * @param empid the empid to set

  */

 public void setEmpid(int empid) {

  this.empid = empid;

 }

 /**

  * @return the name

  */

 public String getName() {

  return name;

 }

 /**

  * @param name the name to set

  */

 public void setName(String name) {

  this.name = name;

 }

 /**

  * @return the age

  */

 public int getAge() {

  return age;

 }

 /**

  * @param age the age to set

  */

 public void setAge(int age) {

  this.age = age;

 }

 /**

  * @return the salary

  */

 public long getSalary() {

  return salary;

 }

 /**

  * @param salary the salary to set

  */

 public void setSalary(long salary) {

  this.salary = salary;

 }

 public String toString(){

  return "EMPLOYEE{empid- "+this.empid+" name- "+this.name+

    " age- "+this.age+" salary- "+this.salary+"}";

 }

}

EmployeeMapper.java

package com.dineshonjava.sdnext.jdbc.utils;

import java.sql.ResultSet;
import java.sql.SQLException;

import org.springframework.jdbc.core.RowMapper;

import com.dineshonjava.sdnext.domain.Employee;

/**
 * @author Dinesh Rajput
 *
 */
public class EmployeeMapper implements RowMapper {  
 public Employee mapRow(ResultSet rs, int rowNum) throws SQLException {  
  Employee employee = new Employee();  
  employee.setEmpid(rs.getInt("empid"));  
  employee.setName(rs.getString("name"));  
  employee.setAge(rs.getInt("age"));  
  employee.setSalary(rs.getLong("salary"));  
  return employee;  
 }  
}  

EmpMainApp.java

package com.dineshonjava.sdnext.main;

import java.util.List;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import com.dineshonjava.sdnext.dao.EmpDao;
import com.dineshonjava.sdnext.domain.Employee;

/**
 * @author Dinesh Rajput
 *
 */
public class EmpMainApp {

 /**
  * @param args
  */
 public static void main(String[] args) {
  ApplicationContext context = new ClassPathXmlApplicationContext("spring.xml");
  EmpDao empDao = (EmpDao) context.getBean("employeeDaoImpl");
  
  System.out.println("------Records Creation--------" );
  empDao.create("Raaz", 25, 50000l);
   
  System.out.println("------Listing Multiple Records--------" );
  List employees = empDao.listEmployees();
  for (Employee employee : employees) {
          System.out.print(employee);
     }
 }
}

6. Create Beans configuration file spring.xml under the src folder.

<beans xmlns:aop="http://www.springframework.org/schema/aop" xmlns:context="http://www.springframework.org/schema/context" xmlns:p="http://www.springframework.org/schema/p" xmlns:security="http://www.springframework.org/schema/security" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.springframework.org/schema/beans" xsi:schemalocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd
     http://www.springframework.org/schema/security http://www.springframework.org/schema/security/spring-security-2.0.4.xsd 
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd 
  http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd">
  
<context:annotation-config></context:annotation-config>
  
<context:component-scan base-package="com.dineshonjava.sdnext.dao.impl">
</context:component-scan>
  
<bean class="org.apache.commons.dbcp.BasicDataSource" id="dataSource">
 <property name="driverClassName" value="com.mysql.jdbc.Driver"></property>
 <property name="url" value="jdbc:mysql://localhost:3306/DAVDB"></property>
 <property name="username" value="root"></property>
 <property name="password" value="root"></property>
 <property name="initialSize" value="2"></property>
 <property name="maxActive" value="5"></property>
</bean>
  
 
   <!-- Initialization for TransactionManager -->
   <bean class="org.springframework.jdbc.datasource.DataSourceTransactionManager" id="transactionManager">
      <property name="dataSource" ref="dataSource"></property>    
   </bean>
   
<bean class="com.dineshonjava.sdnext.dao.impl.EmployeeDaoImpl" id="employeeDaoImpl">
 <property name="dataSource" ref="dataSource"></property>
 <property name="transactionManager" ref="transactionManager"></property>
</bean>
</beans>

Once you are done with creating source and bean configuration files, let us run the application. If everything is fine with your application, this will print the following message:

——Records Creation——–
Created Record Name = Raaz Age = 25 Salary = 50000

 

Previous
Next

One Response

  1. Anonymous August 2, 2013