Spring原始碼學習之:你不知道的spring注入方式

Love Lenka發表於2016-11-04

前言

    在Spring配置檔案中使用XML檔案進行配置,實際上是讓Spring執行了相應的程式碼,例如:

  • 使用<bean>元素,實際上是讓Spring執行無參或有參構造器

  • 使用<property>元素,實際上是讓Spring執行一次setter方法

    但Java程式還可能有其他型別的語句:呼叫getter方法、呼叫普通方法、訪問類或物件的Field等,而Spring也為這種語句提供了對應的配置語法:

  • 呼叫getter方法:使用PropertyPathFactoryBean

  • 呼叫類或物件的Filed值:使用FiledRetrievingFactoryBean

  • 呼叫普通方法:使用MethodInvokingFactoryBean

注入其他Bean的屬性值

    PropertyPathFactoryBean用來獲得目標Bean的屬性值(實際上就是呼叫getter方法返回的值),獲得的值可以注入給其他的Bean,也可以直接定義新的Bean。看如下的配置檔案:

<bean id="person" class="com.abc.Person">
    <property name="age" value="30" />
    <property name="son">
        <!-- 使用巢狀Bean定義屬性值 -->
        <bean class="com.abc.service.Son">
            <property name="age" value="11" />
        </bean>
    </property>
</bean>

<bean id="son2" class="com.abc.service.Son">
    <!-- age屬性不是直接注入,而是將person中的son的age屬性賦值給son2的age屬性 -->
    <property name="age">
        <!-- 注意這裡使用的是PropertyPathFactoryBean -->
        <bean id="person.son.age" 
            class="org.springframework.beans.factory.config.PropertyPathFactoryBean" />
    </property>
</bean>

    其中Person類和Son類的屬性可以從配置檔案中看出,這不再給出。主程式如下:

public class Test {
    public static void main(String args[]) {
        ApplicationContext ac = 
            new ClassPathXmlApplicationContext("applicationContext.xml");
        System.out.println("age=" + ac.getBean("son2", Son.class).getAge());
    }
}

    輸出結果:

age=11

    Bean例項的屬性值,不僅可以注入另一個Bean,還可將Bean例項的屬性值直接定義成Bean例項,這也是透過PropertyPathFactoryBean完成的。對上面的配置檔案增加這樣一段:

<bean id="son1" 
    class="org.springframework.beans.factory.config.PropertyPathFactoryBean">
    <!-- 確定目標Bean,表明son1來自哪個Bean的元件 -->
    <property name="targetBeanName" value="person" />
    <!-- 確定屬性,表明son1來自目標Bean的哪個屬性 -->
    <property name="propertyPath" value="son" />
</bean>

    執行上面的Test類,把son2換成son1,結果一樣。

 

注入其他Bean的Field值

    透過FieldRetrievingFactoryBean類,可以將其他Bean的Field值注入給其他Bean,或者直接定義新的Bean。下面是配置片段:

<bean id="son" class="com.abc.service.Son">
    <property name="age">
        <bean id="java.sql.Connection.TRANSACTION_SERIALIZABLE"
            class="org.springframework.beans.factory.config.FieldRetrievingFactoryBean" />
    </property>
</bean>

    測試主程式與上文定義的類似,這裡不再提供,執行結果如下:

age=8

    在這個配置中,son物件的age的值,等於java.sql.Connection.TRANSACTION_SERIALIZABLE的值。在上面的 定義中,定義FieldRetrievingFactoryBean工廠Bean時,指定的id並不是該Bean例項的唯一標識,而是指定Field的表 達式(即將要被取出來的值)。

    注意:Field既可以是靜態的,也可以是非靜態的。上面的配置片段指定的Field表示式是靜態Field值,因此可以透過類名直接訪問。如果Field值是非靜態的,則應該透過容器中已經存在的Bean來訪問——即Field表示式的第一個短語應該是容器中已經存在的Bean。

    Field值也可以定義成Bean例項,例如,在配置檔案中增加下面一段:

