Spring+Mybatis整合事务不起作用之解决方案汇总

前言：

公司最近一个项目用到Spring和Mybatis，发现用起来挺方便，比以前的那个struts+hibernate舒服多了。废话少说，直接摆问题，碰到的问题是，mybatis不在事务中运行，后台日志报 “Closing no transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@19006c9]”错误。无论是加了@Transactional注解和是没加都报这个信息。一个方法中插入多条数据，某次插入失败也不回滚。

问题描述：

环境： Spring 3.1.0 + Mybatis 3.1.0 + mybatis-spring 1.0.0 RC3 + DB2 9.5 + Tomcat 6.0.35

web工程名称： isap

配置文件：applicationContext.xml + isap-servlet.xml

先看配置信息：

applicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd">

<!-- spring配置jndi -->
<bean id="dataSource" class="org.springframework.jndi.JndiObjectFactoryBean">
<property name="jndiName">
<value>java:comp/env/jndi_isap</value>
</property>
</bean>

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="configLocation" value="classpath:config/mybatis-config.xml"></property>
<property name="dataSource" ref="dataSource"/>
<property name="mapperLocations">
<list>
<value>classpath:com/cosbulk/isap/*/dao/mapper/*Mapper.xml</value>
</list>
</property>
</bean>

<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="dataSource" />
<qualifier value="isap"/>
</bean>

<!-- 如果是isap的表，用@Transactional("isap")，如果是smis用 @Transactional("smis")管理事务-->
<tx:annotation-driven transaction-manager="transactionManager" />

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="sqlSessionFactory" ref="sqlSessionFactory"/>
<property name="basePackage" value="com.cosbulk.isap"></property>
</bean>

<!-- /////////////////////////////////////////////////////////////////////////// -->

<!-- smis数据源 -->
<bean id="smisDataSource" class="org.springframework.jndi.JndiObjectFactoryBean">
<property name="jndiName">
<value>java:comp/env/jndi_smis</value>
</property>
</bean>
<bean id="smisSqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="configLocation" value="classpath:config/mybatis-config.xml"></property>
<property name="dataSource" ref="smisDataSource"/>
<property name="mapperLocations">
<list>
<value>classpath:com/cosbulk/smis/dao/mapper/*Mapper.xml</value>
</list>
</property>
</bean>
<bean id="smisTransactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="smisDataSource" />
<qualifier value="smis"/>
</bean>
<!-- 如果是isap的表，用@Transactional("isap")，如果是smis用 @Transactional("smis")管理事务-->
<tx:annotation-driven transaction-manager="smisTransactionManager" />

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="sqlSessionFactory" ref="smisSqlSessionFactory"/>
<property name="basePackage" value="com.cosbulk.smis"></property>
</bean>

</beans>

在applicationContext.xml文件中，主要配置了数据源和dao接口以及mapper文件相关信息，其他的bean信息在isap-servlet.xml文件中定义。

配置文件： isap-servlet.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"
default-autowire="byName">

<!--排除扫描的包， 对web包中的所有类进行扫描，以完成Bean创建和自动依赖注入的功能 -->
<context:component-scan base-package="com.cosbulk.isap">
<context:exclude-filter type="regex" expression="com.cosbulk.isap.*.*.model"/>
<context:exclude-filter type="regex" expression="com.cosbulk.isap.*.*.dao.*"/>
</context:component-scan>

<context:component-scan base-package="com.cosbulk.smis">
<context:exclude-filter type="regex" expression="com.cosbulk.smis.*.*.model"/>
<context:exclude-filter type="regex" expression="com.cosbulk.smis.*.*.dao.*"/>
</context:component-scan>

<mvc:annotation-driven/>

<!--添加拦截器，类级别的处理器映射 -->
<mvc:interceptors>
<bean class="com.cosbulk.isap.common.interceptor.CheckLoginInterceptor" />
</mvc:interceptors>

<!-- 支持文件上传 -->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
<property name="defaultEncoding" value="UTF-8" />
<!-- <property name="maxUploadSize" value="5000000" />  max size 5M -->
</bean>

<!-- 异常处理 -->
<bean id="exceptionResolver" class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
<property name="defaultErrorView">
<value>errorPages/error</value>
</property>
<property name="defaultStatusCode">
<value>500</value>
</property>
<property name="warnLogCategory">
<value>org.springframework.web.servlet.handler.SimpleMappingExceptionResolver</value>
</property>
<property name="exceptionMappings">
<props>
<prop key="org.springframework.web.multipart.MaxUploadSizeExceededException">errorPages/maxUploadExceeded</prop>
</props>
</property>
</bean>

<!-- 视图解析类 -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />
<property name="prefix" value="/view/" />
<property name="suffix" value=".jsp" />
</bean>
</beans>

在这个配置文件里进行了所有的注解（@Controller、@Service等）扫描和mvc相关配置。

事务场景：

Service层通过注解@Transactional注入事务

@Service
//默认将类中的所有函数纳入事务管理.
@Transactional("isap")
public class UserService{
@Autowired
private UserDao userDao;

/**
* 获取主键id
* @return
*/
public Long getId() {
return userDao.getId();
}

