InitializingBean
Spirng的InitializingBean為bean提供了定義初始化方法的方式。InitializingBean是一個接口,它僅僅包含一個方法:afterPropertiesSet()。
Bean實現(xiàn)這個接口,在afterPropertiesSet()中編寫初始化代碼:
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進行特殊的配置:
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 >
編寫測試程序進行測試:
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"); } }
運行上面的程序我們會看到:“LifeCycleBean initializing...”,這說明bean的afterPropertiesSet已經(jīng)被Spring調(diào)用了。
Spring在設(shè)置完一個bean所有的合作者后,會檢查bean是否實現(xiàn)了InitializingBean接口,如果實現(xiàn)就調(diào)用bean的afterPropertiesSet方法。
SHAPE /* MERGEFORMAT
裝配 bean的合作者 |
查看 bean是否實現(xiàn) InitializingBean 接口 |
調(diào)用 afterPropertiesSet 方法 |
Spring雖然可以通過InitializingBean完成一個bean初始化后對這個bean的回調(diào),但是這種方式要求bean實現(xiàn) InitializingBean接口。一但bean實現(xiàn)了InitializingBean接口,那么這個bean的代碼就和Spring耦合到一起了。通常情況下我不鼓勵bean直接實現(xiàn)InitializingBean,可以使用Spring提供的init-method的功能來執(zhí)行一個bean 子定義的初始化方法。
寫一個java class,這個類不實現(xiàn)任何Spring的接口。定義一個沒有參數(shù)的方法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是一個無參數(shù)的方法,如果init-method指定的方法中有參數(shù),那么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的后續(xù)處理,并且拋出一個 org.springframework.beans.factory.BeanCreationException異常。
InitializingBean和init-method可以一起使用,Spring會先處理InitializingBean再處理init-method。
org.springframework.beans.factory.support. AbstractAutowireCapableBeanFactory完成一個Bean初始化方法的調(diào)用工作。 AbstractAutowireCapableBeanFactory是XmlBeanFactory的超類,再 AbstractAutowireCapableBeanFactory的invokeInitMethods方法中實現(xiàn)調(diào)用一個Bean初始化方法:
org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.java:
// ……
//在一個bean的合作者設(shè)備完成后,執(zhí)行一個bean的初始化方法。 protected voidinvokeInitMethods(String beanName, Object bean, RootBeanDefinition mergedBeanDefinition)
throws Throwable {
// 判斷bean是否實現(xiàn)了InitializingBean接口 if (bean instanceof InitializingBean) {
if (logger.isDebugEnabled()) {
logger.debug("Invoking afterPropertiesSet() on bean with name '"+ beanName +"'");
}
// 調(diào)用afterPropertiesSet方法
((InitializingBean) bean).afterPropertiesSet();
}
// 判斷bean是否定義了init-method if (mergedBeanDefinition!= null&&mergedBeanDefinition.getInitMethodName() != null ) {
//調(diào)用invokeCustomInitMethod方法來執(zhí)行init-method定義的方法
invokeCustomInitMethod(beanName, bean, mergedBeanDefinition.getInitMethodName());
} }
// 執(zhí)行一個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())) {
//設(shè)置accessible為true,可以訪問private方法。 initMethod.setAccessible( true );
}
try {
//反射執(zhí)行這個方法
initMethod.invoke(bean, (Object[]) null );
}
catch (InvocationTargetException ex) {
throw ex.getTargetException();
} }
// ………..
通過分析上面的源代碼我們可以看到,init-method是通過反射執(zhí)行的,而afterPropertiesSet是直接執(zhí)行的。所以 afterPropertiesSet的執(zhí)行效率比init-method要高,不過init-method消除了bean對Spring依賴。在實際使用時我推薦使用init-method。
需要注意的是Spring總是先處理bean定義的InitializingBean,然后才處理init-method。如果在Spirng處理InitializingBean時出錯,那么Spring將直接拋出異常,不會再繼續(xù)處理init-method。
如果一個bean被定義為非單例的,那么afterPropertiesSet和init-method在bean的每一個實例被創(chuàng)建時都會執(zhí)行。單例 bean的afterPropertiesSet和init-method只在bean第一次被實例時調(diào)用一次。大多數(shù)情況下 afterPropertiesSet和init-method都應(yīng)用在單例的bean上。