使用 @Primary 或 @Fallback 微调基于注解的自动装配

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

考虑以下配置，它将 firstMovieCatalog 定义为主要的 MovieCatalog：

  • Java

  • Kotlin

@Configuration
public class MovieConfiguration {

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

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

	// ...
}
@Configuration
class MovieConfiguration {

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

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

	// ...
}

另外，从 6.2 版本开始，有一个 @Fallback 注解，用于标记除常规 Bean 之外的任何要注入的 Bean。如果只剩下一个常规 Bean，它也同样是主要的：

  • Java

  • Kotlin

@Configuration
public class MovieConfiguration {

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

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

	// ...
}
@Configuration
class MovieConfiguration {

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

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

	// ...
}

通过上述配置的两种变体，以下 MovieRecommender 将自动装配 firstMovieCatalog：

  • Java

  • Kotlin

public class MovieRecommender {

	@Autowired
	private MovieCatalog movieCatalog;

	// ...
}
class MovieRecommender {

	@Autowired
	private lateinit var movieCatalog: MovieCatalog

	// ...
}

对应的 Bean 定义如下：

<?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">
		<!-- inject any dependencies required by this bean -->
	</bean>

	<bean class="example.SimpleMovieCatalog">
		<!-- inject any dependencies required by this bean -->
	</bean>

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

</beans>