Spring的声明式事务管理（李刚 轻量级javaEE 企业应用实战-三大框架整合开发）

最近在学习李刚著的《轻量级J2EE企业应用实战》，这本书写得条例清晰，通俗易懂，非常容易上手。在学习过程中，我自己参考该书做了些例子。下面是对Spring的声明式事务管理的总结和示例：

通常建议采用声明式事务管理。声明式事务管理的优势非常明显：代码中无需关于关注事务逻辑，不需要修改业务逻辑代码，在业务逻辑中可以专心业务逻辑代码的编写，无需编写大量的事务逻辑代码。让Spring声明式事务管理负责事务逻辑，声明式事务管理无需与具体的事务逻辑耦合，可以方便地在不同事务逻辑之间切换。
声明式事务管理的配置方式，通常有如下三种：
1.使用TransactionProxyFactoryBean为目标bean生成事务代理的配置方式最为常用。

2.采用bean继承的事务代理配置方式，比较简洁，但依然是增量式配置。
3.使用BeanNameAutoProxyCreator，根据bean name自动生成事务代理的方式，这是直接利用Spring的AOP框架配置事务代理的方式，需要对Spring的AOP框架有所理解。但这种方式避免了增量式配置，效果非常不错。
4.DefaultAdvisorAutoProxyCreator：这也是直接利用Spring的AOP框架配置事务代理的方式，效果也非常不多，只是这种配置方式的可读性不如第三种方式。

一. 利用TransactionProxyFactoryBean生成事务代理
采用这种方式的配置时候，配置文件的增加非常快，每个bean有需要两个bean配置，一个目标，另外还需要使用TransactionProxyFactoryBean配置一个代理bean。
这是一种最原始的配置方式，下面是使用TransactionProxyFactoryBean的配置文件：

<? xml version="1.0" encoding="gb2312" ?>
<!--   Spring配置文件的文件头，包含DTD等信息 -->
<! DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN"
 "http://www.springframework.org/dtd/spring-beans.dtd" >
< beans >
     <!-- 定义数据源 -->
     < bean  id ="dataSource"  class ="org.springframework.jdbc.datasource.DriverManagerDataSource" >
         <!--   定义数据库驱动 -->
             < property  name ="driverClassName" >< value > com.mysql.jdbc.Driver </ value ></ property >
         <!--   定义数据库url -->
             < property  name ="url" >< value > jdbc:mysql://localhost:3306/spring </ value ></ property >
         <!--   定义数据库用户名 -->
             < property  name ="username" >< value > root </ value ></ property >
         <!--   定义数据库密码 -->
             < property  name ="password" >< value > 32147 </ value ></ property >
     </ bean >
     <!-- 定义一个hibernate的SessionFactory -->
< bean  id ="sessionFactory"  class ="org.springframework.orm.hibernate3.LocalSessionFactoryBean" >
         <!--   定义SessionFactory必须注入DataSource -->
             < property  name ="dataSource" >< ref  local ="dataSource" /></ property >
             < property  name ="mappingResources" >
             < list >
                 <!-- 以下用来列出所有的PO映射文件 -->
                 < value > Person.hbm.xml </ value >
             </ list >
             </ property >
             < property  name ="hibernateProperties" >
             < props >
<!-- 此处用来定义hibernate的SessionFactory的属性：
不同数据库连接，启动时选择create,update,create-drop -->
             < prop  key ="hibernate.dialect" > org.hibernate.dialect.MySQLDialect </ prop >
             < prop  key ="hibernate.hbm2ddl.auto" > update </ prop >
         </ props >
         </ property >
     </ bean >
     <!--   定义事务管理器，使用适用于Hibernte的事务管理器 -->