/**
* 编辑用户
* @param user
* @param param
*/
public void updateUser(User user,Map<String,Object> param) {
//编辑用户
userDao.updateUser(user);
//删除原有的用户角色关联
userDao.deleteUserRole(param);
String s = null;
s.getBytes();
//新增用户角色关联
insertUserRole(param);
}
这里用来测试事务回滚
...
}

测试过几次updateUser的调用，事务就是不起作用的，后台log信息如下：

DEBUG 2011-09-04 16:19:46,672 org.apache.ibatis.logging.commons.JakartaCommonsLoggingImpl: JDBC Connection [org.apache.commons.dbcp.PoolableConnection@67aece] will not be managed by Spring

DEBUG 2011-09-04 16:19:46,672 org.apache.ibatis.logging.commons.JakartaCommonsLoggingImpl: SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@19006c9] was not registered for synchronization because synchronization is not active

DEBUG 2011-09-04 16:19:46,687 org.apache.ibatis.logging.commons.JakartaCommonsLoggingImpl: Committing JDBC Connection [org.apache.commons.dbcp.PoolableConnection@67aece]

DEBUG 2011-09-04 16:19:46,687 org.apache.ibatis.logging.commons.JakartaCommonsLoggingImpl: Closing no transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@19006c9]

DEBUG 2011-09-04 16:19:46,687 org.springframework.jdbc.datasource.DataSourceUtils: Returning JDBC Connection to DataSource

解决方案：

1、配置文件的问题吧？ （见http://www.iteye.com/topic/1123069）

1.root-context.xml
<!-- 不扫描带有@Controller注解的类。因为这些类已经随容器启动时，在servlet-context中扫描过一遍了 -->
<context:component-scan base-package="com.kimho">
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>

2、servlet-context.xml:
<!-- 扫描业务组件,让spring不扫描带有@Service注解的类(留在root-context.xml中扫描@Service注解的类),防止事务失效 -->
<context:component-scan base-package="com.kimho">
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Service"/>
</context:component-scan>

我做了相应的修改，把isap-servlet里的bean扫描拆成了两部分，分别放入applicationContext.xml和isap-servlet.xml文件中。

applicationContext.xml中加入：

<!-- 扫描带有@Service注解的类。 -->
<context:component-scan base-package="com.cosbulk.isap">
<context:include-filter type="annotation" expression="org.springframework.stereotype.Service" />
</context:component-scan>

<context:component-scan base-package="com.cosbulk.smis">
<context:include-filter type="annotation" expression="org.springframework.stereotype.Service" />
</context:component-scan>

isap-servlet.xml文件中，扫描bean部分换成：

<!--排除扫描的包， 对web包中的所有类进行扫描，以完成Bean创建和自动依赖注入的功能 -->
<context:component-scan base-package="com.cosbulk.isap">
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Service"/>
</context:component-scan>

<context:component-scan base-package="com.cosbulk.smis">
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Service"/>
</context:component-scan>

重启服务器测试，发现效果和之前一样，事务还是没起作用。开始以为是和包扫描的位置有关，于是把扫描的位置放到文件末尾，发现还是没有起作用。最后偶然一个想法clean了下tomcat，然后重启，居然事务有效了。

总结： 修改完配置文件后，clean下工程，重启加载新的配置文件。OK，问题解决。

2、如果按照你的步骤设置为ID为null的话，那么就需要捕获mybatis抛出的异常，然后在catch语句中抛出一个Exception，这个时候Spring容器的事务管理就会起作用，会回滚事务。

3、如果用mysql数据库，数据库表你如果是自动建表，那么就需要把建表的Engine设置为InnoDB格式，自动建表的格式为：MyISAM，这中格式的是不支持事务管理的。

总结下： Spring在使用ContextLoadListener加载applicationContext.xml或其他名称的xml文件时，能进行数据源和相关事务注解的检查，启动事务特性。若在isap-servlet.xml文件中加载是，仅作为普通bean定义加载。所以一个良好的习惯就是，分层配置相关的bean。applicationContext.xml中配置数据库相关的bean（dao、service等）, isap-servlet中配置mvc相关的bean（controller等）。