Spring JTA应用JOTM & Atomikos

Spring JTA应用JOTM & Atomikos

原文：http://tom-duan.iteye.com/blog/147593

关于Spring JTA的介绍非常多了，这里就不再一再阐述其优越性怎么怎么了，直接开始正题。一个大致的需求如下，用户在进行增删改操作时，会同时更新2至3个数据库的数据表，操作需要事务来包裹，以便在操作其中一个数据库的数据表失败时，可以将其他数据库已执行的动作回滚。

由于主框架是Spring，所以将研究的重点放在Spring所提供的的JTA事务上，google了很多资料，发现有几种实现的技术，如JOTM，Atomikos，以及J2EE容器所提供的JTA实现，如JBOSS也都提供了JTA的实现，不过个人喜好来讲，非常厌恶使用JNDI来访问容器组件，所以，重点放在JOTM和Atoimikos两种技术上面，JOTM网上很多资料介绍，配置也非常简单，相信大家通过google就可以快速的上手，本着研究的原则，少少了解了另一种实现技术Atomikos，发现使用方法也很简单，下面就用一个简单的例子来详细说明一下他们在Spring中的配置和使用方法。需要说明的一点是，这个例子也是当时学习两种技术，然后测试的例子，仅仅最后做了一些整理。

初步的设想：一个包括Dao/Service/Test三层的简单应用，事务配置在service层.用来同时插入两个数据库(test,test2)的数据表xa_test,表结构非常简单，包含两个字段id,name,其中test2数据库中表xa_test的name字段不允许为空。

使用的数据库为Mysql 5.0，数据库连接驱动版本5.0.8，这里需要注意，过低版本的Mysql或驱动可能不支持XA Datasource。

Database test ddl

Java代码