< bean  id ="transactionManager"
        class ="org.springframework.orm.hibernate3.HibernateTransactionManager" >
             <!--   HibernateTransactionManager  bean需要依赖注入一个SessionFactory bean的引用 -->
             < property  name ="sessionFactory" >< ref  local ="sessionFactory" /></ property >
     </ bean >
     <!-- 定义DAO Bean , 作为事务代理的目标 -->
     < bean  id ="personDaoTarget"  class ="lee.PersonDaoHibernate" >
         <!--   为DAO bean注入SessionFactory引用 -->
          < property  name ="sessionFactory" >< ref  local ="sessionFactory" /></ property >
     </ bean >
     <!--   定义DAO bean的事务代理 -->
< bean  id ="personDao"  class ="org.springframework.transaction.interceptor.TransactionProxyFactoryBean" >
         <!--   为事务代理bean注入事务管理器 -->
             < property  name ="transactionManager" >< ref  bean ="transactionManager" /></ property >
         <!--   设置事务属性 -->
   < property  name ="transactionAttributes" >
　 < props >
       <!--   所有以find开头的方法，采用required的事务策略，并且只读 -->
                 < prop  key ="find*" > PROPAGATION_REQUIRED,readOnly </ prop >  
       <!--   其他方法，采用required的事务策略 ->
                <prop key="*">PROPAGATION_REQUIRED</prop>
            </props> 
        </property>
       <!--  为事务代理bean设置目标bean  -->
         < property  name ="target" >  
             < ref  local ="personDaoTarget" />  
         </ property >  
     </ bean >
</ beans >

在上面的配置文件中，personDao需要配置两个部分，一个是personDao的目标bean，该目标bean是实际DAO bean，以实际的DAO bean为目标，建立事务代理。一个组件，需要来个bean组成，一个目标bean，一个事务代理。
这种配置方式还有一个坏处：目标bean直接暴露在Spring容器中，可以直接引用，如果目标bean被误引用，将导致业务操作不具备事务性。
为了避免这种现象，可将目标bean配置成嵌套bean，下面是目标bean和事务代理的配置片段：

<!--   定义DAO bean的事务代理 -->
< bean  id ="personDao"  class ="org.springframework.transaction.interceptor.TransactionProxyFactoryBean" >
          <!--   为事务代理bean注入事务管理器 -->
         < property  name ="transactionManager" >< ref  bean ="transactionManager" /></ property >
         <!--   设置事务属性 -->
         < property  name ="transactionAttributes" >  
               < props >
                     <!--   所有以find开头的方法，采用required的事务策略，并且只读 -->
                     < prop  key ="find*" > PROPAGATION_REQUIRED,readOnly </ prop >  
                     <!--   其他方法，采用required的事务策略 ->
                    <prop key="*">PROPAGATION_REQUIRED</prop>
             </props> 
        </property>
        <!--  为事务代理bean设置目标bean  -->
         < property  name ="target" >  
                <!--   采用嵌套bean配置目标bean -->
                < bean  class ="lee.PersonDaoHibernate" >
                   <!--   为DAO bean注入SessionFactory引用 -->
                   < property  name ="sessionFactory" >< ref  local ="sessionFactory" /></ property >
                </ bean >
         </ property >  
</ bean >

二. 利用继承简化配置
大部分情况下，每个事务代理的事务属性大同小异，事务代理的实现类都是TransactionProxyFactoryBean，事务代理bean都必须注入事务管理器。
对于这种情况，Spring提供了bean与bean之间的继承，可以简化配置。将大部分的通用配置，配置成事务模板，而实际的事务代理bean，则继承事务模板。这种配置方式可以减少部分配置代码，下面是采用继承的配置文件：

<? xml version="1.0" encoding="gb2312" ?>
<!--   Spring配置文件的文件头，包含DTD等信息 -->
<! DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN"
    "http://www.springframework.org/dtd/spring-beans.dtd" >
< beans >
     <!-- 定义数据源 -->
     < bean  id ="dataSource"  class ="org.springframework.jdbc.datasource.DriverManagerDataSource" >
         <!--   定义数据库驱动 -->
             < property  name ="driverClassName" >< value > com.mysql.jdbc.Driver </ value ></ property >
         <!--   定义数据库url -->
             < property  name ="url" >< value > jdbc:mysql://localhost:3306/spring </ value ></ property >
         <!--   定义数据库用户名 -->
             < property  name ="username" >< value > root </ value ></ property >
         <!--   定义数据库密码 -->
             < property  name ="password" >< value > 32147 </ value ></ property >
     </ bean >
     <!-- 定义一个hibernate的SessionFactory -->
