spring的InitializingBean介紹

InitializingBean

    Spirng的InitializingBean爲bean提供了定義初始化方法的方式。InitializingBean是一個接口，它僅僅包含一個方法：afterPropertiesSet()。

Bean實現這個接口，在afterPropertiesSet()中編寫初始化代碼：

package research.spring.beanfactory.ch4;
import org.springframework.beans.factory.InitializingBean;publicclass LifeCycleBean implements InitializingBean{publicvoid afterPropertiesSet() throws Exception {
System.out.println("LifeCycleBean initializing...");
}
}

 

在xml配置文件中並不須要對bean進行特殊的配置：

xml version="1.0" encoding="UTF-8"?>DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN"
"http://www.springframework.org/dtd/spring-beans.dtd"><beans><bean name="lifeBean" class="research.spring.beanfactory.ch4.LifeCycleBean">bean>beans>

編寫測試程序進行測試：

package research.spring.beanfactory.ch4; import org.springframework.beans.factory.xml.XmlBeanFactory; import org.springframework.core.io.ClassPathResource;publicclass LifeCycleTest {publicstaticvoid main(String[] args) { XmlBeanFactory factory=new XmlBeanFactory(new ClassPathResource(
"research/spring/beanfactory/ch4/context.xml")); factory.getBean("lifeBean"); } }

運行上面的程序咱們會看到：「LifeCycleBean initializing...」，這說明bean的afterPropertiesSet已經被Spring調用了。

 

    Spring在設置完一個bean全部的合做者後，會檢查bean是否實現了InitializingBean接口，若是實現就調用bean的afterPropertiesSet方法。

 SHAPE  /* MERGEFORMAT

init-method

    Spring雖然能夠經過InitializingBean完成一個bean初始化後對這個bean的回調，可是這種方式要求bean實現 InitializingBean接口。一但bean實現了InitializingBean接口，那麼這個bean的代碼就和Spring耦合到一塊兒了。一般狀況下我不鼓勵bean直接實現InitializingBean，可使用Spring提供的init-method的功能來執行一個bean 子定義的初始化方法。

寫一個java class，這個類不實現任何Spring的接口。定義一個沒有參數的方法init()。

package research.spring.beanfactory.ch4;publicclass LifeCycleBean{publicvoid init(){
System.out.println("LifeCycleBean.init...");
}
}

 

在Spring中配置這個bean：

xml version="1.0" encoding="UTF-8"?>DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd"><beans><bean name="lifeBean" class="research.spring.beanfactory.ch4.LifeCycleBean"
 init-method="init">bean>beans>

當Spring實例化lifeBean時，你會在控制檯上看到」 LifeCycleBean.init...」。

 

 

Spring要求init-method是一個無參數的方法，若是init-method指定的方法中有參數，那麼Spring將會拋出java.lang.NoSuchMethodException

 

init-method指定的方法能夠是public、protected以及private的，而且方法也能夠是final的。

 

init-method指定的方法能夠是聲明爲拋出異常的，就像這樣：

       final protected void init() throws Exception{

           System.out.println("init method...");

           if(true) throw new Exception("init exception");

    }

若是在init-method方法中拋出了異常，那麼Spring將停止這個Bean的後續處理，而且拋出一個org.springframework.beans.factory.BeanCreationException異常。

 

InitializingBean和init-method能夠一塊兒使用，Spring會先處理InitializingBean再處理init-method。

org.springframework.beans.factory.support. AbstractAutowireCapableBeanFactory完成一個Bean初始化方法的調用工做。 AbstractAutowireCapableBeanFactory是XmlBeanFactory的超類，再 AbstractAutowireCapableBeanFactory的invokeInitMethods方法中實現調用一個Bean初始化方法：

org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.java:

//……//在一個bean的合做者設備完成後，執行一個bean的初始化方法。protectedvoid invokeInitMethods(String beanName, Object bean, RootBeanDefinition mergedBeanDefinition)
 throws Throwable {//判斷bean是否實現了InitializingBean接口if (bean instanceof InitializingBean) {if (logger.isDebugEnabled()) { logger.debug("Invoking afterPropertiesSet() on bean with name '"+ beanName +"'"); }//調用afterPropertiesSet方法((InitializingBean) bean).afterPropertiesSet(); }//判斷bean是否認義了init-methodif(mergedBeanDefinition!=null&&mergedBeanDefinition.getInitMethodName() !=null) {//調用invokeCustomInitMethod方法來執行init-method定義的方法invokeCustomInitMethod(beanName, bean, mergedBeanDefinition.getInitMethodName()); } }//執行一個bean定義的init-method方法protectedvoid invokeCustomInitMethod(String beanName, Object bean, String initMethodName) throws Throwable {if (logger.isDebugEnabled()) { logger.debug("Invoking custom init method '"+ initMethodName +"' on bean with name '"+ beanName +"'"); }//使用方法名，反射Method對象Method initMethod = BeanUtils.findMethod(bean.getClass(), initMethodName, null);if (initMethod ==null) {thrownew NoSuchMethodException(
"Couldn't find an init method named '"+ initMethodName +"' on bean with name '"+ beanName +"'"); }//判斷方法是不是publicif (!Modifier.isPublic(initMethod.getModifiers())) {//設置accessible爲true，能夠訪問private方法。                     initMethod.setAccessible(true); }try {//反射執行這個方法initMethod.invoke(bean, (Object[]) null); }catch (InvocationTargetException ex) {throw ex.getTargetException(); } }//………..

    經過分析上面的源代碼咱們能夠看到，init-method是經過反射執行的，而afterPropertiesSet是直接執行的。因此 afterPropertiesSet的執行效率比init-method要高，不過init-method消除了bean對Spring依賴。在實際使用時我推薦使用init-method。

    須要注意的是Spring老是先處理bean定義的InitializingBean，而後才處理init-method。若是在Spirng處理InitializingBean時出錯，那麼Spring將直接拋出異常，不會再繼續處理init-method。

    若是一個bean被定義爲非單例的，那麼afterPropertiesSet和init-method在bean的每個實例被建立時都會執行。單例 bean的afterPropertiesSet和init-method只在bean第一次被實例時調用一次。大多數狀況下 afterPropertiesSet和init-method都應用在單例的bean上。