InitializingBean
Spirng的InitializingBean為bean提供了定義初始化方法的方式。InitializingBean是一個(gè)接口,它僅僅包含一個(gè)方法:afterPropertiesSet()。
Bean實(shí)現這個(gè)接口,在afterPropertiesSet()中編寫(xiě)初始化代碼:
package research.spring.beanfactory.ch4; import org.springframework.beans.factory.InitializingBean; class LifeCycleBean implements InitializingBean{ void afterPropertiesSet() throws Exception { System. out.println("LifeCycleBean initializing..."); } }
在xml配置文件中并不需要對bean進(jìn)行特殊的配置:
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">
>
< /beans >
編寫(xiě)測試程序進(jìn)行測試:
package research.spring.beanfactory.ch4; import org.springframework.beans.factory.xml.XmlBeanFactory; import org.springframework.core.io.ClassPathResource; public class LifeCycleTest { staticvoid main(String[] args) { XmlBeanFactory factory= new XmlBeanFactory( newClassPathResource("research/spring/beanfactory/ch4/context.xml")); factory.getBean("lifeBean"); } }
運行上面的程序我們會(huì )看到:“LifeCycleBean initializing...”,這說(shuō)明bean的afterPropertiesSet已經(jīng)被Spring調用了。
Spring在設置完一個(gè)bean所有的合作者后,會(huì )檢查bean是否實(shí)現了InitializingBean接口,如果實(shí)現就調用bean的afterPropertiesSet方法。
SHAPE /* MERGEFORMAT
裝配 bean的合作者 |
查看 bean是否實(shí)現 InitializingBean 接口 |
調用 afterPropertiesSet 方法 |
Spring雖然可以通過(guò)InitializingBean完成一個(gè)bean初始化后對這個(gè)bean的回調,但是這種方式要求bean實(shí)現 InitializingBean接口。一但bean實(shí)現了InitializingBean接口,那么這個(gè)bean的代碼就和Spring耦合到一起了。通常情況下我不鼓勵bean直接實(shí)現InitializingBean,可以使用Spring提供的init-method的功能來(lái)執行一個(gè)bean 子定義的初始化方法。
寫(xiě)一個(gè)java class,這個(gè)類(lèi)不實(shí)現任何Spring的接口。定義一個(gè)沒(méi)有參數的方法init()。
package research.spring.beanfactory.ch4;
publicclass LifeCycleBean{
publicvoid init(){
System. out .println("LifeCycleBean.init...");
}}
在Spring中配置這個(gè)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實(shí)例化lifeBean時(shí),你會(huì )在控制臺上看到” LifeCycleBean.init...”。
Spring要求init-method是一個(gè)無(wú)參數的方法,如果init-method指定的方法中有參數,那么Spring將會(huì )拋出 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將中止這個(gè)Bean的后續處理,并且拋出一個(gè) org.springframework.beans.factory.BeanCreationException異常。
InitializingBean和init-method可以一起使用,Spring會(huì )先處理InitializingBean再處理init-method。
org.springframework.beans.factory.support. AbstractAutowireCapableBeanFactory完成一個(gè)Bean初始化方法的調用工作。 AbstractAutowireCapableBeanFactory是XmlBeanFactory的超類(lèi),再 AbstractAutowireCapableBeanFactory的invokeInitMethods方法中實(shí)現調用一個(gè)Bean初始化方法:
org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.java:
// ……
//在一個(gè)bean的合作者設備完成后,執行一個(gè)bean的初始化方法。 protected voidinvokeInitMethods(String beanName, Object bean, RootBeanDefinition mergedBeanDefinition)
throws Throwable {
// 判斷bean是否實(shí)現了InitializingBean接口 if (bean instanceof InitializingBean) {
if (logger.isDebugEnabled()) {
logger.debug("Invoking afterPropertiesSet() on bean with name '"+ beanName +"'");
}
// 調用afterPropertiesSet方法
((InitializingBean) bean).afterPropertiesSet();
}
// 判斷bean是否定義了init-method if (mergedBeanDefinition!= null&&mergedBeanDefinition.getInitMethodName() != null ) {
//調用invokeCustomInitMethod方法來(lái)執行init-method定義的方法
invokeCustomInitMethod(beanName, bean, mergedBeanDefinition.getInitMethodName());
} }
// 執行一個(gè)bean定義的init-method方法 protected voidinvokeCustomInitMethod(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 +"'");
}
// 判斷方法是否是public if (!Modifier.isPublic(initMethod.getModifiers())) {
//設置accessible為true,可以訪(fǎng)問(wèn)private方法。 initMethod.setAccessible( true );
}
try {
//反射執行這個(gè)方法
initMethod.invoke(bean, (Object[]) null );
}
catch (InvocationTargetException ex) {
throw ex.getTargetException();
} }
// ………..
通過(guò)分析上面的源代碼我們可以看到,init-method是通過(guò)反射執行的,而afterPropertiesSet是直接執行的。所以 afterPropertiesSet的執行效率比init-method要高,不過(guò)init-method消除了bean對Spring依賴(lài)。在實(shí)際使用時(shí)我推薦使用init-method。
需要注意的是Spring總是先處理bean定義的InitializingBean,然后才處理init-method。如果在Spirng處理InitializingBean時(shí)出錯,那么Spring將直接拋出異常,不會(huì )再繼續處理init-method。
如果一個(gè)bean被定義為非單例的,那么afterPropertiesSet和init-method在bean的每一個(gè)實(shí)例被創(chuàng )建時(shí)都會(huì )執行。單例 bean的afterPropertiesSet和init-method只在bean第一次被實(shí)例時(shí)調用一次。大多數情況下 afterPropertiesSet和init-method都應用在單例的bean上。
聯(lián)系客服