使用 @Primary@Fallback 微調基於註解的自動裝配

由於按型別自動裝配可能導致多個候選者,因此通常需要對選擇過程進行更精細的控制。實現此目的的一種方法是使用 Spring 的 @Primary 註解。當有多個 Bean 候選者可自動裝配到單值依賴項時,@Primary 表示應優先選擇特定的 Bean。如果在候選者中恰好存在一個 Primary 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>