Bean 作用域

创建 Bean 定义时，你是在为该 Bean 定义所定义的类创建实际实例的配方。Bean 定义是配方的想法很重要，因为这意味着，与类一样，你可以从一个配方中创建许多对象实例。

您不仅可以控制要插入从特定 bean 定义创建的对象中的各种依赖关系和配置值，还可以控制从特定 bean 定义创建的对象的范围。这种方法功能强大且灵活，因为您可以通过配置选择要创建的对象的范围，而不必在 Java 类级别中设置对象的范围。可以定义 bean 以在多个范围之一中部署。Spring Framework 支持六个范围，其中四个仅在使用支持 Web 的 ApplicationContext 时可用。您还可以创建自定义范围。

下表描述了受支持的范围

表 1. Bean 范围
范围 描述

singleton

（默认）将单个 bean 定义作用域限定为每个 Spring IoC 容器的单个对象实例。

prototype

将单个 bean 定义作用域限定为任意数量的对象实例。

request

将单个 bean 定义的作用域限定为单个 HTTP 请求的生命周期。也就是说，每个 HTTP 请求都有一个自己的 bean 实例，该实例根据单个 bean 定义创建。仅在支持 Web 的 Spring ApplicationContext 的上下文中有效。

session

将单个 bean 定义的作用域限定为 HTTP Session 的生命周期。仅在支持 Web 的 Spring ApplicationContext 的上下文中有效。

application

将单个 bean 定义的作用域限定为 ServletContext 的生命周期。仅在支持 Web 的 Spring ApplicationContext 的上下文中有效。

websocket

将单个 bean 定义的作用域限定为 WebSocket 的生命周期。仅在支持 Web 的 Spring ApplicationContext 的上下文中有效。
线程范围可用，但默认情况下未注册。有关更多信息，请参阅 SimpleThreadScope 的文档。有关如何注册此自定义范围或任何其他自定义范围的说明，请参阅 使用自定义范围。

单例范围

仅管理一个单例 bean 的共享实例，并且对具有与该 bean 定义匹配的 ID 或 ID 的 bean 的所有请求都会导致 Spring 容器返回该一个特定 bean 实例。

换句话说，当你定义一个 bean 定义并且它的作用域为单例时，Spring IoC 容器会创建由该 bean 定义定义的对象的一个实例。这个单一实例存储在这样的单例 bean 的缓存中，并且对该命名 bean 的所有后续请求和引用都会返回缓存对象。下图显示了单例作用域的工作方式

singleton

Spring 的单例 bean 的概念不同于四人帮 (GoF) 模式书中定义的单例模式。GoF 单例硬编码对象的范围，以便每个 ClassLoader 仅创建一个特定类的实例。Spring 单例的作用域最好描述为按容器和按 bean。这意味着，如果你为单个 Spring 容器中的特定类定义一个 bean，Spring 容器会创建由该 bean 定义定义的类的唯一实例。单例作用域是 Spring 中的默认作用域。要在 XML 中将 bean 定义为单例，你可以按照以下示例中所示定义 bean

<bean id="accountService" class="com.something.DefaultAccountService"/>

<!-- the following is equivalent, though redundant (singleton scope is the default) -->
<bean id="accountService" class="com.something.DefaultAccountService" scope="singleton"/>

原型作用域

bean 部署的非单例原型作用域会导致在每次对特定 bean 发出请求时创建一个新的 bean 实例。也就是说，bean 注入到另一个 bean 中，或者你通过容器上的 getBean() 方法调用请求它。通常，你应该对所有有状态 bean 使用原型作用域，对无状态 bean 使用单例作用域。

下图说明了 Spring 原型作用域

prototype

（数据访问对象 (DAO) 通常不会配置为原型，因为典型的 DAO 不会保存任何会话状态。对于我们来说，重用单例图的核心更容易。）

以下示例在 XML 中将 bean 定义为原型

<bean id="accountService" class="com.something.DefaultAccountService" scope="prototype"/>

与其他作用域相反，Spring 不会管理原型 bean 的完整生命周期。容器实例化、配置并以其他方式组装原型对象，并将其交给客户端，而不会进一步记录该原型实例。因此，虽然初始化生命周期回调方法在所有对象上调用，无论作用域如何，但在原型的情况下，不会调用配置的销毁生命周期回调。客户端代码必须清理原型作用域对象并释放原型 bean 持有的昂贵资源。要让 Spring 容器释放原型作用域 bean 持有的资源，请尝试使用自定义 bean 后置处理器，它持有需要清理的 bean 的引用。

在某些方面，Spring 容器在原型作用域 Bean 中的作用是 Java new 运算符的替代。该点之后的所有生命周期管理都必须由客户端处理。（有关 Spring 容器中 Bean 生命周期的详细信息，请参阅 生命周期回调。）

具有原型 Bean 依赖项的单例 Bean

当您将单例作用域 Bean 与原型 Bean 的依赖项结合使用时，请注意在实例化时解析依赖项。因此，如果您将原型作用域 Bean 依赖注入到单例作用域 Bean 中，则会实例化一个新的原型 Bean，然后将其依赖注入到单例 Bean 中。原型实例是唯一提供给单例作用域 Bean 的实例。

但是，假设您希望单例作用域 Bean 在运行时重复获取原型作用域 Bean 的新实例。您无法将原型作用域 Bean 依赖注入到单例 Bean 中，因为该注入仅发生一次，即当 Spring 容器实例化单例 Bean 并解析和注入其依赖项时。如果您需要在运行时多次获取原型 Bean 的新实例，请参阅 方法注入。

请求、会话、应用程序和 WebSocket 作用域

request、session、application 和 websocket 作用域仅在您使用支持 Web 的 Spring ApplicationContext 实现（例如 XmlWebApplicationContext）时可用。如果您将这些作用域与常规 Spring IoC 容器（例如 ClassPathXmlApplicationContext）一起使用，则会抛出抱怨未知 Bean 作用域的 IllegalStateException。

初始 Web 配置

要在 request、session、application 和 websocket 级别（Web 作用域 Bean）对 Bean 进行作用域设置，在定义 Bean 之前需要进行一些较小的初始配置。（对于标准作用域：singleton 和 prototype，不需要此初始设置。）

如何完成此初始设置取决于您的特定 Servlet 环境。

如果您在 Spring Web MVC 中访问作用域 Bean，实际上是在由 Spring DispatcherServlet 处理的请求中，则无需进行特殊设置。DispatcherServlet 已经公开了所有相关状态。

如果你使用 Servlet Web 容器，并且在 Spring 的 DispatcherServlet 外部处理请求（例如，使用 JSF 时），你需要注册 org.springframework.web.context.request.RequestContextListener ServletRequestListener。这可以通过使用 WebApplicationInitializer 接口以编程方式完成。或者，将以下声明添加到 Web 应用程序的 web.xml 文件中

<web-app>
	...
	<listener>
		<listener-class>
			org.springframework.web.context.request.RequestContextListener
		</listener-class>
	</listener>
	...
</web-app>

或者，如果你的侦听器设置有问题，请考虑使用 Spring 的 RequestContextFilter。过滤器映射取决于周围的 Web 应用程序配置，因此你必须根据需要对其进行更改。以下列表显示了 Web 应用程序的过滤器部分

<web-app>
	...
	<filter>
		<filter-name>requestContextFilter</filter-name>
		<filter-class>org.springframework.web.filter.RequestContextFilter</filter-class>
	</filter>
	<filter-mapping>
		<filter-name>requestContextFilter</filter-name>
		<url-pattern>/*</url-pattern>
	</filter-mapping>
	...
</web-app>

DispatcherServlet、RequestContextListener 和 RequestContextFilter 都执行完全相同的事情，即把 HTTP 请求对象绑定到为该请求提供服务的 Thread。这使得请求作用域和会话作用域的 Bean 在调用链中进一步可用。

请求作用域

考虑以下 Bean 定义的 XML 配置

<bean id="loginAction" class="com.something.LoginAction" scope="request"/>

Spring 容器为每个 HTTP 请求使用 loginAction Bean 定义创建 LoginAction Bean 的新实例。也就是说，loginAction Bean 的作用域在 HTTP 请求级别。你可以根据需要更改所创建实例的内部状态，因为从同一 loginAction Bean 定义创建的其他实例不会看到这些状态更改。它们特定于单个请求。当请求处理完成时，作用域为该请求的 Bean 将被丢弃。

在使用注解驱动的组件或 Java 配置时，可以使用 @RequestScope 注解将组件分配给 request 作用域。以下示例演示了如何执行此操作

  • Java

  • Kotlin

@RequestScope
@Component
public class LoginAction {
	// ...
}
@RequestScope
@Component
class LoginAction {
	// ...
}

会话作用域

考虑以下 Bean 定义的 XML 配置

<bean id="userPreferences" class="com.something.UserPreferences" scope="session"/>

Spring 容器为单个 HTTP Session 的生命周期使用 userPreferences Bean 定义创建 UserPreferences Bean 的新实例。换句话说，userPreferences Bean 的作用域实际上在 HTTP Session 级别。与请求作用域 Bean 一样，你可以根据需要更改所创建实例的内部状态，因为知道其他也使用从同一 userPreferences Bean 定义创建的实例的 HTTP Session 实例不会看到这些状态更改，因为它们特定于单个 HTTP Session。当 HTTP Session 最终被丢弃时，作用域为该特定 HTTP Session 的 Bean 也将被丢弃。

在使用注解驱动的组件或 Java 配置时，可以使用 @SessionScope 注解将组件分配给 session 作用域。

  • Java

  • Kotlin

@SessionScope
@Component
public class UserPreferences {
	// ...
}
@SessionScope
@Component
class UserPreferences {
	// ...
}

应用程序作用域

考虑以下 Bean 定义的 XML 配置

<bean id="appPreferences" class="com.something.AppPreferences" scope="application"/>

Spring 容器通过一次使用 appPreferences bean 定义为整个 Web 应用程序创建一个新的 AppPreferences bean 实例。也就是说，appPreferences bean 的作用域在 ServletContext 级别，并存储为常规 ServletContext 属性。这与 Spring 单例 bean 有些类似，但在两个重要方面有所不同：它是一个 ServletContext 单例，而不是 Spring ApplicationContext 单例（在任何给定的 Web 应用程序中可能有多个），并且它实际上是公开的，因此可见为 ServletContext 属性。

在使用注解驱动的组件或 Java 配置时，可以使用 @ApplicationScope 注解将组件分配给 application 作用域。以下示例演示如何执行此操作

  • Java

  • Kotlin

@ApplicationScope
@Component
public class AppPreferences {
	// ...
}
@ApplicationScope
@Component
class AppPreferences {
	// ...
}

WebSocket 作用域

WebSocket 作用域与 WebSocket 会话的生命周期相关联，并适用于 WebSocket 上的 STOMP，有关更多详细信息，请参阅 WebSocket 作用域。

作用域 Bean 作为依赖项

Spring IoC 容器不仅管理对象的实例化（bean），还管理合作者（或依赖项）的连接。如果您想将（例如）HTTP 请求作用域 bean 注入到另一个作用域较长的 bean 中，您可以选择注入 AOP 代理来代替作用域 bean。也就是说，您需要注入一个代理对象，该对象公开与作用域对象相同的公共接口，但也可以从相关作用域（例如 HTTP 请求）中检索真实的目标对象，并将方法调用委托给真实对象。

您还可以在作用域为 singleton 的 bean 之间使用 <<aop:scoped-proxy/>，然后引用通过可序列化的中间代理进行，因此能够在反序列化时重新获取目标单例 bean。

当针对作用域为 prototype 的 bean 声明 <<aop:scoped-proxy/> 时，对共享代理的每次方法调用都会导致创建一个新的目标实例，然后将调用转发给该实例。

此外，作用域代理并不是以生命周期安全的方式访问较短作用域中的 bean 的唯一方法。您还可以将注入点（即构造函数或 setter 参数或自动装配字段）声明为 ObjectFactory<MyTargetBean>，允许每次需要时调用 getObject() 来按需检索当前实例——而无需持有该实例或单独存储它。

作为扩展变体，你可以声明 ObjectProvider<MyTargetBean>，它提供几种其他访问变体，包括 getIfAvailable 和 getIfUnique。

此 JSR-330 变体称为 Provider，与 Provider<MyTargetBean> 声明和每次检索尝试的相应 get() 调用一起使用。有关 JSR-330 整体的更多详细信息，请参阅此处。

以下示例中的配置只有一行，但了解其背后的“原因”和“方式”非常重要

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:aop="http://www.springframework.org/schema/aop"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
		https://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/aop
		https://www.springframework.org/schema/aop/spring-aop.xsd">

	<!-- an HTTP Session-scoped bean exposed as a proxy -->
	<bean id="userPreferences" class="com.something.UserPreferences" scope="session">
		<!-- instructs the container to proxy the surrounding bean -->
		<aop:scoped-proxy/> (1)
	</bean>

	<!-- a singleton-scoped bean injected with a proxy to the above bean -->
	<bean id="userService" class="com.something.SimpleUserService">
		<!-- a reference to the proxied userPreferences bean -->
		<property name="userPreferences" ref="userPreferences"/>
	</bean>
</beans>
1 定义代理的行。

要创建此类代理，你需要将子 <aop:scoped-proxy/> 元素插入作用域 bean 定义中（请参阅选择要创建的代理类型和基于 XML 架构的配置）。

为什么在常见场景中作用域为 request、session 和自定义作用域级别的 bean 的定义需要 <aop:scoped-proxy/> 元素？考虑以下单例 bean 定义，并将其与你需要为上述作用域定义的内容进行对比（请注意，以下 userPreferences bean 定义是不完整的）

<bean id="userPreferences" class="com.something.UserPreferences" scope="session"/>

<bean id="userManager" class="com.something.UserManager">
	<property name="userPreferences" ref="userPreferences"/>
</bean>

在前面的示例中，单例 bean（userManager）注入对 HTTP Session 作用域 bean（userPreferences）的引用。这里的重要一点是 userManager bean 是单例：它在每个容器中实例化一次，并且它的依赖项（在本例中只有一个，即 userPreferences bean）也只注入一次。这意味着 userManager bean 仅对完全相同的 userPreferences 对象（即最初注入它的对象）进行操作。

当你将作用域较短的 bean 注入到作用域较长的 bean 中时，这不是你想要的行为（例如，将 HTTP Session 作用域协作 bean 作为依赖项注入到单例 bean 中）。相反，你需要一个 userManager 对象，并且在 HTTP Session 的生命周期内，你需要一个特定于 HTTP Session 的 userPreferences 对象。因此，容器创建了一个对象，该对象公开与 UserPreferences 类完全相同的公共接口（理想情况下，该对象是 UserPreferences 实例），它可以从作用域机制（HTTP 请求、Session 等）中获取真正的 UserPreferences 对象。容器将此代理对象注入到 userManager bean 中，后者不知道此 UserPreferences 引用是一个代理。在此示例中，当 UserManager 实例调用依赖项注入的 UserPreferences 对象上的方法时，它实际上是在调用代理上的方法。然后，代理从（在本例中）HTTP Session 中获取真正的 UserPreferences 对象，并将方法调用委托给检索到的真正的 UserPreferences 对象。

因此，当将 request- 和 session-scoped bean 注入到协作对象中时，需要以下（正确且完整的）配置，如下例所示

<bean id="userPreferences" class="com.something.UserPreferences" scope="session">
	<aop:scoped-proxy/>
</bean>

<bean id="userManager" class="com.something.UserManager">
	<property name="userPreferences" ref="userPreferences"/>
</bean>

选择要创建的代理类型

默认情况下，当 Spring 容器为标记有 <aop:scoped-proxy/> 元素的 bean 创建代理时，将创建一个基于 CGLIB 的类代理。

CGLIB 代理不拦截私有方法。尝试调用此类代理上的私有方法不会委托给实际的范围目标对象。

或者，可以通过为 <aop:scoped-proxy/> 元素的 proxy-target-class 属性的值指定 false，将 Spring 容器配置为为此类范围 bean 创建基于标准 JDK 接口的代理。使用基于 JDK 接口的代理意味着不需要在应用程序类路径中添加其他库来影响此类代理。但是，这也意味着范围 bean 的类必须至少实现一个接口，并且所有注入范围 bean 的协作者都必须通过其一个接口引用 bean。以下示例显示基于接口的代理

<!-- DefaultUserPreferences implements the UserPreferences interface -->
<bean id="userPreferences" class="com.stuff.DefaultUserPreferences" scope="session">
	<aop:scoped-proxy proxy-target-class="false"/>
</bean>

<bean id="userManager" class="com.stuff.UserManager">
	<property name="userPreferences" ref="userPreferences"/>
</bean>

有关选择基于类或基于接口的代理的更多详细信息，请参阅 代理机制。

直接注入请求/会话引用

作为工厂范围的替代方案，Spring WebApplicationContext 还支持将 HttpServletRequest、HttpServletResponse、HttpSession、WebRequest（如果存在 JSF）以及 FacesContext 和 ExternalContext 注入到 Spring 管理的 bean 中，只需通过基于类型的自动装配，与其他 bean 的常规注入点并列。Spring 通常会为这些请求和会话对象注入代理，这具有在单例 bean 和可序列化 bean 中工作的优点，类似于工厂范围 bean 的范围代理。

自定义范围

bean 范围机制是可扩展的。你可以定义自己的范围，甚至重新定义现有范围，尽管后者被认为是不良做法，并且不能覆盖内置的 singleton 和 prototype 范围。

创建自定义范围

要将自定义范围集成到 Spring 容器中，需要实现 org.springframework.beans.factory.config.Scope 接口，该接口在此部分中进行描述。有关如何实现自己的范围的想法，请参阅 Spring Framework 本身提供的 Scope 实现和 Scope javadoc，它更详细地解释了需要实现的方法。

Scope 接口有四个方法从作用域中获取对象、从作用域中移除对象并让它们被销毁。

例如，会话作用域实现返回会话作用域 bean（如果不存在，则该方法返回 bean 的新实例，在将其绑定到会话以供将来引用后）。以下方法从基础作用域返回对象

  • Java

  • Kotlin

Object get(String name, ObjectFactory<?> objectFactory)
fun get(name: String, objectFactory: ObjectFactory<*>): Any

例如，会话作用域实现从基础会话中移除会话作用域 bean。应返回对象，但如果找不到具有指定名称的对象，则可以返回 null。以下方法从基础作用域移除对象

  • Java

  • Kotlin

Object remove(String name)
fun remove(name: String): Any

以下方法注册一个回调，当作用域被销毁或作用域中的指定对象被销毁时，作用域应调用该回调

  • Java

  • Kotlin

void registerDestructionCallback(String name, Runnable destructionCallback)
fun registerDestructionCallback(name: String, destructionCallback: Runnable)

有关销毁回调的更多信息，请参阅 javadoc 或 Spring 作用域实现。

以下方法获取基础作用域的会话标识符

  • Java

  • Kotlin

String getConversationId()
fun getConversationId(): String

此标识符对于每个作用域都是不同的。对于会话作用域实现，此标识符可以是会话标识符。

使用自定义作用域

编写并测试一个或多个自定义 Scope 实现后，你需要让 Spring 容器了解你的新作用域。以下方法是向 Spring 容器注册新 Scope 的核心方法

  • Java

  • Kotlin

void registerScope(String scopeName, Scope scope);
fun registerScope(scopeName: String, scope: Scope)

此方法在 ConfigurableBeanFactory 接口上声明，该接口可通过 Spring 附带的大多数具体 ApplicationContext 实现上的 BeanFactory 属性获得。

registerScope(..) 方法的第一个参数是与作用域关联的唯一名称。Spring 容器本身中此类名称的示例是 singleton 和 prototype。registerScope(..) 方法的第二个参数是你希望注册和使用的自定义 Scope 实现的实际实例。

假设你编写了自己的自定义 Scope 实现，然后按下一个示例中所示进行注册。

下一个示例使用 SimpleThreadScope，它包含在 Spring 中，但默认情况下未注册。对于您自己的自定义 Scope 实现，说明将相同。

  • Java

  • Kotlin

Scope threadScope = new SimpleThreadScope();
beanFactory.registerScope("thread", threadScope);
val threadScope = SimpleThreadScope()
beanFactory.registerScope("thread", threadScope)

然后，您可以创建遵守自定义 Scope 的作用域规则的 bean 定义，如下所示

<bean id="..." class="..." scope="thread">

使用自定义 Scope 实现，您不必局限于对作用域进行编程注册。您还可以使用 CustomScopeConfigurer 类进行 Scope 声明式注册，如下例所示

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:aop="http://www.springframework.org/schema/aop"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
		https://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/aop
		https://www.springframework.org/schema/aop/spring-aop.xsd">

	<bean class="org.springframework.beans.factory.config.CustomScopeConfigurer">
		<property name="scopes">
			<map>
				<entry key="thread">
					<bean class="org.springframework.context.support.SimpleThreadScope"/>
				</entry>
			</map>
		</property>
	</bean>

	<bean id="thing2" class="x.y.Thing2" scope="thread">
		<property name="name" value="Rick"/>
		<aop:scoped-proxy/>
	</bean>

	<bean id="thing1" class="x.y.Thing1">
		<property name="thing2" ref="thing2"/>
	</bean>

</beans>
当您将 <aop:scoped-proxy/> 放置在 FactoryBean 实现的 <bean> 声明中时，作用域化的是工厂 bean 本身，而不是从 getObject() 返回的对象。