< bean  id ="sessionFactory"  class ="org.springframework.orm.hibernate3.LocalSessionFactoryBean" >
         <!--   定义SessionFactory必须注入DataSource -->
             < property  name ="dataSource" >< ref  local ="dataSource" /></ property >
             < property  name ="mappingResources" >
             < list >
                 <!-- 以下用来列出所有的PO映射文件 -->
                 < value > Person.hbm.xml </ value >
             </ list >
             </ property >
             < property  name ="hibernateProperties" >
             < props >
<!-- 此处用来定义hibernate的SessionFactory的属性：
不同数据库连接，启动时选择create,update,create-drop -->
             < prop  key ="hibernate.dialect" > org.hibernate.dialect.MySQLDialect </ prop >
             < prop  key ="hibernate.hbm2ddl.auto" > update </ prop >
         </ props >
         </ property >
     </ bean >
     <!--   定义事务管理器，使用适用于Hibernte的事务管理器 -->
< bean  id ="transactionManager"
        class ="org.springframework.orm.hibernate3.HibernateTransactionManager" >
             <!--   HibernateTransactionManager  bean需要依赖注入一个SessionFactory bean的引用 -->
             < property  name ="sessionFactory" >< ref  local ="sessionFactory" /></ property >
     </ bean >
<!--  配置事务模板，模板bean被设置成abstract bean，保证不会被初始化 -->
< bean  id ="txBase"  class ="org.springframework.transaction.interceptor.TransactionProxyFactoryBean"
 lazy-init ="true"  abstract ="true" >
<!--   为事务模板注入事务管理器 -->
< property  name ="transactionManager" >< ref  bean ="transactionManager" /></ property >
<!--   设置事务属性 -->
         < property  name ="transactionAttributes" >  
< props >  
          < prop  key ="find*" > PROPAGATION_REQUIRED,readOnly </ prop >
          < prop  key ="*" > PROPAGATION_REQUIRED </ prop >
     </ props >  
</ property >
</ bean >
<!--   实际的事务代理bean -->
     < bean  id ="personDao"  parent ="txBase" >
<!--   采用嵌套bean配置目标bean  -->
< property  name ="target" >
     < bean  class ="lee.PersonDaoHibernate" >
         < property  name ="sessionFactory" >< ref  local ="sessionFactory" /></ property >
      </ bean >
</ property >
       </ bean >
</ beans >

这种配置方式，相比前面直接采用TransactionProxyFactoryBean的事务代理配置方式，可以大大减少配置文件的代码量。每个事务代理的配置都继承事务模板，无需重复指定事务代理的实现类，无需重复指定事务传播属性——当然，如果新的事务代理有额外的事务属性，也可指定自己的事务属性，此时，子bean的属性覆盖父bean的属性。当然每个事务代理bean都必须配置自己的目标bean，这不可避免。
上面的配置可看出，事务代理的配置依然是增量式的，每个事务代理都需要单独配置——虽然增量已经减少，但每个事务代理都需要单独配置。

三.用BeanNameAutoProxyCreator自动创建事务代理
下面介绍一种优秀的事务代理配置策略：采用这种配置策略，完全可以避免增量式配置，所有的事务代理由系统自动创建。容器中的目标bean自动消失，避免需要使用嵌套bean来保证目标bean不可被访问。
这种配置方式依赖于Spring提供的bean后处理器，该后处理器用于为每个bean自动创建代理，此处的代理不仅可以是事务代理，也可以是任意的代理，只需要有合适的拦截器即可。这些是AOP框架的概念，笔者在此处不对AOP进行深入介绍。读者只需了解这种事务代理的配置方式即可。
下面是采用BeanNameAutoProxyCreator配置事务代理的配置文件：

