InitializingBean的作用

转载 2014年07月05日 10:56:44

• 标签：
• spring

• 12016

转自http://blog.csdn.net/mqboss/article/details/7452331

最近工作需要得到sping中的每个事物需要执行的sql，称机会简单研究了一下spring的事务，项目中管理事务比较简单，用TransactionTemplate，就直接以TransactionTemplate为入口开始学习。

TransactionTemplate的源码如下：

[java] view plain copy

1. public class TransactionTemplate extends DefaultTransactionDefinition  
2.         implements TransactionOperations, InitializingBean{  
3.         .  
4.         .  
5.         .  
6.         }  

TransactionTemplate继承了DefaultTransactionDefinition，实现了TransactionOperations，InitializingBean接口。先研究InitializingBean接口
InitializingBean接口为bean提供了初始化方法的方式，它只包括afterPropertiesSet方法，凡是继承该接口的类，在初始化bean的时候会执行该方法。
测试程序如下：

[java] view plain copy

1. import org.springframework.beans.factory.InitializingBean;  
2. public class TestInitializingBean implements InitializingBean{  
3.   
4.     @Override  
5.     public void afterPropertiesSet() throws Exception {  
6.         System.out.println("ceshi InitializingBean");          
7.     }  
8.     public void testInit(){  
9.         System.out.println("ceshi init-method");          
10.     }  
11. }  

配置文件如下：

[html] view plain copy

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <beans xmlns="http://www.springframework.org/schema/beans"  
3.     xmlns:context="http://www.springframework.org/schema/context"  
4.     xmlns:jdbc="http://www.springframework.org/schema/jdbc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
5.     xmlns:p="http://www.springframework.org/schema/p" xmlns:aop="http://www.springframework.org/schema/aop"  
6.     xmlns:tx="http://www.springframework.org/schema/tx"  
7.     xsi:schemaLocation="  
8.     http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">  
9.     <bean id="testInitializingBean" class="com.TestInitializingBean" ></bean>  
10. </beans>  

Main主程序如下：

[java] view plain copy

1. public class Main {  
2.     public static void main(String[] args){  
3.         ApplicationContext context = new FileSystemXmlApplicationContext("/src/main/java/com/beans.xml");  
4.     }  
5. }  

运行Main程序，打印如下结果：
ceshi InitializingBean  
这说明在spring初始化bean的时候，如果bean实现了InitializingBean接口，会自动调用afterPropertiesSet方法。
问题：实现InitializingBean接口与在配置文件中指定init-method有什么不同？
修改配置文件，加上init-method配置，修改如下：

[html] view plain copy

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <beans xmlns="http://www.springframework.org/schema/beans"  
3.     xmlns:context="http://www.springframework.org/schema/context"  
4.     xmlns:jdbc="http://www.springframework.org/schema/jdbc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
5.     xmlns:p="http://www.springframework.org/schema/p" xmlns:aop="http://www.springframework.org/schema/aop"  
6.     xmlns:tx="http://www.springframework.org/schema/tx"  
7.     xsi:schemaLocation="  
8.     http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">  
9.     <bean id="testInitializingBean" class="com.TestInitializingBean" init-method="testInit"></bean>  
10. </beans>  

在配置文件中加入init-method="testInit"。
运行Main程序，打印如下结果：
ceshi InitializingBean
ceshi init-method
由结果可看出，在spring初始化bean的时候，如果该bean是实现了InitializingBean接口，并且同时在配置文件中指定了init-method，系统则是先调用afterPropertiesSet方法，然后在调用init-method中指定的方法。

这方式在spring中是怎么实现的？
通过查看spring的加载bean的源码类(AbstractAutowireCapableBeanFactory)可看出其中奥妙
AbstractAutowireCapableBeanFactory类中的invokeInitMethods讲解的非常清楚，源码如下：

[java] view plain copy

1. protected void invokeInitMethods(String beanName, final Object bean, RootBeanDefinition mbd)  
2.             throws Throwable {  
3. //判断该bean是否实现了实现了InitializingBean接口，如果实现了InitializingBean接口，则只掉调用bean的afterPropertiesSet方法  
4.         boolean isInitializingBean = (bean instanceof InitializingBean);  
5.         if (isInitializingBean && (mbd == null || !mbd.isExternallyManagedInitMethod("afterPropertiesSet"))) {  
6.             if (logger.isDebugEnabled()) {  
7.                 logger.debug("Invoking afterPropertiesSet() on bean with name '" + beanName + "'");  
8.             }  
9.               
10.             if (System.getSecurityManager() != null) {  
11.                 try {  
12.                     AccessController.doPrivileged(new PrivilegedExceptionAction<Object>() {  
13.                         public Object run() throws Exception {  
14.                             //直接调用afterPropertiesSet  
15.                             ((InitializingBean) bean).afterPropertiesSet();  
16.                             return null;  
17.                         }  
18.                     },getAccessControlContext());  
19.                 } catch (PrivilegedActionException pae) {  
20.                     throw pae.getException();  
21.                 }  
22.             }                  
23.             else {  
24.                 //直接调用afterPropertiesSet  
25.                 ((InitializingBean) bean).afterPropertiesSet();  
26.             }  
27.         }  
28.         if (mbd != null) {  
29.             String initMethodName = mbd.getInitMethodName();  
30.             //判断是否指定了init-method方法，如果指定了init-method方法，则再调用制定的init-method  
31.             if (initMethodName != null && !(isInitializingBean && "afterPropertiesSet".equals(initMethodName)) &&  
32.                     !mbd.isExternallyManagedInitMethod(initMethodName)) {  
33.                     //进一步查看该方法的源码，可以发现init-method方法中指定的方法是通过反射实现  
34.                 invokeCustomInitMethod(beanName, bean, mbd);  
35.             }  
36.         }  
37.     }  

总结：
1：spring为bean提供了两种初始化bean的方式，实现InitializingBean接口，实现afterPropertiesSet方法，或者在配置文件中同过init-method指定，两种方式可以同时使用
2：实现InitializingBean接口是直接调用afterPropertiesSet方法，比通过反射调用init-method指定的方法效率相对来说要高点。但是init-method方式消除了对spring的依赖
3：如果调用afterPropertiesSet方法时出错，则不调用init-method指定的方法。
4：TransactionTemplate实现InitializingBean接口，主要是判断transactionManager是否已经初始化，如果没有则抛出异常。源码如下：

[java] view plain copy

1.  public void afterPropertiesSet() {  
2.     if (this.transactionManager == null) {  
3.         throw new IllegalArgumentException("Property 'transactionManager' is required");  
4.     }  
5. }  

 

• github_31020161

  2017-11-05 11:313楼
• 源码解释的很清晰
• 回复

• join_Han

  2017-09-20 14:362楼
• 用源码解释，很清晰，谢谢
• 回复

• SunnyWMG

  2015-06-25 23:431楼
• 此文太精彩了，必须点赞！