Spring： InitializingBean的作用

LingLee_荊棘鳥發表於2017-08-03
SpringBean

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

專案中管理事務比較簡單，用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. }  

相關文章