<? xml version="1.0" encoding="gb2312" ?>
<!--   Spring配置文件的文件头，包含DTD等信息 -->
<! DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN"
    "http://www.springframework.org/dtd/spring-beans.dtd" >
< beans >
     <!-- 定义数据源 -->
     < bean  id ="dataSource"  class ="org.springframework.jdbc.datasource.DriverManagerDataSource" >
         <!--   定义数据库驱动 -->
             < property  name ="driverClassName" >< value > com.mysql.jdbc.Driver </ value ></ property >
         <!--   定义数据库url -->
             < property  name ="url" >< value > jdbc:mysql://localhost:3306/spring </ value ></ property >
<!--   定义数据库用户名 -->
             < property  name ="username" >< value > root </ value ></ property >
         <!--   定义数据库密码 -->
             < property  name ="password" >< value > 32147 </ value ></ property >
     </ bean >
     <!-- 定义一个hibernate的SessionFactory -->
< bean  id ="sessionFactory"  class ="org.springframework.orm.hibernate3.LocalSessionFactoryBean" >
         <!--   定义SessionFactory必须注入DataSource -->
             < property  name ="dataSource" >< ref  local ="dataSource" /></ property >
             < property  name ="mappingResources" >
             < list >
                 <!-- 以下用来列出所有的PO映射文件 -->
                 < value > Person.hbm.xml </ value >
             </ list >
             </ property >
             < property  name ="hibernateProperties" >
             < props >
<!-- 此处用来定义hibernate的SessionFactory的属性：
不同数据库连接，启动时选择create,update,create-drop -->
             < prop  key ="hibernate.dialect" > org.hibernate.dialect.MySQLDialect </ prop >
             < prop  key ="hibernate.hbm2ddl.auto" > update </ prop >
         </ props >
         </ property >
     </ bean >

 

     <!--   定义事务管理器，使用适用于Hibernte的事务管理器 -->
< bean  id ="transactionManager"
        class ="org.springframework.orm.hibernate3.HibernateTransactionManager" >
             <!--   HibernateTransactionManager  bean需要依赖注入一个SessionFactory bean的引用 -->
             < property  name ="sessionFactory" >< ref  local ="sessionFactory" /></ property >
</ bean >

     <!--   配置事务拦截器 -->
< bean  id ="transactionInterceptor"
class ="org.springframework.transaction.interceptor.TransactionInterceptor" >
         <!--   事务拦截器bean需要依赖注入一个事务管理器  -->
         < property  name ="transactionManager"  ref ="transactionManager" />
         < property  name ="transactionAttributes" >
             <!--   下面定义事务传播属性 -->
             < props >
                 < prop  key ="insert*" > PROPAGATION_REQUIRED </ prop >
                 < prop  key ="find*" > PROPAGATION_REQUIRED,readOnly </ prop >
                 < prop  key ="*" > PROPAGATION_REQUIRED </ prop >
             </ props >
         </ property >
     </ bean >
<!--  定义BeanNameAutoProxyCreator,该bean是个bean后处理器，无需被引用，因此没有id属性
这个bean后处理器，根据事务拦截器为目标bean自动创建事务代理
    <bean class="org.springframework.aop.framework.autoproxy.BeanNameAutoProxyCreator">
          指定对满足哪些bean name的bean自动生成业务代理  -->
  < property  name ="beanNames" >
             <!--   下面是所有需要自动创建事务代理的bean -->
             < list >
                 < value > personDao </ value >
             </ list >
             <!--   此处可增加其他需要自动创建事务代理的bean -->
         </ property >
         <!--   下面定义BeanNameAutoProxyCreator所需的事务拦截器 -->
         < property  name ="interceptorNames" >
             < list >
                 < value > transactionInterceptor </ value >  
                     <!--  此处可增加其他新的Interceptor  -->
             </ list >
         </ property >
     </ bean >
     <!-- 定义DAO Bean ,由于BeanNameAutoProxyCreator自动生成事务代理 -->
     < bean  id ="personDao"  class ="lee.PersonDaoHibernate" >
         < property  name ="sessionFactory" >< ref  local ="sessionFactory" /></ property >
