spring的init-method的問題
阿新 • • 發佈:2019-02-17
Spring在設定完一個bean所有的屬性後,會檢查bean是否實現了InitializingBean介面,如果實現就呼叫bean的afterPropertiesSet方法。另外,如果bean是單例的,則afterPropertiesSet方法只會被呼叫一次;否則每次建立bean時afterPropertiesSet方法都會被重新呼叫.
Spring雖然可以通過InitializingBean完成一個bean初始化後對這個bean的回撥,但是這種方式要求bean實現 InitializingBean介面。一但bean實現了InitializingBean介面,那麼這個bean的程式碼就和Spring耦合到一起了。通常情況下不建議直接實現InitializingBean,而是用Spring提供的init-method的功能來執行一個bean 子定義的初始化方法,這可以在一個bean的配置檔案中通過init-method宣告:
<bean id="testBean" class="TestClass" init-method="initialize"/>
spring要求這個init-method方法是一個無引數的方法。
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異常。
如果一個bean同時實現了這兩種方式的初始化配置,則spring會先呼叫afterPropertiesSet方法,然後通過反射呼叫init-method,任何一個方法出錯都會導致spring建立bean失敗.如果afterPropertiesSet方法呼叫失敗,也不會再繼續執行init-mehtod方法。
org.springframework.beans.factory.support. AbstractAutowireCapableBeanFactory完成一個Bean初始化方法的呼叫工作。 AbstractAutowireCapableBeanFactory是XmlBeanFactory的超類,再 AbstractAutowireCapableBeanFactory的invokeInitMethods方法中實現呼叫一個Bean初始化方法:
org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.java:
view plainprint?
//……
//在一個bean的合作者裝置完成後,執行一個bean的初始化方法。
protected void 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-method
if(mergedBeanDefinition!=null&&mergedBeanDefinition.getInitMethodName() != null) {
//呼叫invokeCustomInitMethod方法來執行init-method定義的方法
invokeCustomInitMethod(beanName, bean, mergedBeanDefinition.getInitMethodName());
}
}
//執行一個bean定義的init-method方法
protected void 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) {
throw new NoSuchMethodException(
"Couldn't find an init method named '" + initMethodName + "' on bean with name '" + beanName + "'");
}
//判斷方法是否是public
if (!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雖然可以通過InitializingBean完成一個bean初始化後對這個bean的回撥,但是這種方式要求bean實現 InitializingBean介面。一但bean實現了InitializingBean介面,那麼這個bean的程式碼就和Spring耦合到一起了。通常情況下不建議直接實現InitializingBean,而是用Spring提供的init-method的功能來執行一個bean 子定義的初始化方法,這可以在一個bean的配置檔案中通過init-method宣告:
<bean id="testBean" class="TestClass" init-method="initialize"/>
spring要求這個init-method方法是一個無引數的方法。
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異常。
如果一個bean同時實現了這兩種方式的初始化配置,則spring會先呼叫afterPropertiesSet方法,然後通過反射呼叫init-method,任何一個方法出錯都會導致spring建立bean失敗.如果afterPropertiesSet方法呼叫失敗,也不會再繼續執行init-mehtod方法。
org.springframework.beans.factory.support. AbstractAutowireCapableBeanFactory完成一個Bean初始化方法的呼叫工作。 AbstractAutowireCapableBeanFactory是XmlBeanFactory的超類,再 AbstractAutowireCapableBeanFactory的invokeInitMethods方法中實現呼叫一個Bean初始化方法:
org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.java:
view plainprint?
//……
//在一個bean的合作者裝置完成後,執行一個bean的初始化方法。
protected void 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-method
if(mergedBeanDefinition!=null&&mergedBeanDefinition.getInitMethodName() != null) {
//呼叫invokeCustomInitMethod方法來執行init-method定義的方法
invokeCustomInitMethod(beanName, bean, mergedBeanDefinition.getInitMethodName());
}
}
//執行一個bean定義的init-method方法
protected void 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) {
throw new NoSuchMethodException(
"Couldn't find an init method named '" + initMethodName + "' on bean with name '" + beanName + "'");
}
//判斷方法是否是public
if (!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。