Spring 中 Bean 的設定細節

2023-07-10 09:01:50

前言

大家好,我是 god23bin,今天繼續說 Spring 的內容,關於 Spring 中 Bean 的設定的,通過上一篇文章的學習,我們知道了 Spring 中的依賴注入,其中有兩種主要的方式,分別是基於構造方法的 DI基於 Setter 的 DI

我們知道,當寫完一個普通的 Java 類後,想讓 Spring IoC 容器在建立類的範例物件時使用構造方法完成範例物件的依賴注入,那麼就需要在設定後設資料中寫好類的 Bean 定義,包括各種標籤的屬性。

如果你是第一次看我這個系列的文章,可能不知道什麼是設定後設資料,不知道什麼是依賴注入,那麼請你先去看看我之前的文章,相信對你是有幫助的~

現在我們來說說這其中的設定細節,廢話不多說,開始啦!

Bean 定義中的基本標籤

property

property 標籤:用於注入簡單屬性值,可以通過 name 屬性指定屬性名稱,通過 value 屬性指定屬性值,或者通過 ref 屬性指定參照其他 Bean。

<bean id="employee" class="cn.god23bin.demo.domain.entity.Employee">
    <property name="id" value="1" />
    <property name="name" value="god23bin" />
    <property name="department" ref="department" />
</bean>

<bean id="department" class="cn.god23bin.demo.domain.entity.Department">
    <property name="id" value="1" />
    <property name="name" value="JUST DO IT" />
</bean>

constructor

constructor 標籤:使用構造方法引數值進行注入。通過 value 屬性指定了引數的具體值,或通過 ref 屬性指定了對其他 Bean 的參照。這樣,在容器建立 Bean 範例時,會使用指定的引數值呼叫構造方法,實現構造方法注入。

<bean id="employee" class="cn.god23bin.demo.domain.entity.Employee">
    <constructor-arg value="1" />
    <constructor-arg value="god23bin" />
    <constructor-arg ref="department" />
</bean>

<bean id="department" class="cn.god23bin.demo.domain.entity.Department">
    <constructor-arg value="1" />
    <constructor-arg value="JUST DO IT" />
</bean>

list

list 標籤:用於注入 List 集合型別的屬性值,可以通過value 子標籤指定元素的值,或者通過 ref 子標籤指定參照其他 Bean。

<bean id="employee" class="cn.god23bin.demo.domain.entity.Employee">
    <property name="skills">
        <list>
            <value>Java</value>
            <value>Spring</value>
            <value>MySQL</value>
        </list>
    </property>
    <property name="departments">
        <list>
        	<ref bean="department" />
        </list>
    </property>
</bean>
    
<bean id="department" class="cn.god23bin.demo.domain.entity.Department">
    <constructor-arg value="1" />
    <constructor-arg value="JUST DO IT" />
</bean>

set

set 標籤:用於注入 Set 集合型別的屬性值,用法和 list 標籤類似。

<bean id="employee" class="cn.god23bin.demo.domain.entity.Employee">
  <property name="setProperty">
    <set>
      <value>Value 1</value>
      <ref bean="bean1"/>
      <ref bean="bean2"/>
    </set>
  </property>
</bean>

map

map 標籤:用於注入 Map 集合型別的屬性值,可以通過 entry 子標籤指定鍵值對,鍵可以通過 key 屬性指定,值可以通過 value 屬性指定,或者通過 ref 子標籤指定參照其他Bean。

<bean id="employee" class="cn.god23bin.demo.domain.entity.Employee">
  <property name="mapProperty">
    <map>
      <entry key="key1" value="Value 1"/>
      <entry key="key2">
        <ref bean="bean1"/>
      </entry>
    </map>
  </property>
</bean>

props 標籤:用於注入 Properties 型別的屬性值,可以通過 prop 子標籤指定鍵值對,鍵可以通過 key 屬性指定,值可以通過 value 屬性指定。

<bean id="employee" class="cn.god23bin.demo.domain.entity.Employee">
  <property name="propsProperty">
    <props>
      <prop key="key1">Value 1</prop>
      <prop key="key2">Value 2</prop>
    </props>
  </property>
</bean>

以上是 Spring XML 組態檔中 Bean 注入的常用標籤和集合注入的標籤。

depend-on 的使用

正常情況下,舉個例子:

public class A {
    private B b;
    
    // 省略 getter 和 setter
}

B 這個 Bean 被寫成是 A 的屬性,也就是說,A 類依賴 B 類,這種正常的依賴關係下,我們在以 XML 為設定後設資料的組態檔中,可以使用 ref 屬性來指定 A 的依賴項是 B。

<bean id="a" class="cn.god23bin.demo.domain.model.A">
    <property name="b" ref="b" />
</bean>

<bean id="b" class="cn.god23bin.demo.domain.model.B"/>

這種依賴關係,是很明顯的,一下子就能看出 A 是依賴 B 的,所以我們可以使用 ref 屬性來指定依賴項,與此同時,這個依賴項會被注入到需要它的 Bean 中,這裡就是 B 的物件被注入到 A 中作為 b 屬性。

那麼對於依賴關係不明顯,但是又有依賴關係的時候,就可以使用 depend-on 屬性。

比如有一個類 C,它是間接依賴 D 類的,也就是說 D 沒有作為 C 的屬性。此時,想要範例化 C,那麼需要 D 先範例化好後,才能去範例化 C。

<bean /> 標籤中的 depend-on 屬性就能夠做到這一點,讓這種依賴關係不明顯的,也能保證你在使用某個 Bean 時,該 Bean 的依賴項會先範例化。

<!-- 使用 depend-on 屬性指定 C 這個 Bean 是依賴於 D 的 -->
<bean id="c" class="cn.god23bin.demo.domain.model.C" depend-on="d" />

<bean id="d" class="cn.god23bin.demo.domain.model.D" />

這樣,在使用 C 時,是能夠保證 C 的依賴項 D 是已經範例化好的。

如果有多個依賴項,那麼可以使用有效的分隔符進行分割(英文逗號、英文分號或者空格):

<!-- 使用 depend-on 屬性指定 C 這個 Bean 是依賴於 D 的 -->
<bean id="c" class="cn.god23bin.demo.domain.model.C" depend-on="d,another" />

<bean id="d" class="cn.god23bin.demo.domain.model.D" />
<bean id="another" class="cn.god23bin.demo.model.Another" />

同理,銷燬物件的時候,在銷燬 C 物件之前,D 就會被先銷燬。

lazy-init 的使用

<bean /> 標籤中的 lazy-init 屬性是用來指定某個 Bean 是否開啟懶載入的。

預設情況下,Bean 定義中這個屬性預設值是 false,也就是說預設的 Bean 都不是懶載入的,當 Spring IoC 容器建立後,容器就會立即去建立並完全設定所有的單例作用域的 Bean。

如果我們想讓某個 Bean 不在一開始就被範例化,那麼就可以使用這個懶載入屬性開啟某個 Bean 的懶載入。懶載入的 Bean,只有在被第一次使用時,才會被範例化。

在以 XML 為設定後設資料為例,直接使用 lazy-init 屬性,設定該屬性為 true 就 OK。

<bean id="lazyBean" class="cn.god23bin.demo.domain.model.LazyBean" lazy-init="true" />

當然,如果這個懶載入的 Bean 被其他沒有懶載入的單例 Bean 給參照了,那麼這個懶載入的 Bean 也會在容器建立後被容器所建立,因為容器必須確保單例 Bean 的依賴項都被範例化了。

自動注入依賴項

Spring 支援 Bean 之間依賴關係的自動注入。 它能根據 ApplicationContext 的內容幫我們處理 Bean 之間的依賴關係,這樣我們就可以不用手動在設定後設資料中指定 Bean 之間的依賴關係。

網上有很多部落格把「自動注入」說成「自動裝配」的,在我看來,這是兩回事,實際上從它們的英文名來看,就是兩回事。

說到自動裝配(Auto Configuration),一般都是聯絡到 Spring Boot 的,因為它的特點就是開箱即用,省去大量的設定,而之所以能省去大量的設定,就得益於它的自動裝配。而自動注入(Autowiring Collaborator)是指自動注入共同作業者,換句話說,指 Bean 之間的依賴項 Spring 能幫你去注入。

自動注入的優點

  • 可以大大減少我們在設定後設資料中進行指定屬性或構造方法的引數

  • 可以隨著物件的發展而更新設定,比如你需要給某個類新增一個新的依賴項,那麼你不需要去修改設定後設資料,自動注入就幫我們處理

以 XML 作為設定後設資料的情況下,我們可以使用 <bean /> 標籤中的 autowire 屬性來指定自動注入的模式。

3 種自動注入的模式

預設沒有自動注入,這就是最開始學習的寫法,Bean 的依賴項需要用 ref 屬性來指定。

  1. byName:容器會預設根據屬性名找到一個同名的 Bean 進行自動注入。
<bean id="employee" class="cn.god23bin.demo.domain.entity.Employee" autowire="byName">
    <!-- 屬性 -->
</bean>
  1. byType:容器會預設根據屬性的型別找到一個同型別的 Bean 進行自動注入,如果存在多個同型別的 Bean,那麼 Spring IoC 容器就不知道注入哪一個 Bean,就會丟擲異常。
<bean id="employee" class="cn.god23bin.demo.domain.entity.Employee" autowire="byType">
    <!-- 屬性 -->
</bean>
  1. constructor:類似 byType,不過它是基於構造方法引數的自動注入。
<bean id="employee" class="cn.god23bin.demo.domain.entity.Employee" autowire="constructor">
    <!-- 建構函式引數 -->
</bean>

需要注意的是,自動注入只對那些具有依賴關係的 Bean 起作用,而不是所有的 Bean。因此,在設定 Bean 的時候,需要確保被注入的屬性在其他 Bean 中是存在的。

自動注入的限制和缺點

  • 在設定後設資料中,使用 <property /><constructor-args /> 編寫的明確的依賴關係會覆蓋自動注入的,換句話說,它的優先順序比自動注入的方式高。還有就是自動注入是不能注入簡單的型別的,比如基本資料型別、String、Class 等型別(包括這些型別的陣列也是不能自動注入的)。這裡的限制是設計上的限制。
  • 自動注入是單靠 Spring 幫我們注入的,精確度不如我們手動去明確設定 Bean 之間的依賴關係的,某些情況下可能由於我們的疏忽會注入錯誤的 Bean 導致意想不到的結果。
  • 自動注入的資訊對於一些用來生成檔案的工具可能是沒用的。
  • 自動注入的時候找到了多個匹配上的 Bean,對於陣列和集合來說是正常的,沒什麼問題,但是如果要注入的 Bean 是單值屬性的依賴關係,那麼 Spring IoC 就不知道該注入哪一個 Bean,就會丟擲異常。這個就在上面的 byType 中說過的。

對於自動注入匹配到了多個 Bean,有以下解決方案:

  • 不用自動注入,改為明確手動注入
  • 使用 <bean /> 中的 primary 屬性,設定為 true,那麼在多個同型別的 Bean 定義當中,如果匹配上了,那麼這個 Bean 就是主要的候選者,就會注入這個 Bean。
  • 使用基於註解的自動注入(@Autowired@Primary 等)

這幾個使用註解實現自動注入的,在後面的文章中再講。

總結

我們總結一下,關於 Spring 中 Bean 的設定與依賴注入的重要內容。

  • Bean 的設定後設資料可通過 XML 檔案進行定義和設定,當然後續我們會介紹使用註解Java 設定作為設定後設資料的方式。
  • 基本標籤包括 propertyconstructor-arglistsetmapprops,用於注入屬性值或集合型別的屬性。
  • depend-on 屬性用於指定 Bean 之間的依賴關係,確保指定的 Bean 先於當前 Bean 範例化,這種依賴不是顯式的依賴。
  • lazy-init 屬性用於指定 Bean 是否懶載入,預設為 false,即容器啟動時立即範例化所有單例 Bean。
  • 自動注入可減少設定後設資料中的顯式指定依賴項,提供 autowire 屬性以設定自動注入的模式。
  • 自動注入模式包括 byNamebyTypeconstructor,通過屬性名或型別進行自動匹配完成依賴注入。
  • 自動注入存在一定的限制和缺點,需注意設定的精確性和衝突解決。
  • 對於多個匹配的自動注入,可通過手動注入、primary 屬性或基於註解的自動注入來解決。

以上就是本篇所有的內容了,對螢幕前的你有幫助的話,麻煩點點關注,點個免費的贊,給予我支援與鼓勵,感興趣的話可以關注我這個專欄,謝謝你們!

最後的最後

希望各位螢幕前的靚仔靚女們給個三連!你輕輕地點了個贊,那將在我的心裡世界增添一顆明亮而耀眼的星!

咱們下期再見!