</ bean >
</ beans >

TranscationInterceptor是一个事务拦截器bean，需要传入一个TransactionManager的引用。配置中使用Spring依赖注入该属性，事务拦截器的事务属性通过transactionAttributes来指定，该属性有props子元素，配置文件中定义了三个事务传播规则：
所有以insert开始的方法，采用PROPAGATION_REQUIRED的事务传播规则。程序抛出MyException异常及其子异常时，自动回滚事务。所有以find开头的方法，采用PROPAGATION_REQUIRED事务传播规则，并且只读。其他方法，则采用PROPAGATION_REQUIRED的事务传播规则。
BeanNameAutoProxyCreator是个根据bean名生成自动代理的代理创建器，该bean通常需要接受两个参数。第一个是beanNames属性，该属性用来设置哪些bean需要自动生成代理。另一个属性是interceptorNames，该属性则指定事务拦截器，自动创建事务代理时，系统会根据这些事务拦截器的属性来生成对应的事务代理。
为了让读者对这种配置方式有信息，对PersonDaoHibernate的save方法进行简单 修改，修改后的save方法如下：

  /** */ /**
      * 保存人实例
      * @param person 需要保存的Person实例
      */     
     public   void  save(Person person)
     ... {
        getHibernateTemplate().save(person);
        //下面两行代码没有实际意义，仅仅为了引发数据库异常
        DataSource ds = null;
        DataSourceUtils.getConnection(ds);
}

在主程序中调用该save方法，主程序调用save方法的片段如下：

for  ( int  i  =   0  ; i  <   10   ; i ++  )
  ... {
           //保存Person实例
            pdao.save(new Person(String.valueOf(i) , i + 10));
        }

执行完主程序的该片段后，数据表不会插入任何记录。如果BeanNameAutoProxyCreator的配置修改成如下格式：

<!--  定义BeanNameAutoProxyCreator,该bean是个bean后处理器，无需被引用，因此没有id属性
这个bean后处理器，根据事务拦截器为目标bean自动创建事务代理
    <bean class="org.springframework.aop.framework.autoproxy.BeanNameAutoProxyCreator">
          指定对满足哪些bean name的bean自动生成业务代理  -->
         < property  name ="beanNames" >
             <!--   下面是所有需要自动创建事务代理的bean -->
             < list >
                 <!--  value>personDao</value -->
             </ list >
             <!--   此处可增加其他需要自动创建事务代理的bean -->
         </ property >
         <!--   下面定义BeanNameAutoProxyCreator所需的事务拦截器 -->
         < property  name ="interceptorNames" >
             < list >
                 < value > transactionInterceptor </ value  >  
                     <!--  此处可增加其他新的Interceptor  -->
             </ list >
         </ property >
     </ bean >

注意配置文中beanNames属性的变化，将所有personDao项注释，即不再为该bean生成事务代理。再次执行主程序，程序虽然抛出了数据库异常，但数据记录依然被插入数据库。
对比两次结果，这就是事务代理在其中的作用。
这种配置方式相当简洁，每次增加了新的bean，如果需要该bean的方法具有事务性，只需在BeanNameAutoProxyCreator的beanNames属性下增加一行即可，该行告诉bean后处理需要为哪个bean生成事务代理。

四. 用DefaultAdvisorAutoProxyCreator自动创建事务代理
这种配置方式与BeanNameAutoProxyCreator自动创建代理的方式非常相似，都是使用bean后处理器为目标bean创建实物代理，区别是前者使用事务拦截器创建代理，后者需要使用Advisor创建事务代理。
事实上，采用DefaultAdvisorAutoProxyCreator的事务代理配置方式更加简洁，这个代理生成器自动搜索Spring容器中的Advisor，并为容器中所有的bean创建代理。
相对前一种方式，这种方式的可读性不如前一种直观，笔者还是推荐采用第三种配置方式，下面是使用DefaultAdvisorAutoProxyCreator的配置方式：

