Skip to content

使用 @Primary@Fallback 精细控制基于注解的自动装配

由于按类型自动装配可能会导致多个候选者,因此通常需要对选择过程进行更多控制。实现此目的的一种方法是使用 Spring 的 @Primary 注解。当多个 Bean 都是自动装配到单值依赖项的候选者时,@Primary 表示应优先考虑特定的 Bean。如果候选者中恰好存在一个首选 (Primary) Bean,它将成为自动装配的值。

考虑以下配置,它将 firstMovieCatalog 定义为首选的 MovieCatalog

java
@Configuration
public class MovieConfiguration {

	@Bean
	@Primary
	public MovieCatalog firstMovieCatalog() { ... }

	@Bean
	public MovieCatalog secondMovieCatalog() { ... }

	// ...
}
kotlin
@Configuration
class MovieConfiguration {

	@Bean
	@Primary
	fun firstMovieCatalog(): MovieCatalog { ... }

	@Bean
	fun secondMovieCatalog(): MovieCatalog { ... }

	// ...
}

或者,从 6.2 版本开始,提供了一个 @Fallback 注解,用于标示常规注入点之外的任何 Bean。如果只剩下一个常规 Bean,它实际上也是首选的:

java
@Configuration
public class MovieConfiguration {

	@Bean
	public MovieCatalog firstMovieCatalog() { ... }

	@Bean
	@Fallback
	public MovieCatalog secondMovieCatalog() { ... }

	// ...
}
kotlin
@Configuration
class MovieConfiguration {

	@Bean
	fun firstMovieCatalog(): MovieCatalog { ... }

	@Bean
	@Fallback
	fun secondMovieCatalog(): MovieCatalog { ... }

	// ...
}

在这两种配置变体下,下面的 MovieRecommender 都会自动装配 firstMovieCatalog

java
public class MovieRecommender {

	@Autowired
	private MovieCatalog movieCatalog;

	// ...
}
kotlin
class MovieRecommender {

	@Autowired
	private lateinit var movieCatalog: MovieCatalog

	// ...
}

相应的 XML Bean 定义如下:

xml
<?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:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
		https://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/context
		https://www.springframework.org/schema/context/spring-context.xsd">

	<context:annotation-config/>

	<bean class="example.SimpleMovieCatalog" primary="true">
		<!-- 注入此 Bean 所需的任何依赖 -->
	</bean>

	<bean class="example.SimpleMovieCatalog">
		<!-- 注入此 Bean 所需的任何依赖 -->
	</bean>

	<bean id="movieRecommender" class="example.MovieRecommender"/>

</beans>

补充教学 —— 解决“多选一”的烦恼

在 Spring 容器中,当你通过接口注入依赖时,如果这个接口有多个实现类,Spring 就会陷入“选择困难症”(NoUniqueBeanDefinitionException)。@Primary@Fallback 就是解决这个问题的两把利器。

1. @Primary:钦定接班人@Primary 相当于明确告诉 Spring:“如果有多个候选者,默认就用我。”

  • 适用场景:你有一个主要的服务实现,其他实现只是为了特定场景(如 Mock 或测试)。
  • 注意:同一个接口的多个实现中,只能有一个被标注为 @Primary。如果标了两个,Spring 依然会报错,因为它还是不知道选哪一个。

2. @Fallback:备胎的自我修养 这是 Spring 6.2 新引入的注解,它的逻辑和 @Primary 相反。

  • @Primary 是向上提拔:把我变成第一优先级。
  • @Fallback 是向下靠后:把我变成最后的备选(即“备胎”)。
  • 意义:如果你有 10 个实现,只想让其中一个在兜底时生效,给它加个 @Fallback 显然比给其他 9 个加 @Primary 要方便得多。

3. @Primary vs @Qualifier 这是很多开发者容易搞混的地方:

  • @Primary:是 生产端 的控制。它定义在 Bean 申明的地方。它改变的是 Bean 的“默认地位”。
  • @Qualifier:是 消费端 的控制。它定义在 @Autowired 注入点的地方。它强制要求注入“指定名字”的 Bean。
  • 优先级@Qualifier 的优先级更高。如果你注入点写了 @Qualifier("beanB"),即使 beanA 上标了 @Primary,Spring 也会注入 beanB

4. 现实案例:策略模式的默认行为 假设你做支付系统。

java
@Component @Primary
public class AliPayService implements PaymentService { ... }

@Component
public class WechatPayService implements PaymentService { ... }

当你直接 @Autowired private PaymentService paymentService; 时,默认拿到的就是阿里支付。这样你就为系统提供了一个稳健的默认行为。

Based on Spring Framework.