<bean id="age" 
    class="org.springframework.beans.factory.config.FieldRetrievingFactoryBean">
    <!-- targetClass指定Field所在的目標類 -->
    <property name="targetClass" value="java.sql.Connection" />
    <!-- targetField指定Field名 -->
    <property name="targetField" value="TRANSACTION_SERIALIZABLE" />
</bean>

    在主程式中增加如下輸出:

System.out.println("age=" + ac.getBean("age"));

    執行結果和上文一樣。

    使用FieldRetrievingFactoryBean獲取Field值時,必須指定如下兩個屬性:

  • targetClass或targetObject:分別用於指定Field值所在的目標類或目標物件。如果需要獲得的Field是靜態的,則使用targetClass指定目標類;如果Field是非靜態的,則使用targetObject指定目標物件

  • targetField:指定目標類或目標物件的Field名

    如果Field是個靜態Field,則有一種更加簡潔的寫法:

<bean id="age" 
    class="org.springframework.beans.factory.config.FieldRetrievingFactoryBean">
    <!-- value指定哪個類的哪個靜態域值 -->
    <property name="staticField" value="java.sql.Connection.TRANSACTION_SERIALIZABLE" />
</bean>

 

注入其他Bean的方法返回值

    透過MethodInvokingFactoryBean工廠Bean,可將目標方法的返回值注入為Bean的屬性值。這個工廠Bean用 來獲取指定方法的返回值,該方法既可以是靜態方法,也可以是例項方法;這個值既可以被注入到指定Bean例項的指定屬性,也可以直接定義成Bean例項。 看例子:

<bean id="valueGenerator" class="com.abc.util.ValueGenerator" />
<bean id="son1" class="com.abc.service.Son">
    <property name="age">
        <!-- 獲取方法返回值:呼叫valueGenerator的getValue方法 -->
        <bean 
            class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
            <property name="targetObject" ref="valueGenerator" />
            <property name="targetMethod" value="getValue" />
        </bean>
    </property>
</bean>

    下面是ValueGenerator:

public class ValueGenerator {
    public int getValue() { return 2; }
    public static int getStaticValue () { return 3;}
}

    測試程式依舊列印son1中age的值,程式碼略,結果如下:

age=2

    如果要呼叫靜態方法,則把配置修改為:

<bean id="son1" class="com.abc.service.Son">
    <property name="age">
        <!-- 獲取方法返回值:呼叫valueGenerator的getStaticValue方法 -->
        <bean 
            class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
            <property name="targetClass" value="com.abc.util.ValueGenerator" />
            <property name="targetMethod" value="getStaticValue" />
        </bean>
    </property>
</bean>

    測試結果為:

age=3

    由於Java是支援過載的,只給定方法名,還不足以能夠確定呼叫哪個方法,透過上面的配置能呼叫成功是因為ValueGenerator中的兩個方法都沒有引數。如果方法中有引數,該如何配置呢?在配置檔案中加入以下內容:

<bean id="sysProps" 
    class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
    <property name="targetClass" value="java.lang.System" />
    <property name="targetMethod" value="getProperties" />
<bean>
<bean id="javaVersion" class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
    <!-- 指向上面的sysProps Bean -->
    <property name="targetObject" value="sysProps" />
    <property name="targetMethod" value="getProperty" />
    <!-- 這裡配置引數 -->
    <property name="arguments">
        <!-- 使用list元素列出呼叫方法的多個引數 -->
        <list>
            <value>java.version</value>
        </list>
    </property>
<bean>

    上例中相當於用"java.version"作為引數呼叫了java.lang.System的getProperty方法,返回值將建立一個名為javaVersion的Bean。即相當於:

javaVersion = java.lang.System.getProperty("java.version");

    和前文中的Field一樣,如果要呼叫的方法為靜態方法,也有一種更加簡潔的方法:

<bean id="myBean"
    class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
    <!-- 使用staticMethod屬性,直接指定目標類的目標方法 -->
    <property name="staticMethod" value="com.abc.util.ValueGenerator.getStaticValue" />
</bean>

相關文章