Bean 概览

Spring IoC 容器管理一个或多个 bean。这些 bean 是使用你提供给容器的配置元数据创建的(例如,以 XML <bean/> 定义的形式)。

在容器内部,这些 bean 定义表示为 BeanDefinition 对象,其中包含(除其他信息外)以下元数据

  • 一个包含包名的类名:通常是正在定义的 bean 的实际实现类。

  • Bean 行为配置元素,说明 bean 在容器中应该如何行为(作用域、生命周期回调等)。

  • 引用 bean 完成工作所需的其他 bean。这些引用也称为协作者或依赖。

  • 在新创建的对象中设置的其他配置设置 — 例如,连接池的大小限制或管理连接池的 bean 中要使用的连接数。

这些元数据转化为构成每个 bean 定义的一组属性。下表描述了这些属性

表 1. Bean 定义
属性 解释见…​

Class

实例化 Bean

Name

Bean 命名

Scope

Bean 作用域

构造函数参数

依赖注入

属性

依赖注入

自动装配模式

自动装配协作者

延迟初始化模式

延迟初始化 Bean

初始化方法

初始化回调

销毁方法

销毁回调

除了包含如何创建特定 bean 的信息的 bean 定义外,ApplicationContext 实现还允许注册在容器外部(由用户)创建的现有对象。这是通过 getAutowireCapableBeanFactory() 方法访问 ApplicationContext 的 BeanFactory 来完成的,该方法返回 DefaultListableBeanFactory 实现。DefaultListableBeanFactory 通过 registerSingleton(..)registerBeanDefinition(..) 方法支持此注册。然而,典型的应用只使用通过常规 bean 定义元数据定义的 bean。

Bean 元数据和手动提供的单例实例需要尽早注册,以便容器在自动装配和其他自省步骤中正确地处理它们。虽然在一定程度上支持覆盖现有元数据和现有单例实例,但在运行时(与对工厂的实时访问同时)注册新 bean 未得到官方支持,可能导致并发访问异常、bean 容器状态不一致或两者兼而有之。

覆盖 Bean

当使用已分配的标识符注册 bean 时,就会发生 Bean 覆盖。虽然 Bean 覆盖是可能的,但这会使配置更难阅读。

Bean 覆盖将在未来的版本中弃用。

要完全禁用 Bean 覆盖,可以在刷新 ApplicationContext 之前将其上的 allowBeanDefinitionOverriding 标志设置为 false。在这种设置下,如果使用了 Bean 覆盖,将抛出异常。

默认情况下,容器会在 INFO 级别记录每次尝试覆盖 bean 的行为,以便你可以相应地调整配置。虽然不推荐,但你可以通过将 allowBeanDefinitionOverriding 标志设置为 true 来禁用这些日志。

Java 配置

如果你使用 Java 配置,相应的 @Bean 方法总是静默地覆盖具有相同组件名称的扫描到的 bean 类,只要 @Bean 方法的返回类型与该 bean 类匹配即可。这仅意味着容器将优先调用 @Bean 工厂方法,而不是 bean 类上的任何预先声明的构造函数。

我们承认在测试场景中覆盖 bean 很方便,并且从 Spring Framework 6.2 开始对此提供了明确的支持。请参阅本节了解更多详细信息。

Bean 命名

每个 bean 都有一个或多个标识符。这些标识符在托管该 bean 的容器中必须是唯一的。一个 bean 通常只有一个标识符。但是,如果需要多个,额外的可以被视为别名。

在基于 XML 的配置元数据中,你可以使用 id 属性、name 属性或两者来指定 bean 标识符。id 属性允许你指定一个且只有一个 id。按照惯例,这些名称是字母数字的(如 'myBean'、'someService' 等),但它们也可以包含特殊字符。如果你想为 bean 引入其他别名,你也可以在 name 属性中指定,用逗号 (,)、分号 (;) 或空格分隔。尽管 id 属性被定义为 xsd:string 类型,但 bean id 的唯一性由容器强制执行,而不是由 XML 解析器强制执行。

你不需要为 bean 提供 nameid。如果你没有显式提供 nameid,容器会为该 bean 生成一个唯一的名称。但是,如果你想通过使用 ref 元素或 Service Locator 风格查找来按名称引用该 bean,则必须提供一个名称。不提供名称的原因与使用内部 bean自动装配协作者有关。

Bean 命名约定

约定是使用标准的 Java 实例字段命名约定来命名 bean。也就是说,bean 名称以小写字母开头,并采用驼峰命名法。此类名称的示例包括 accountManageraccountServiceuserDaologinController 等。

持续一致地命名 bean 使你的配置更易于阅读和理解。此外,如果你使用 Spring AOP,这在将通知应用于一组按名称相关的 bean 时非常有帮助。

通过类路径中的组件扫描,Spring 会按照前面描述的规则为未命名的组件生成 bean 名称:本质上是获取简单的类名并将其首字母转换为小写。然而,在(不常见)特殊情况下,当存在多个字符且第一个和第二个字符都是大写时,会保留原始大小写。这些规则与 java.beans.Introspector.decapitalize 定义的规则相同(Spring 在此处使用了该方法)。

在 Bean 定义外部创建 Bean 别名

在 bean 定义本身中,你可以通过组合使用 id 属性指定最多一个名称以及 name 属性中的任意数量的其他名称来为一个 bean 提供多个名称。这些名称可以是同一 bean 的等效别名,在某些情况下很有用,例如让应用程序中的每个组件使用特定于该组件本身的 bean 名称来引用一个共同的依赖项。

然而,并非总是在定义 bean 的地方指定所有别名就足够了。有时,最好为在别处定义的 bean 引入别名。这在大型系统中很常见,其中配置被分散到每个子系统中,每个子系统都有自己的一组对象定义。在基于 XML 的配置元数据中,你可以使用 <alias/> 元素来完成此操作。以下示例显示了如何执行此操作

<alias name="fromName" alias="toName"/>

在这种情况下,一个名为 fromName 的 bean(在同一容器中)在使用此别名定义后,也可以被称为 toName

例如,子系统 A 的配置元数据可能通过名称 subsystemA-dataSource 引用一个 DataSource。子系统 B 的配置元数据可能通过名称 subsystemB-dataSource 引用一个 DataSource。当组合使用这两个子系统的主应用程序时,主应用程序通过名称 myApp-dataSource 引用 DataSource。为了让这三个名称都指向同一个对象,你可以在配置元数据中添加以下别名定义

<alias name="myApp-dataSource" alias="subsystemA-dataSource"/>
<alias name="myApp-dataSource" alias="subsystemB-dataSource"/>

现在,每个组件和主应用程序都可以通过一个唯一且保证不会与任何其他定义冲突的名称(有效地创建了一个命名空间)来引用 dataSource,但它们引用的是同一个 bean。

Java 配置

如果你使用 Java 配置,可以使用 @Bean 注解来提供别名。请参阅使用 @Bean 注解了解详细信息。

实例化 Bean

Bean 定义本质上是创建或多个对象的“食谱”。当被请求时,容器会查看命名 bean 的食谱,并使用该 bean 定义封装的配置元数据来创建(或获取)实际对象。

如果你使用基于 XML 的配置元数据,可以在 <bean/> 元素的 class 属性中指定要实例化的对象的类型(或类)。这个 class 属性(在内部是 BeanDefinition 实例上的一个 Class 属性)通常是强制性的。(例外情况请参见使用实例工厂方法实例化Bean 定义继承。)你可以通过两种方式使用 Class 属性

  • 通常用于指定 bean 类进行构造的情况,即容器本身通过反射调用其构造函数来直接创建 bean,这有点类似于 Java 代码中的 new 运算符。

  • 在不太常见的情况下,指定包含用于创建对象的 static 工厂方法的实际类,即容器调用类上的 static 工厂方法来创建 bean。从调用 static 工厂方法返回的对象类型可能与该类相同,也可能完全是另一个类。

嵌套类名

如果你想为嵌套类配置 bean 定义,可以使用嵌套类的二进制名称或源代码名称。

例如,如果你在 com.example 包中有一个名为 SomeThing 的类,并且此 SomeThing 类有一个名为 OtherThingstatic 嵌套类,它们可以使用美元符号 ($) 或点 (.) 分隔。因此,bean 定义中 class 属性的值可以是 com.example.SomeThing$OtherThingcom.example.SomeThing.OtherThing

使用构造函数实例化

当你通过构造函数方法创建 bean 时,所有普通类都可以被 Spring 使用并与之兼容。也就是说,正在开发的类不需要实现任何特定的接口或以特定的方式编码。只需指定 bean 类即可。但是,根据你用于该特定 bean 的 IoC 类型,你可能需要一个默认(空)构造函数。

Spring IoC 容器几乎可以管理任何你希望它管理的类。它不限于管理真正的 JavaBeans。大多数 Spring 用户更喜欢只有默认(无参)构造函数以及根据容器中的属性建模的适当 getter 和 setter 的实际 JavaBeans。你也可以在容器中使用更特殊的非 bean 风格的类。例如,如果你需要使用一个完全不符合 JavaBean 规范的遗留连接池,Spring 也可以管理它。

使用基于 XML 的配置元数据,你可以按如下方式指定 bean 类

<bean id="exampleBean" class="examples.ExampleBean"/>

<bean name="anotherExample" class="examples.ExampleBeanTwo"/>

关于为构造函数提供参数(如果需要)以及在对象构造后设置对象实例属性的机制的详细信息,请参阅 注入依赖

在构造函数参数的情况下,容器可以从几个重载的构造函数中选择一个相应的构造函数。话虽如此,为了避免歧义,建议尽量保持构造函数签名简洁明了。

使用静态工厂方法实例化

定义一个使用静态工厂方法创建的 bean 时,使用 class 属性指定包含该 static 工厂方法的类,并使用名为 factory-method 的属性指定工厂方法本身的名称。您应该能够调用此方法(可以带有可选参数,详情见后述)并返回一个活动对象,该对象随后被视为通过构造函数创建的。这种 bean 定义的一种用途是调用遗留代码中的 static 工厂。

以下 bean 定义指定该 bean 将通过调用工厂方法创建。此定义未指定返回对象的类型(类),而是指定包含工厂方法的类。在此示例中,createInstance() 方法必须是一个 static 方法。以下示例展示了如何指定工厂方法

<bean id="clientService"
	class="examples.ClientService"
	factory-method="createInstance"/>

以下示例展示了与前述 bean 定义配合使用的类

  • Java

  • Kotlin

public class ClientService {
	private static ClientService clientService = new ClientService();
	private ClientService() {}

	public static ClientService createInstance() {
		return clientService;
	}
}
class ClientService private constructor() {
	companion object {
		private val clientService = ClientService()
		@JvmStatic
		fun createInstance() = clientService
	}
}

关于为工厂方法提供(可选)参数以及在对象从工厂返回后设置对象实例属性的机制的详细信息,请参阅 依赖和配置详情

在工厂方法参数的情况下,容器可以从几个同名重载方法中选择一个相应的方法。话虽如此,为了避免歧义,建议尽量保持工厂方法签名简洁明了。

工厂方法重载的一个典型问题案例是 Mockito 及其 mock 方法的许多重载。请选择最具体的 mock 变体

<bean id="clientService" class="org.mockito.Mockito" factory-method="mock">
	<constructor-arg type="java.lang.Class" value="examples.ClientService"/>
	<constructor-arg type="java.lang.String" value="clientService"/>
</bean>

使用实例工厂方法实例化

类似于通过 静态工厂方法 实例化,使用实例工厂方法实例化会调用容器中现有 bean 的非静态方法来创建新的 bean。要使用此机制,请将 class 属性留空,并在 factory-bean 属性中指定当前(或父或祖先)容器中包含要调用以创建对象的实例方法的 bean 的名称。使用 factory-method 属性设置工厂方法本身的名称。以下示例展示了如何配置此类 bean

<!-- the factory bean, which contains a method called createClientServiceInstance() -->
<bean id="serviceLocator" class="examples.DefaultServiceLocator">
	<!-- inject any dependencies required by this locator bean -->
</bean>

<!-- the bean to be created via the factory bean -->
<bean id="clientService"
	factory-bean="serviceLocator"
	factory-method="createClientServiceInstance"/>

以下示例展示了相应的类

  • Java

  • Kotlin

public class DefaultServiceLocator {

	private static ClientService clientService = new ClientServiceImpl();

	public ClientService createClientServiceInstance() {
		return clientService;
	}
}
class DefaultServiceLocator {
	companion object {
		private val clientService = ClientServiceImpl()
	}
	fun createClientServiceInstance(): ClientService {
		return clientService
	}
}

一个工厂类也可以包含多个工厂方法,如下例所示

<bean id="serviceLocator" class="examples.DefaultServiceLocator">
	<!-- inject any dependencies required by this locator bean -->
</bean>

<bean id="clientService"
	factory-bean="serviceLocator"
	factory-method="createClientServiceInstance"/>

<bean id="accountService"
	factory-bean="serviceLocator"
	factory-method="createAccountServiceInstance"/>

以下示例展示了相应的类

  • Java

  • Kotlin

public class DefaultServiceLocator {

	private static ClientService clientService = new ClientServiceImpl();

	private static AccountService accountService = new AccountServiceImpl();

	public ClientService createClientServiceInstance() {
		return clientService;
	}

	public AccountService createAccountServiceInstance() {
		return accountService;
	}
}
class DefaultServiceLocator {
	companion object {
		private val clientService = ClientServiceImpl()
		private val accountService = AccountServiceImpl()
	}

	fun createClientServiceInstance(): ClientService {
		return clientService
	}

	fun createAccountServiceInstance(): AccountService {
		return accountService
	}
}

这种方法表明工厂 bean 本身可以通过依赖注入(DI)进行管理和配置。请参阅 依赖和配置详情

在 Spring 文档中,“factory bean”指的是在 Spring 容器中配置并通过 实例静态 工厂方法创建对象的 bean。相比之下,FactoryBean(注意大小写)指的是 Spring 特有的 FactoryBean 实现类。

确定 Bean 的运行时类型

确定特定 bean 的运行时类型并非易事。bean 元数据定义中指定的类只是一个初始的类引用,它可能与声明的工厂方法结合使用,或者本身是 FactoryBean 类,这些都可能导致 bean 的运行时类型不同;或者在实例级工厂方法的情况下可能完全未设置(这种情况通过指定的 factory-bean 名称解析)。此外,AOP 代理可能会使用基于接口的代理包装 bean 实例,从而限制暴露目标 bean 的实际类型(只暴露其实现的接口)。

确定特定 bean 实际运行时类型的推荐方法是为指定的 bean 名称调用 BeanFactory.getType。这考虑了上述所有情况,并返回 BeanFactory.getBean 调用为同一 bean 名称将返回的对象类型。