Spring InitializingBean和init-method


原文轉自:http://blog.csdn.net/shaozheng1006/article/details/6916940

InitializingBean

    Spirng的InitializingBean為bean提供了定義初始化方法的方式。InitializingBean是一個接口,它僅僅包含一個方法:afterPropertiesSet()。
   在spring 初始化后,執行完所有屬性設置方法(即setXxx)將自動調用 afterPropertiesSet(), 在配置文件中無須特別的配置, 但此方式增加了bean對spring 的依賴,應該盡量避免使用
 
Spirng的InitializingBean為bean提供了定義初始化方法的方式。InitializingBean是一個接口,它僅僅包含一個方法:afterPropertiesSet()。

 

public interface InitializingBean
{

    public abstract void afterPropertiesSet()
        throws Exception;
}

Bean實現這個接口,在afterPropertiesSet()中編寫初始化代碼:
package research.spring.beanfactory.ch4;import org.springframework.beans.factory.InitializingBean;public class LifeCycleBean implements InitializingBean{public 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">bean>beans>

 

 
編寫測試程序進行測試:
package research.spring.beanfactory.ch4;import org.springframework.beans.factory.xml.XmlBeanFactory;import org.springframework.core.io.ClassPathResource;public class LifeCycleTest {public static void 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

 

裝配bean的合作者

查看bean是否實現InitializingBean接口

調用afterPropertiesSet方法

 

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;public class LifeCycleBean{public void 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的初始化方法。
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方法p
rotected 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總是先處理bean定義的InitializingBean,然后才處理init-method。如果在Spirng處理InitializingBean時出錯,那么Spring將直接拋出異常,不會再繼續處理init-method。

    如果一個bean被定義為非單例的,那么afterPropertiesSet和init-method在bean的每一個實例被創建時都會執行。單例 bean的afterPropertiesSet和init-method只在bean第一次被實例時調用一次。大多數情況下 afterPropertiesSet和init-method都應用在單例的bean上。


<二>
init-method 
    在bean中寫一個無參無返回值的public 方法 實現bean的初始化。例如
   public void init(){
       // …… 初始化代碼
    }
在spring 初始化后,執行完所有屬性設置方法(即setXxx)將自動調用 配置文件init-method指定的方法,配置文件如下所示
    <bean name="beanName" class="package.bean"
 init-method="init">
    </bean>

 

 

 

<三>

initializingBean接口是spring提供的,子類要實現afterPropertiesSet()方法,init-method是用戶可以通過屬性文件配置的。從這里可以看出實現initializingBean接口是要和spring耦合的,而init-method則不會。但afterPropertiesSet()方法spring可以直接調用執行,init-method指定的方法卻需要通過反射來執行,從效率來上講沒有afgerPropertiesSet()快。InitializingBean和init-method可以一起使用,Spring會先處理InitializingBean再處理init-method。
下面是一個小例子,initializingBean接口和init-method都實現了,可以自己隨便改。
試驗用的bean:
package researchspring.beanfactory;

import org.springframework.beans.factory.InitializingBean;

public class LifeCycleBean implements InitializingBean{
    
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void afterPropertiesSet() throws Exception {
        System.out.println("Implements initializing start.....");
        if(name == null)
            System.out.println("configuration failed!");
        System.out.println("Implements initializing end!");
    }
    
    public void init() {
        System.out.println("init() initializing start.....");
        if(name == null)
            System.out.println("configuration failed!");
        System.out.println("init() initializing end!");
    }
}
applicationContext.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans
    xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd">
    
    <bean id="lifeBean" class="researchspring.beanfactory.LifeCycleBean"
        init-method="init" >
    <property name="name" value="apple"></property>
    </bean>
</beans>
測試類:
public class Test {
    public static void main(String[] args) {
        ApplicationContext ac = new ClassPathXmlApplicationContext("applicationContext.xml");
        LifeCycleBean lifeBean = (LifeCycleBean)ac.getBean("lifeBean");
    }

}

×××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××××
另外,從網上找了這么一段
org.springframework.beans.factory.support. AbstractAutowireCapableBeanFactory完成一個Bean初始化方法的調用工作。 AbstractAutowireCapableBeanFactory是XmlBeanFactory的超類,再 AbstractAutowireCapableBeanFactory的invokeInitMethods方法中實現調用一個Bean初始化方法:
org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.java:
//……
//在一個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();
}
}
//………..

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM