使用 @Bean 注释

@Bean 是一个方法级注释，是 XML <bean/> 元素的直接对应项。该注释支持 <bean/> 提供的某些属性，例如

您可以在 @Configuration 注释或 @Component 注释的类中使用 @Bean 注释。

声明 Bean

要声明 Bean，您可以使用 @Bean 注释为方法添加注释。您可以使用此方法在 ApplicationContext 中注册 Bean 定义，类型指定为方法的返回值。默认情况下，Bean 名称与方法名称相同。以下示例显示 @Bean 方法声明

  • Java

  • Kotlin

@Configuration
public class AppConfig {

	@Bean
	public TransferServiceImpl transferService() {
		return new TransferServiceImpl();
	}
}
@Configuration
class AppConfig {

	@Bean
	fun transferService() = TransferServiceImpl()
}

前面的配置与以下 Spring XML 完全等效

<beans>
	<bean id="transferService" class="com.acme.TransferServiceImpl"/>
</beans>

这两个声明都会在 ApplicationContext 中提供一个名为 transferService 的 Bean，该 Bean 绑定到类型为 TransferServiceImpl 的对象实例，如下面的文本图像所示

transferService -> com.acme.TransferServiceImpl

您还可以使用默认方法定义 Bean。这允许通过在默认方法上实现带有 Bean 定义的接口来组合 Bean 配置。

  • Java

public interface BaseConfig {

	@Bean
	default TransferServiceImpl transferService() {
		return new TransferServiceImpl();
	}
}

@Configuration
public class AppConfig implements BaseConfig {

}

您还可以使用接口（或基类）返回类型声明 @Bean 方法，如下面的示例所示

  • Java

  • Kotlin

@Configuration
public class AppConfig {

	@Bean
	public TransferService transferService() {
		return new TransferServiceImpl();
	}
}
@Configuration
class AppConfig {

	@Bean
	fun transferService(): TransferService {
		return TransferServiceImpl()
	}
}

但是，这会将高级类型预测的可见性限制为指定的接口类型（TransferService）。然后，容器仅在受影响的单例 Bean 实例化后才会了解完整类型（TransferServiceImpl）。非延迟单例 Bean 会根据其声明顺序实例化，因此您可能会看到不同的类型匹配结果，具体取决于另一个组件尝试通过非声明类型（例如 @Autowired TransferServiceImpl，仅在 transferService Bean 实例化后才解析）进行匹配的时间。

如果您始终通过声明的服务接口引用类型，则 @Bean 返回类型可以安全地加入该设计决策。但是，对于实现多个接口的组件或可能通过其实现类型引用的组件，最好声明尽可能最具体的返回类型（至少与引用 Bean 的注入点所需的类型一样具体）。

Bean 依赖项

带 @Bean 注释的方法可以具有任意数量的参数，这些参数描述了构建该 Bean 所需的依赖项。例如，如果我们的 TransferService 需要 AccountRepository，我们可以使用一个方法参数来实现该依赖项，如下面的示例所示

  • Java

  • Kotlin

@Configuration
public class AppConfig {

	@Bean
	public TransferService transferService(AccountRepository accountRepository) {
		return new TransferServiceImpl(accountRepository);
	}
}
@Configuration
class AppConfig {

	@Bean
	fun transferService(accountRepository: AccountRepository): TransferService {
		return TransferServiceImpl(accountRepository)
	}
}

解析机制与基于构造函数的依赖项注入非常相似。有关更多详细信息，请参阅相关部分。

接收生命周期回调

使用 @Bean 注解定义的任何类都支持常规生命周期回调，并且可以使用 JSR-250 中的 @PostConstruct 和 @PreDestroy 注解。有关更多详细信息，请参阅 JSR-250 注解。

常规 Spring 生命周期 回调也得到完全支持。如果某个 bean 实现 InitializingBean、DisposableBean 或 Lifecycle，则容器会调用它们各自的方法。

标准的 *Aware 接口集（例如 BeanFactoryAware、BeanNameAware、MessageSourceAware、ApplicationContextAware 等）也得到完全支持。

@Bean 注解支持指定任意初始化和销毁回调方法，非常类似于 Spring XML 中 bean 元素上的 init-method 和 destroy-method 属性，如下例所示

  • Java

  • Kotlin

public class BeanOne {

	public void init() {
		// initialization logic
	}
}

public class BeanTwo {

	public void cleanup() {
		// destruction logic
	}
}

@Configuration
public class AppConfig {

	@Bean(initMethod = "init")
	public BeanOne beanOne() {
		return new BeanOne();
	}

	@Bean(destroyMethod = "cleanup")
	public BeanTwo beanTwo() {
		return new BeanTwo();
	}
}
class BeanOne {

	fun init() {
		// initialization logic
	}
}

class BeanTwo {

	fun cleanup() {
		// destruction logic
	}
}

@Configuration
class AppConfig {

	@Bean(initMethod = "init")
	fun beanOne() = BeanOne()

	@Bean(destroyMethod = "cleanup")
	fun beanTwo() = BeanTwo()
}

默认情况下，使用 Java 配置定义的 bean 具有公共 close 或 shutdown 方法，会自动使用销毁回调进行登记。如果您有公共 close 或 shutdown 方法，并且不希望在容器关闭时调用它，则可以向 bean 定义中添加 @Bean(destroyMethod = "") 以禁用默认 (inferred) 模式。

对于使用 JNDI 获取的资源，您可能希望默认这样做，因为它的生命周期在应用程序外部进行管理。特别是，请务必始终对 DataSource 执行此操作，因为已知它在 Jakarta EE 应用程序服务器上存在问题。

以下示例演示如何防止 DataSource 的自动销毁回调

  • Java

  • Kotlin

@Bean(destroyMethod = "")
public DataSource dataSource() throws NamingException {
	return (DataSource) jndiTemplate.lookup("MyDS");
}
@Bean(destroyMethod = "")
fun dataSource(): DataSource {
	return jndiTemplate.lookup("MyDS") as DataSource
}

此外，对于 @Bean 方法，您通常使用编程方式 JNDI 查找，方法是使用 Spring 的 JndiTemplate 或 JndiLocatorDelegate 帮助程序或直接 JNDI InitialContext 用法，但不是 JndiObjectFactoryBean 变体（这将强制您将返回类型声明为 FactoryBean 类型，而不是实际目标类型，使其更难用于其他 @Bean 方法中的交叉引用调用，这些方法旨在引用此处提供的资源）。

对于上述示例中的 BeanOne，在构建期间直接调用 init() 方法也是同样有效的，如下面的示例所示

  • Java

  • Kotlin

@Configuration
public class AppConfig {

	@Bean
	public BeanOne beanOne() {
		BeanOne beanOne = new BeanOne();
		beanOne.init();
		return beanOne;
	}

	// ...
}
@Configuration
class AppConfig {

	@Bean
	fun beanOne() = BeanOne().apply {
		init()
	}

	// ...
}
当直接在 Java 中工作时，您可以对对象执行任何操作，而不必总是依赖容器生命周期。

指定 Bean 作用域

Spring 包含 @Scope 注释，以便您可以指定 Bean 的作用域。

使用 @Scope 注释

您可以指定使用 @Bean 注释定义的 Bean 应具有特定作用域。您可以使用 Bean 作用域部分中指定的任何标准作用域。

默认作用域为 singleton，但您可以使用 @Scope 注释覆盖此作用域，如下面的示例所示

  • Java

  • Kotlin

@Configuration
public class MyConfiguration {

	@Bean
	@Scope("prototype")
	public Encryptor encryptor() {
		// ...
	}
}
@Configuration
class MyConfiguration {

	@Bean
	@Scope("prototype")
	fun encryptor(): Encryptor {
		// ...
	}
}

@Scope 和 scoped-proxy

Spring 提供了一种通过 作用域代理使用作用域依赖项的便捷方式。在使用 XML 配置时，创建此类代理的最简单方法是 <aop:scoped-proxy/> 元素。使用 @Scope 注释在 Java 中配置 Bean 可通过 proxyMode 属性提供同等支持。默认值为 ScopedProxyMode.DEFAULT，它通常表示不应创建作用域代理，除非在组件扫描指令级别配置了其他默认值。您可以指定 ScopedProxyMode.TARGET_CLASS、ScopedProxyMode.INTERFACES 或 ScopedProxyMode.NO。

如果您将作用域代理示例从 XML 引用文档（请参阅 作用域代理）移植到使用 Java 的 @Bean，它类似于以下内容

  • Java

  • Kotlin

// an HTTP Session-scoped bean exposed as a proxy
@Bean
@SessionScope
public UserPreferences userPreferences() {
	return new UserPreferences();
}

@Bean
public Service userService() {
	UserService service = new SimpleUserService();
	// a reference to the proxied userPreferences bean
	service.setUserPreferences(userPreferences());
	return service;
}
// an HTTP Session-scoped bean exposed as a proxy
@Bean
@SessionScope
fun userPreferences() = UserPreferences()

@Bean
fun userService(): Service {
	return SimpleUserService().apply {
		// a reference to the proxied userPreferences bean
		setUserPreferences(userPreferences())
	}
}

自定义 Bean 命名

默认情况下，配置类使用 @Bean 方法的名称作为结果 Bean 的名称。但是，可以使用 name 属性覆盖此功能，如下面的示例所示

  • Java

  • Kotlin

@Configuration
public class AppConfig {

	@Bean("myThing")
	public Thing thing() {
		return new Thing();
	}
}
@Configuration
class AppConfig {

	@Bean("myThing")
	fun thing() = Thing()
}

Bean 别名

如 命名 Bean中所述，有时需要为单个 Bean 提供多个名称，也称为 Bean 别名。@Bean 注释的 name 属性接受一个 String 数组用于此目的。以下示例显示如何为 Bean 设置多个别名

  • Java

  • Kotlin

@Configuration
public class AppConfig {

	@Bean({"dataSource", "subsystemA-dataSource", "subsystemB-dataSource"})
	public DataSource dataSource() {
		// instantiate, configure and return DataSource bean...
	}
}
@Configuration
class AppConfig {

	@Bean("dataSource", "subsystemA-dataSource", "subsystemB-dataSource")
	fun dataSource(): DataSource {
		// instantiate, configure and return DataSource bean...
	}
}

Bean 描述

有时，提供 Bean 的更详细文本描述很有帮助。当 Bean（可能通过 JMX）用于监视目的时，这可能特别有用。

要向 @Bean 添加描述，可以使用 @Description 注释，如下例所示

  • Java

  • Kotlin

@Configuration
public class AppConfig {

	@Bean
	@Description("Provides a basic example of a bean")
	public Thing thing() {
		return new Thing();
	}
}
@Configuration
class AppConfig {

	@Bean
	@Description("Provides a basic example of a bean")
	fun thing() = Thing()
}