技術文章 » Spring Bean 的作用域（Bean Scope）

Spring Bean 的作用域（Bean Scope）

2023-09-12 06:00:31

前言

大家好，我是 god23bin，今天我們來聊一聊 Spring 框架中的 Bean 作用域（Scope）。

什麼是 Bean 的作用域？

我們在以 XML 作為設定後設資料的情況下，進行 Bean 的定義，是這樣的：

<bean id="vehicle" class="cn.god23bin.demo.domain.model.Vehicle">
	<!-- 共同作業者寫在這裡... -->
</bean>

我們寫了一個 Bean 定義（Bean Definition），就是用於建立所定義的類的範例的。

一個 Bean 定義，我們可以類比一個類的定義，你定義了一個類，你可以根據這個類建立出許多範例物件。同理，Bean 定義也是，也是可以根據這個定義建立許多範例物件的，只不過這裡是 Spring 幫我們建立，而不是我們手動 new 。 這些 Bean 物件範例，我們可以理解為 Spring IoC 容器中的物件。

在寫 Bean 定義的過程中，我們可以控制各種 Bean 的依賴項和相應的值，將這些依賴項和值注入到 Bean 定義所建立的物件中。同理，這個過程也可以控制 Bean 定義建立的物件的 Scope（作用域）。Bean 的作用域定義了在容器中建立的 Bean 範例的生命週期以及在應用程式中的可見性。

6 種 Bean 的作用域

Spring 支援 6 種 Bean 的作用域，其中有 4 種是在 Web 應用下才能感知到的，如下表所示：

Scope 說明
singleton （預設情況下）每個 Spring IoC 容器將單個 Bean 定義的 Scope 指定為單個物件範例。
prototype 將單個 Bean 定義的 Scope 擴大到任意數量的物件範例。
request 將單個 Bean 定義的 Scope 擴大到單個 HTTP 請求的生命週期。也就是說，每個 HTTP 請求都有自己的 Bean 範例，該範例是在單個 Bean 定義的基礎上建立的。只在 Web 感知的 Spring ApplicationContext 的上下文中有效。
session 將單個 Bean 定義的 Scope 擴大到一個 HTTP 對談的生命週期。只在 Web 感知的 Spring ApplicationContext 的上下文中有效。
application 將單個 Bean 定義的 Scope 擴大到 ServletContext 的生命週期中。只在 Web 感知的 Spring ApplicationContext 的上下文中有效。
websocket 將單個 Bean 定義的 Scope 擴大到 WebSocket 的生命週期。只在 Web 感知的 Spring ApplicationContext 的上下文中有效。

1. Singleton Scope

singleton 作用域的 Bean，在 Spring IoC 容器中就有且僅有一個該型別的範例物件，也就是單例的。

預設情況下，我們在寫 Bean 定義的時候，不指定作用域的話，那麼這個 Bean 物件就是單例的。

<!-- 不寫 Bean 的作用域，預設作用域為單例 -->
<bean id="accountService" class="cn.god23bin.demo.service.DefaultAccountService"/>

<!-- 寫上作用域，這裡是冗餘的寫法，使用 scope 屬性 -->
<bean id="accountService" class="cn.god23bin.demo.service.DefaultAccountService" scope="singleton"/>

這個單例物件是儲存在一個快取區域中的，在後續的請求或者參照中，Spring 就會返回這個快取的物件。

實際上，Spring 中的單例的 Bean 物件是不同於 Gang of Four 設計模式中的所定義的單例模式的。

設計模式（Design Pattern）是前輩們對程式碼開發經驗的總結，是解決特定問題的一系列套路。它不是語法規定，而是一套用來提高程式碼可複用性、可維護性、可讀性、穩健性以及安全性的解決方案。

1995 年，GoF（Gang of Four，四人組/四人幫）合作出版了《設計模式：可複用物件導向軟體的基礎》一書，共收錄了 23 種設計模式，從此樹立了軟體設計模式領域的里程碑，人稱「GoF設計模式」。

設計模式中的單例模式是寫死的方式，以便每個 ClassLoader 只建立一個特定類的一個範例。

而 Spring 單例的範圍是指每個 IoC 容器的，不同 IoC 容器維護自己的 Bean 的單例物件。

2. Prototype Scope

Bean 的作用域是 prototype，中文意思是原型，實際上這裡是省略了 non-singleton，這個作用域的全稱是 non-singleton prototype scope，即「非單例原型的作用域」。

顧名思義，這個作用域下的 Bean 不是單例的，意思就是說 Bean 是多例的，每一次的請求或者參照，都會建立一個新的 Bean 物件。

當然這裡的請求或者參照的意思是指，非單例原型的 Bean 被注入到另一個 Bean 中的時候（Bean 作為屬性被參照），或者我們直接通過容器的 getBean() 方法呼叫來請求它的時候，就會建立一個新的物件。

在 XML 中指定了這個 Bean 的作用域為 prototype。

<bean id="accountService" class="cn.god23bin.demo.service.DefaultAccountService" scope="prototype"/>

在 prototype 作用域下的 Bean，Spring 是不會負責該 Bean 的銷燬週期中回撥的方法的，如果該 Bean 擁有一些重要的資源，想在該 Bean 物件銷燬時釋放這些資源，那麼需要自定義 BeanPostProcessor（Bean 的後置處理器），它持有我們需要清理的 Bean 的參照。

在某些方面來說，在 prototype 作用域下的 Bean 的作用是代替 new 操作的。

其餘 4 種作用域

request、session、application 和 websocket scope 只有在使用 Web 感知的 Spring ApplicationContext 實現（如 XmlWebApplicationContext）時才可用。

簡而言之，一般是在 Web 應用下，藉助 Spring 的 Web 模組，就能使用這 4 種作用域。

如果你將這些 scope 與常規的 Spring IoC 容器（如 ClassPathXmlApplicationContext）一起使用，就會丟擲一個 IllegalStateException，提示有未知的 Bean scope。

3. Request Scope

<bean id="loginController" class="cn.god23bin.demo.controller.LoginController" scope="request"/>

Spring IoC 容器為每一個 HTTP 請求使用 loginController Bean 定義來建立 LoginController Bean 的新範例，從而實現這種 request 作用域。

你可以隨心所欲地改變被建立的範例的內部狀態，因為從同一個 loginController Bean 定義中建立的其他範例不會看到這些狀態的變化。它們是針對單個請求的，當請求完成處理時，該請求所涉及的 Bean 會被丟棄。

4. Session Scope

<bean id="userPreferences" class="cn.god23bin.demo.UserPreferences" scope="session"/>

Spring IoC 容器通過使用 userPreferences Bean 定義，在單個HTTP Session 的生命週期內建立一個新的 UserPreferences Bean 範例。

與 request scope 的 Bean 一樣，你可以隨心所欲地改變被建立的範例的內部狀態，要知道其他 HTTP Session 範例也在使用從同一個 userPreferences Bean定義中建立的範例，它們不會看到這些狀態的變化，因為它們是特定於單個HTTP Session。當HTTP Session 最終被丟棄時，作用於該特定HTTP Session 的 Bean 也被丟棄。

5. Application Scope

<bean id="appPreferences" class="cn.god23bin.demo.AppPreferences" scope="application"/>

Spring 容器通過為整個Web應用程式使用一次 appPreferences Bean 定義來建立 AppPreferences Bean的新範例。

這有點類似於Spring的 singleton Bean，但在兩個重要方面有所不同。

它是每個 ServletContext 的單例，而不是每個 Spring ApplicationContext（在任何給定的Web應用程式中可能有幾個）。

6. WebSocket Scope

這裡就涉及到 WebSocket 了，目前先不討論。後面再來填坑~

不同作用域的 Bean 之間的依賴關係

這裡討論的，一般就是單例作用域的 Bean 和原型作用域的 Bean 之間的依賴關係。

現在舉個例子，假設有兩個 Java 類交給了 Spring IoC 容器管理，分別是 SingletonBean 類和 PrototypeBean 類。

其中 SingletonBean 是單例作用域的 Bean，而 PrototypeBean 是原型作用域的 Bean。

那麼當：

  1. SingletonBean 的依賴項是 PrototypeBean 時，PrototypeBean 物件只會初始化一次並注入到 SingletonBean，這樣 PrototypeBean 就起不到原型作用域的效果。
  2. PrototypeBean 的依賴項是 SingletonBean 時，每次 PrototypeBean 物件都會建立，這些物件都依賴於一個單例物件，此時沒任何問題。

方法注入

Spring 提供了一種稱為方法注入（Method Injection）的機制來解決原型作用域的 Bean 在被注入到單例作用域的 Bean 中時只建立一個範例的問題。

方法注入允許每次呼叫方法時都獲取一個新的原型作用域的 Bean 範例。

方法注入是通過在 SingletonBean 中定義一個返回 PrototypeBean 範例的方法來實現的。這樣，在每次需要使用 PrototypeBean 的地方，可以通過呼叫該方法獲取一個新的範例。

以下是使用方法注入解決 Prototype Bean 作用域的範例：

public abstract class SingletonBean {
    public abstract PrototypeBean getPrototypeBean();

    public void doSomething() {
        PrototypeBean prototypeBean = getPrototypeBean();
        // 使用 Prototype Bean 進行操作
    }
}

public class PrototypeBean {
    // Prototype Bean 的定義
}

在上述範例中，SingletonBean 是一個抽象類，其中宣告了一個抽象方法 getPrototypeBean()，該方法返回一個 PrototypeBean 範例。在 doSomething() 方法中，通過呼叫 getPrototypeBean() 方法獲取一個新的 PrototypeBean 範例，以便在每次呼叫 doSomething() 時使用不同的範例。

然後，可以通過具體的子類來實現 SingletonBean，並實現 getPrototypeBean() 方法以返回相應的 PrototypeBean 範例。

通過方法注入，每次呼叫 doSomething() 方法時都會獲取一個新的 PrototypeBean 範例，從而解決了在 Singleton Bean 中注入 Prototype Bean 時只建立一個範例的問題。

需要注意的是，方法注入需要在組態檔或使用註解時進行特殊的設定，具體的設定方式基本如下。

1. XML 設定方式

當然，上面舉例是一個抽象類，不是抽象類也是可以的，比如：

public class SingletonBean {
    // 方法注入，Spring 會幫我們返回這個物件，這裡寫成 null 即可
    public PrototypeBean getPrototypeBean() {
        return null;
    }

    public void doSomething() {
        PrototypeBean prototypeBean = getPrototypeBean();
        // 使用 Prototype Bean 進行操作
    }
}

public class PrototypeBean {
    // Prototype Bean 的定義
}

接著，單獨上面是沒有實現不了方法注入的，還需要結合設定後設資料，現在在 XML 組態檔中使用 <lookup-method /> 標籤來實現方法注入。

<bean id="singletonBean" class="cn.god23bin.demo.domain.model.SingletonBean">
    <lookup-method name="getPrototypeBean" bean="prototypeBean"/>
</bean>

<bean id="prototypeBean" class="cn.god23bin.demo.domain.model.PrototypeBean" scope="prototype"/>

上面的設定範例中，singletonBean 是一個單例 Bean，通過 <lookup-method /> 標籤指定了一個名為 getPrototypeBean 的方法，並參照了一個原型 Bean prototypeBean。

在執行時，每次呼叫 getPrototypeBean 方法時，都會返回一個新的 prototypeBean 範例。

2. 註解設定方式

使用 @Lookup 註解來實現方法注入。

@Component
public class SingletonBean {

    private PrototypeBean prototypeBean;

    @Lookup
    public PrototypeBean getPrototypeBean() {
        return null; // 實際上會由 Spring 生成具體實現
    }

    // 其他程式碼...
}

@Component
@Scope("prototype")
public class PrototypeBean {
    // 具體的原型 Bean 實現
}

在上面的範例中，SingletonBean 使用了 @Lookup 註解標記了一個名為 getPrototypeBean 的方法。在執行時，Spring 會為這個方法生成具體的實現，以實現方法注入。

總結

簡單總結下：

Bean 的作用域在 Bean 定義的時候可以進行指定，預設是單例的，多例的 Bean 就是所謂的原型作用域。

一共 6 種作用域需要熟悉，其中 4 種是在具有 Web 感知能力的 Spring IoC （應用上下文）下才有的作用域。

對於單例 Bean 依賴原型 Bean 的問題，可以通過方法注入解決，兩種寫法實現方法注入，一種是 XML，另一種是註解的方式。

最後的最後

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

咱們下期再見！