<? xml version="1.0" encoding="gb2312" ?>
<!--   Spring配置文件的文件头，包含DTD等信息 -->
<! DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN"
    "http://www.springframework.org/dtd/spring-beans.dtd" >
< beans >
     <!-- 定义数据源 -->
     < bean  id ="dataSource"  class ="org.springframework.jdbc.datasource.DriverManagerDataSource" >
         <!--   定义数据库驱动 -->
             < property  name ="driverClassName" >< value > com.mysql.jdbc.Driver </ value ></ property >
         <!--   定义数据库url -->
             < property  name ="url" >< value > jdbc:mysql://localhost:3306/spring </ value ></ property >
         <!--   定义数据库用户名 -->
             < property  name ="username" >< value > root </ value ></ property >
         <!--   定义数据库密码 -->
             < property  name ="password" >< value > 32147 </ value ></ property >
     </ bean >
     <!-- 定义一个hibernate的SessionFactory -->
< bean  id ="sessionFactory"  class ="org.springframework.orm.hibernate3.LocalSessionFactoryBean" >
         <!--   定义SessionFactory必须注入DataSource -->
             < property  name ="dataSource" >< ref  local ="dataSource" /></ property >
             < property  name ="mappingResources" >
             < list >
                 <!-- 以下用来列出所有的PO映射文件 -->
                 < value > Person.hbm.xml </ value >
             </ list >
             </ property >
             < property  name ="hibernateProperties" >
             < props >
<!-- 此处用来定义hibernate的SessionFactory的属性：
不同数据库连接，启动时选择create,update,create-drop -->
             < prop  key ="hibernate.dialect" > org.hibernate.dialect.MySQLDialect </ prop >
             < prop  key ="hibernate.hbm2ddl.auto" > update </ prop >
         </ props >
         </ property >
     </ bean >
     <!--   定义事务管理器，使用适用于Hibernte的事务管理器 -->
< bean  id ="transactionManager"
        class ="org.springframework.orm.hibernate3.HibernateTransactionManager" >
             <!--   HibernateTransactionManager  bean需要依赖注入一个SessionFactory bean的引用 -->
             < property  name ="sessionFactory" >< ref  local ="sessionFactory" /></ property >
</ bean >
     <!--   配置事务拦截器 -->
< bean  id ="transactionInterceptor"
class ="org.springframework.transaction.interceptor.TransactionInterceptor" >
         <!--   事务拦截器bean需要依赖注入一个事务管理器  -->
         < property  name ="transactionManager"  ref ="transactionManager" />
         < property  name ="transactionAttributes" >
             <!--   下面定义事务传播属性 -->
             < props >
                 < prop  key ="insert*" > PROPAGATION_REQUIRED </ prop >
                 < prop  key ="find*" > PROPAGATION_REQUIRED,readOnly </ prop >
                 < prop  key ="*" > PROPAGATION_REQUIRED </ prop >
             </ props >
         </ property >
</ bean >
     <!--   定义事务Advisor -->
< bean  class ="org.springframework.transaction.interceptor.TransactionAttributeSourceAdvisor" >
         <!--   定义advisor时，必须传入Interceptor -->
             < property  name ="transactionInterceptor"  ref ="transactionInterceptor" />
     </ bean >
     <!--  DefaultAdvisorAutoProxyCreator搜索容器中的 advisor,并为每个bean创建代理  -->
< bean  class ="org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator" />
<!-- 定义DAO Bean ,由于BeanNameAutoProxyCreator自动生成事务代理 -->
     < bean  id ="personDao"  class ="lee.PersonDaoHibernate" >
         < property  name ="sessionFactory" >< ref  local ="sessionFactory" /></ property >
</ bean >
</ beans >

在这种配置方式下，配置文件变得更加简洁，增加目标bean，不需要增加任何额外的代码，容器自动为目标bean生成代理。但这种方式的可读性相对较差。