CREATE TABLE `xa_test` (

`id` int(11) NOT NULL,

`name` varchar(20) default NULL

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

Database test2 ddl

Java代码



CREATE TABLE `xa_test` (

`id` int(11) NOT NULL,

`name` varchar(20) NOT NULL

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

UserDao,这里使用了两个,UserDao1和UserDao2,用以操作两个不同数据库的数据表(画蛇添足了,呵呵,为了描述清晰).Dao都继承自Spring的JdbcDaoSupport,使用JdbcTemplate进行数据库读写.

UserDao1.java

Java代码



package com.xa.dao;

import org.springframework.jdbc.core.support.JdbcDaoSupport;

public class UserDao1 extends JdbcDaoSupport {

public void insertData(String id, String name) {

getJdbcTemplate().execute("insert into xa_test values('" + id + "'," + name + ")");

}

}

UserDao2.java

Java代码



package com.xa.dao;

import org.springframework.jdbc.core.support.JdbcDaoSupport;

public class UserDao2 extends JdbcDaoSupport

{

public void insertData(String id,String name){

getJdbcTemplate().execute("insert into xa_test values('"+ id +"',"+name+")");

}

}

然后创建UserService和UserServiceImpl,在UserServiceImpl中,将调用Dao1和Dao2的insertData的方法同时插入两个数据库的内容,稍后，会将事务配置在service层.

UserService.java

Java代码



package com.xa.service;

public interface UserService

{

public void insertBothDatabase(String id,String name) throws Exception;

}

UserServiceImpl.java

Java代码



package com.xa.service;

import com.xa.dao.UserDao1;

import com.xa.dao.UserDao2;

public class UserServiceImpl implements UserService

{

private UserDao1 dao1;

private UserDao2 dao2;

public void insertBothDatabase(String id, String name) throws Exception {

dao1.insertData(id, name);

dao2.insertData(id, name);

}

public UserDao1 getDao1() {

return dao1;

}

public void setDao1(UserDao1 dao1) {

this.dao1 = dao1;

}

public UserDao2 getDao2() {

return dao2;

}

public void setDao2(UserDao2 dao2) {

this.dao2 = dao2;

}

}

UserServiceImpl.java的代码可以看到,在insertBothDatabase方法中,调用了两个Dao的方法.

JOTM(Java Open Transaction Manager)是ObjectWeb的一个开源JTA实现，本身也是开源应用程序服务器JOnAS(Java Open Application Server)的一部分，为其提供JTA分布式事务的功能。Spring对JOTM提供了较好的支持，提供了一个org.springframework.transaction.jta.JotmFactoryBean的支持类，在Spring2.0中也包含了JOTM相关的一些library。

jotm的下载地址为http://jotm.objectweb.org,最新版本为2.0.10.

下载完成后解压缩，然后打开jotm下面conf文件夹，拷贝carol.properties文件到classpath中，并修改这个文件如下

carol.properties

Java代码



# do not use CAROL JNDI wrapper

carol.start.jndi=false

# do not start a name server

carol.start.ns=false

# Naming Factory

carol.jndi.java.naming.factory.url.pkgs=org.apache.naming

上面配置文件的目的是不使用JNDI的方式来加载JOTM的配置，当然也可以根据需要选择其它的一些配置，例如JTOM所提供的默认配置。

然后开始在Spring上下文中配置JOTM，在classpath中建立一个ApplicationContext-jotm.xml，配置如下

ApplicationContext-jotm.xml

Java代码



<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www.springframework.org/schema/beans"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">
<bean id="jotm" class="org.springframework.transaction.jta.JotmFactoryBean"/>

<bean id="txManager" class="org.springframework.transaction.jta.JtaTransactionManager">

<property name="userTransaction" ref="jotm" />

</bean>

<bean id="ds1" class="org.enhydra.jdbc.pool.StandardXAPoolDataSource" destroy-method="shutdown">

<property name="dataSource">

<bean class="org.enhydra.jdbc.standard.StandardXADataSource" destroy-method="shutdown">

<property name="transactionManager" ref="jotm" />

<property name="driverName" value="com.mysql.jdbc.Driver" />

<property name="url" value="jdbc:MySQL://localhost:3306/test" />

</bean>

</property>

<property name="user" value="root" />

<property name="password" value="admin" />

</bean>

<bean id="ds2" class="org.enhydra.jdbc.pool.StandardXAPoolDataSource" destroy-method="shutdown">

<property name="dataSource">

<bean class="org.enhydra.jdbc.standard.StandardXADataSource" destroy-method="shutdown">

<property name="transactionManager" ref="jotm" />

<property name="driverName" value="com.mysql.jdbc.Driver" />

<property name="url" value="jdbc:MySQL://localhost:3306/test2" />

</bean>

</property>

<property name="user" value="root" />

<property name="password" value="admin" />

</bean>

<bean id="template1" class="org.springframework.jdbc.core.JdbcTemplate">

<property name="dataSource" ref="ds1" />

</bean>

<bean id="template2" class="org.springframework.jdbc.core.JdbcTemplate">

<property name="dataSource" ref="ds2" />

</bean>

<bean id="dao1" class="com.xa.dao.UserDao1">

<property name="jdbcTemplate">

<ref bean="template1"></ref>

</property>

</bean>

<bean id="dao2" class="com.xa.dao.UserDao2">

<property name="jdbcTemplate">

<ref bean="template2"></ref>

</property>

</bean>

<bean id="userServiceTarget" class="com.xa.service.UserServiceImpl">

<property name="dao1" ref="dao1"/>

<property name="dao2" ref="dao2"/>

</bean>

<bean id="userTest" class="org.springframework.transaction.interceptor.TransactionProxyFactoryBean">

<property name="transactionManager">

<ref bean="txManager"/>

</property>

<property name="target">

<ref bean="userServiceTarget"/>

</property>

<property name="transactionAttributes">

<props>

<prop key="insert*">PROPAGATION_REQUIRED,-Exception</prop>

</props>

</property>

</bean>

</beans>

上面是一个完整的Spring上下文配置，可以看第一个bean “jotm”，实际上引用了Spring内部所提供的对JOTM支持的工厂类，参考下面的配置代码段

Java代码



<bean id="jotm" class="org.springframework.transaction.jta.JotmFactoryBean"/>

随后，配置了JTA事务管理器，并且在管理器中使用上面所配置的jotm，如下面的代码

Java代码



<bean id="txManager" class="org.springframework.transaction.jta.JtaTransactionManager">

<property name="userTransaction" ref="jotm" />

</bean>

再接下来就是配置多个数据源了，使用jotm提供的org.enhydra.jdbc.pool.StandardXAPoolDataSource类，根据类名可以明确地看出它是用以配置多个数据源的啦,配置的代码如下

Java代码



<bean id="ds1" class="org.enhydra.jdbc.pool.StandardXAPoolDataSource" destroy-method="shutdown">

<property name="dataSource">

<bean class="org.enhydra.jdbc.standard.StandardXADataSource" destroy-method="shutdown">

<property name="transactionManager" ref="jotm" />

<property name="driverName" value="com.mysql.jdbc.Driver" />

<property name="url" value="jdbc:MySQL://localhost:3306/test" />

</bean>

</property>

<property name="user" value="root" />

<property name="password" value="admin" />

</bean>

<bean id="ds2" class="org.enhydra.jdbc.pool.StandardXAPoolDataSource" destroy-method="shutdown">

<property name="dataSource">

<bean class="org.enhydra.jdbc.standard.StandardXADataSource" destroy-method="shutdown">

<property name="transactionManager" ref="jotm" />

<property name="driverName" value="com.mysql.jdbc.Driver" />

<property name="url" value="jdbc:MySQL://localhost:3306/test2" />

</bean>

</property>

<property name="user" value="root" />

<property name="password" value="admin" />

</bean>

这里配置的两个数据源都连接到本地的mysql，实际上可以连接到不同的db server和不同类型的数据库，已经经过测试，这里为了方便，在本地建立了两个不同的数据库(test,test2)做测试。

随后的配置基本上和普通的Spring上下文配置相同了，根据不同的数据源配置两个jdbcTemplate，两个dao分别引用不同的jdbcTemplate, 将两个dao注入到UserService中, 最后将service纳入事务管理,并在事务代理配置中配置回滚规则,意思为如遇异常，则强制回滚内容。配置如下所示

Java代码



<property name="transactionAttributes">

<props>

<prop key="insert*">PROPAGATION_REQUIRED,-Exception</prop>

</props>

</property>

这样，一个使用JOTM JTA事务的简单应用算大致成型了，最后，写一个JUnit，来测试一下结果

TestXa.java

Java代码



package com.xa;

import org.springframework.context.ApplicationContext;

import org.springframework.test.AbstractDependencyInjectionSpringContextTests;

import com.xa.service.UserService;

public class TestXa extends AbstractDependencyInjectionSpringContextTests

{

protected String[] getConfigLocations() {

return new String[] { "classpath:ApplicationContext-jotm.xml" };

}

public void testInsertBothDatabase() {

ApplicationContext ctx = this.getApplicationContext();

UserService ut = (UserService)ctx.getBean("userTest");

try {

ut.insertBothDatabase("1", null);

}

catch (Exception e) {

e.printStackTrace();

}

}

}

在test中，调用了UserService的insertBothDatabase方法，有两个参数，userId和UserName，另外在方法的实现中调用了两个使用不同数据源dao，分别向两个不同的数据库插入输入，而test2数据库的xa_test表中，name字段是不允许为空的，因此，在插入test2数据库时会失败.

运行这个test，然后察看数据库结果：），test和test2数据库中都没有插入成功，看serviceImpl中的代码可以知道，逻辑上dao1会先于dao2执行，但是由于JTA事务，在dao2插入数据出现异常时整个事务被回滚，由于事务被配置在service层，dao1和dao2都被纳入一个事务进行管理，呵呵。修改一下方法的参数，修改为

Java代码



ut.insertBothDatabase("1", "name1");

然后再试试test看数据库结果，如何？

前面简单介绍了JOTM如何在Spring中配置，并如何使用它的JTA事务，本节将介绍Atomikos如何与Spring集成，并使用它的JTA事务。

Atomikos,是一个基于Java的开源事务管理器，提供了事务管理和连接池，不需要应用服务器支持，支持JDBC和JMS事务，能提供对Spring，Hibernate的集成，有兴趣多了解的可以直接参考说明文当，有详细的介绍和使用说明。

Atomikos可以到http://www.atomikos.com/products.html#ate下载,最新版本是3.2.0

首先,仍然是一个相关的配置文件，用来设置相关的环境,打开解压缩后Atomikos根目录,拷贝jta.properties到classpath中，并修改为如下内容

jta.properties

Java代码



com.atomikos.icatch.service=com.atomikos.icatch.standalone.UserTransactionServiceFactory

com.atomikos.icatch.console_file_name = tm.out

com.atomikos.icatch.log_base_name = tmlog

com.atomikos.icatch.tm_unique_name = com.atomikos.spring.jdbc.tm

com.atomikos.icatch.console_log_level = INFO

随后，是Spring上下文配置，建立一个名为ApplicationContext-atomikos.xml的Spring上下文

ApplicationContext-atomikos.xml

Java代码



<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www.springframework.org/schema/beans"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">
<!-- XA Datasource -->

<bean id="datasource1" class="com.atomikos.jdbc.SimpleDataSourceBean" init-method="init" destroy-method="close">

<property name="uniqueResourceName">

<value>mysql/main</value>

</property>

<property name="xaDataSourceClassName">

<value>com.mysql.jdbc.jdbc2.optional.MysqlXADataSource</value>

</property>

<property name="xaDataSourceProperties">

<value>URL=jdbc:mysql://localhost:3306/test;user=root;password=admin</value>

</property>

<property name="exclusiveConnectionMode">

<value>true</value>

</property>

<property name="connectionPoolSize">

<value>3</value>

</property>

<property name="validatingQuery">

<value>SELECT 1</value>

</property>

</bean>

<bean id="datasource2" class="com.atomikos.jdbc.SimpleDataSourceBean" init-method="init" destroy-method="close">

<property name="uniqueResourceName">

<value>mysql/news</value>

</property>

<property name="xaDataSourceClassName">

<value>com.mysql.jdbc.jdbc2.optional.MysqlXADataSource</value>

</property>

<property name="xaDataSourceProperties">

<value>URL=jdbc:mysql://localhost:3306/test2;user=root;password=admin</value>

</property>

<property name="exclusiveConnectionMode">

<value>true</value>

</property>

<property name="connectionPoolSize">

<value>3</value>

</property>

<property name="validatingQuery">

<value>SELECT 1</value>

</property>

</bean>

<bean id="template1" class="org.springframework.jdbc.core.JdbcTemplate">

<property name="dataSource" ref="datasource1" />

</bean>

<bean id="template2" class="org.springframework.jdbc.core.JdbcTemplate">

<property name="dataSource" ref="datasource2" />

</bean>

<bean id="atomikosTransactionManager" class="com.atomikos.icatch.jta.UserTransactionManager" init-method="init" destroy-method="close">

<property name="forceShutdown"><value>true</value></property>

</bean>

<bean id="atomikosUserTransaction" class="com.atomikos.icatch.jta.UserTransactionImp">

<property name="transactionTimeout" value="300"/>

</bean>

<bean id="springTransactionManager" class="org.springframework.transaction.jta.JtaTransactionManager">

<property name="transactionManager"><ref bean="atomikosTransactionManager" /></property>

<property name="userTransaction"><ref bean="atomikosUserTransaction" /></property>

</bean>

<bean id="dao1" class="com.xa.dao.UserDao1">

<property name="jdbcTemplate">

<ref bean="template1"></ref>

</property>

</bean>

<bean id="dao2" class="com.xa.dao.UserDao2">

<property name="jdbcTemplate">

<ref bean="template2"></ref>

</property>

</bean>

<!-- -->

<bean id="userServiceTarget" class="com.xa.service.UserServiceImpl">

<property name="dao1" ref="dao1"/>

<property name="dao2" ref="dao2"/>

</bean>

<bean id="userTest" class="org.springframework.transaction.interceptor.TransactionProxyFactoryBean">

<property name="transactionManager">

<ref bean="springTransactionManager"/>

</property>

<property name="target">

<ref bean="userServiceTarget"/>

</property>

<property name="transactionAttributes">

<props>

<prop key="insert*">PROPAGATION_REQUIRED,-Exception</prop>

</props>

</property>

</bean>

</beans>

看上下文中的代码，很大部分和JOTM的相似，atomikos使用com.atomikos.jdbc.SimpleDataSourceBean类来创建datasource bean，这里需要特别注意

Java代码



<property name="uniqueResourceName">

<value>mysql/main</value>

</property>

Java代码



<property name="uniqueResourceName">

<value>mysql/news</value>

</property>

上面的代码为每个Datasource配置了一个唯一的名称，名称不允许相同，否则将会使用同一个datasource，而不会出现异常。

另外在配置文件中定义了Atomikos的事务管理器，并在Spring的JtaTransactionManager中引用

Java代码



<bean id="atomikosTransactionManager" class="com.atomikos.icatch.jta.UserTransactionManager" init-method="init" destroy-method="close">

<property name="forceShutdown"><value>true</value></property>

</bean>

<bean id="atomikosUserTransaction" class="com.atomikos.icatch.jta.UserTransactionImp">

<property name="transactionTimeout" value="300"/>

</bean>

<bean id="springTransactionManager" class="org.springframework.transaction.jta.JtaTransactionManager">

<property name="transactionManager"><ref bean="atomikosTransactionManager" /></property>

<property name="userTransaction"><ref bean="atomikosUserTransaction" /></property>

</bean>

其它的代码没什么特别，和JOTM配置基本相同，JdbcTemplate，DAO，Service，事务代理等等....

仍然使用TestXa.java，修改成引用ApplicationContext-atomikos.xml的上下文配置

Java代码



protected String[] getConfigLocations() {

//return new String[] { "classpath:ApplicationContext-jotm.xml" };

return new String[] { "classpath:ApplicationContext-atomikos.xml" };

}

运行test，然后查看数据库状态，

然后修改方法参数使其不违反数据库约束，再运行Test观察数据库 ：）。