使用限定符微调基于注解的自动装配

@Primary 是在使用类型自动装配时，当存在多个实例但可以确定一个主要候选者时，一种有效的做法。当您需要对选择过程进行更多控制时，可以使用 Spring 的 @Qualifier 注解。您可以将限定符值与特定参数关联起来，缩小类型匹配的范围，以便为每个参数选择一个特定的 Bean。在最简单的情况下，这可以是一个简单的描述性值，如以下示例所示

  • Java

  • Kotlin

public class MovieRecommender {

	@Autowired
	@Qualifier("main")
	private MovieCatalog movieCatalog;

	// ...
}
class MovieRecommender {

	@Autowired
	@Qualifier("main")
	private lateinit var movieCatalog: MovieCatalog

	// ...
}

您也可以在单个构造函数参数或方法参数上指定 @Qualifier 注解，如以下示例所示

  • Java

  • Kotlin

public class MovieRecommender {

	private final MovieCatalog movieCatalog;

	private final CustomerPreferenceDao customerPreferenceDao;

	@Autowired
	public void prepare(@Qualifier("main") MovieCatalog movieCatalog,
			CustomerPreferenceDao customerPreferenceDao) {
		this.movieCatalog = movieCatalog;
		this.customerPreferenceDao = customerPreferenceDao;
	}

	// ...
}
class MovieRecommender {

	private lateinit var movieCatalog: MovieCatalog

	private lateinit var customerPreferenceDao: CustomerPreferenceDao

	@Autowired
	fun prepare(@Qualifier("main") movieCatalog: MovieCatalog,
				customerPreferenceDao: CustomerPreferenceDao) {
		this.movieCatalog = movieCatalog
		this.customerPreferenceDao = customerPreferenceDao
	}

	// ...
}

以下示例显示了相应的 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">
		<qualifier value="main"/> (1)

		<!-- inject any dependencies required by this bean -->
	</bean>

	<bean class="example.SimpleMovieCatalog">
		<qualifier value="action"/> (2)

		<!-- inject any dependencies required by this bean -->
	</bean>

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

</beans>
1 带有 main 限定符值的 Bean 将与使用相同值的限定符的构造函数参数进行连接。
2 带有 action 限定符值的 Bean 将与使用相同值的限定符的构造函数参数进行连接。

对于回退匹配，bean 名称被视为默认限定符值。因此，您可以使用 `id` 为 `main` 来定义 bean，而不是使用嵌套的限定符元素，从而得到相同的匹配结果。但是，虽然您可以使用此约定通过名称引用特定 bean，但 `@Autowired` 从根本上来说是关于类型驱动的注入，带有可选的语义限定符。这意味着限定符值，即使使用 bean 名称回退，在类型匹配集合中始终具有缩小语义。它们在语义上不表示对唯一 bean `id` 的引用。好的限定符值是 `main` 或 `EMEA` 或 `persistent`，表达特定组件的特征，这些特征独立于 bean `id`，在匿名 bean 定义（如前面示例中的定义）的情况下，bean `id` 可能是自动生成的。

限定符也适用于类型化集合，如前所述，例如 `Set<MovieCatalog>`。在这种情况下，根据声明的限定符，所有匹配的 bean 都将作为集合注入。这意味着限定符不必是唯一的。相反，它们构成过滤条件。例如，您可以定义多个具有相同限定符值“action”的 `MovieCatalog` bean，所有这些 bean 都将注入到用 `@Qualifier("action")` 注释的 `Set<MovieCatalog>` 中。

让限定符值在类型匹配候选者中选择目标 bean 名称，不需要在注入点使用 `@Qualifier` 注释。如果没有其他解析指示器（例如限定符或主标记），对于非唯一依赖情况，Spring 会将注入点名称（即字段名称或参数名称）与目标 bean 名称进行匹配，并选择同名候选者（如果有）。

从 6.1 版本开始，这需要 `-parameters` Java 编译器标志。

也就是说，如果您打算通过名称表达注释驱动的注入，请不要主要使用 `@Autowired`，即使它能够在类型匹配候选者中按 bean 名称进行选择。相反，请使用 JSR-250 `@Resource` 注释，它在语义上被定义为通过其唯一名称标识特定目标组件，声明的类型与匹配过程无关。`@Autowired` 具有不同的语义：在通过类型选择候选 bean 后，指定的 `String` 限定符值仅在这些类型选择的候选者中被考虑（例如，将 `account` 限定符与标记有相同限定符标签的 bean 进行匹配）。

对于本身定义为集合、Map 或数组类型的 Bean，@Resource 是一个不错的解决方案，它通过唯一的名称引用特定的集合或数组 Bean。也就是说，从 4.3 版本开始，您也可以通过 Spring 的 @Autowired 类型匹配算法匹配集合、Map 和数组类型，只要元素类型信息在 @Bean 返回类型签名或集合继承层次结构中保留。在这种情况下，您可以使用限定符值在相同类型的集合之间进行选择，如上一段所述。

从 4.3 版本开始，@Autowired 还考虑自引用进行注入（即，引用回当前正在注入的 Bean）。请注意，自注入是一种回退机制。对其他组件的常规依赖始终优先。从这个意义上说，自引用不参与常规候选选择，因此特别地永远不会是主要的。相反，它们总是最终成为最低优先级。在实践中，您应该只在万不得已的情况下使用自引用（例如，通过 Bean 的事务代理调用同一实例上的其他方法）。在这种情况下，请考虑将受影响的方法分解到一个单独的委托 Bean 中。或者，您可以使用 @Resource，它可以通过唯一的名称获取指向当前 Bean 的代理。

尝试注入来自同一配置类上的 @Bean 方法的结果实际上也是一种自引用场景。要么在实际需要的地方（而不是配置类中的自动装配字段）在方法签名中延迟解析这些引用，要么将受影响的 @Bean 方法声明为 static，将其与包含的配置类实例及其生命周期分离。否则，这些 Bean 仅在回退阶段被考虑，而来自其他配置类的匹配 Bean 将被选择为主要候选者（如果可用）。

@Autowired 应用于字段、构造函数和多参数方法，允许通过限定符注释在参数级别进行缩小。相反，@Resource 仅支持字段和具有单个参数的 Bean 属性 setter 方法。因此，如果您的注入目标是构造函数或多参数方法，您应该坚持使用限定符。

您可以创建自己的自定义限定符注释。为此，定义一个注释并在您的定义中提供 @Qualifier 注释，如下面的示例所示

  • Java

  • Kotlin

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Genre {

	String value();
}
@Target(AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER)
@Retention(AnnotationRetention.RUNTIME)
@Qualifier
annotation class Genre(val value: String)

然后，您可以在自动装配的字段和参数上提供自定义限定符，如下面的示例所示

  • Java

  • Kotlin

public class MovieRecommender {

	@Autowired
	@Genre("Action")
	private MovieCatalog actionCatalog;

	private MovieCatalog comedyCatalog;

	@Autowired
	public void setComedyCatalog(@Genre("Comedy") MovieCatalog comedyCatalog) {
		this.comedyCatalog = comedyCatalog;
	}

	// ...
}
class MovieRecommender {

	@Autowired
	@Genre("Action")
	private lateinit var actionCatalog: MovieCatalog

	private lateinit var comedyCatalog: MovieCatalog

	@Autowired
	fun setComedyCatalog(@Genre("Comedy") comedyCatalog: MovieCatalog) {
		this.comedyCatalog = comedyCatalog
	}

	// ...
}

接下来，您可以提供候选 Bean 定义的信息。您可以在 <bean/> 标签的子元素中添加 <qualifier/> 标签，然后指定 type 和 value 以匹配您的自定义限定符注解。类型与注解的完全限定类名匹配。或者，为了方便起见，如果不存在冲突的名称风险，您可以使用简短的类名。以下示例演示了两种方法

<?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">
		<qualifier type="Genre" value="Action"/>
		<!-- inject any dependencies required by this bean -->
	</bean>

	<bean class="example.SimpleMovieCatalog">
		<qualifier type="example.Genre" value="Comedy"/>
		<!-- inject any dependencies required by this bean -->
	</bean>

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

</beans>

在 类路径扫描和托管组件 中，您可以看到在 XML 中提供限定符元数据的基于注解的替代方法。具体来说，请参阅 使用注解提供限定符元数据。

在某些情况下，使用没有值的注解就足够了。当注解用于更通用的目的并且可以应用于几种不同类型的依赖项时，这很有用。例如，您可以提供一个脱机目录，当没有互联网连接时可以搜索它。首先，定义简单的注解，如下例所示

  • Java

  • Kotlin

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Offline {
}
@Target(AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER)
@Retention(AnnotationRetention.RUNTIME)
@Qualifier
annotation class Offline

然后将注解添加到要自动装配的字段或属性，如下例所示

  • Java

  • Kotlin

public class MovieRecommender {

	@Autowired
	@Offline (1)
	private MovieCatalog offlineCatalog;

	// ...
}
1 此行添加了 @Offline 注解。 
class MovieRecommender {

	@Autowired
	@Offline (1)
	private lateinit var offlineCatalog: MovieCatalog

	// ...
}
1 此行添加了 @Offline 注解。

现在 Bean 定义只需要一个限定符 type，如下例所示

<bean class="example.SimpleMovieCatalog">
	<qualifier type="Offline"/> (1)
	<!-- inject any dependencies required by this bean -->
</bean>
1 此元素指定限定符。

您还可以定义自定义限定符注解，这些注解除了或代替简单的 value 属性之外，还可以接受命名属性。如果在要自动装配的字段或参数上指定了多个属性值，则 Bean 定义必须匹配所有这些属性值才能被视为自动装配候选。例如，考虑以下注解定义

  • Java

  • Kotlin

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface MovieQualifier {

	String genre();

	Format format();
}
@Target(AnnotationTarget.FIELD, AnnotationTarget.VALUE_PARAMETER)
@Retention(AnnotationRetention.RUNTIME)
@Qualifier
annotation class MovieQualifier(val genre: String, val format: Format)

在这种情况下，Format 是一个枚举，定义如下

  • Java

  • Kotlin

public enum Format {
	VHS, DVD, BLURAY
}
enum class Format {
	VHS, DVD, BLURAY
}

要自动装配的字段用自定义限定符进行注解，并包含两个属性的值：genre 和 format，如下例所示

  • Java

  • Kotlin

public class MovieRecommender {

	@Autowired
	@MovieQualifier(format=Format.VHS, genre="Action")
	private MovieCatalog actionVhsCatalog;

	@Autowired
	@MovieQualifier(format=Format.VHS, genre="Comedy")
	private MovieCatalog comedyVhsCatalog;

	@Autowired
	@MovieQualifier(format=Format.DVD, genre="Action")
	private MovieCatalog actionDvdCatalog;

	@Autowired
	@MovieQualifier(format=Format.BLURAY, genre="Comedy")
	private MovieCatalog comedyBluRayCatalog;

	// ...
}
class MovieRecommender {

	@Autowired
	@MovieQualifier(format = Format.VHS, genre = "Action")
	private lateinit var actionVhsCatalog: MovieCatalog

	@Autowired
	@MovieQualifier(format = Format.VHS, genre = "Comedy")
	private lateinit var comedyVhsCatalog: MovieCatalog

	@Autowired
	@MovieQualifier(format = Format.DVD, genre = "Action")
	private lateinit var actionDvdCatalog: MovieCatalog

	@Autowired
	@MovieQualifier(format = Format.BLURAY, genre = "Comedy")
	private lateinit var comedyBluRayCatalog: MovieCatalog

	// ...
}

最后，Bean 定义应该包含匹配的限定符值。此示例还演示了您可以使用 Bean 元属性而不是 <qualifier/> 元素。如果可用，<qualifier/> 元素及其属性优先，但如果不存在此类限定符，自动装配机制将回退到 <meta/> 标签中提供的值，如以下示例中的最后两个 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">
		<qualifier type="MovieQualifier">
			<attribute key="format" value="VHS"/>
			<attribute key="genre" value="Action"/>
		</qualifier>
		<!-- inject any dependencies required by this bean -->
	</bean>

	<bean class="example.SimpleMovieCatalog">
		<qualifier type="MovieQualifier">
			<attribute key="format" value="VHS"/>
			<attribute key="genre" value="Comedy"/>
		</qualifier>
		<!-- inject any dependencies required by this bean -->
	</bean>

	<bean class="example.SimpleMovieCatalog">
		<meta key="format" value="DVD"/>
		<meta key="genre" value="Action"/>
		<!-- inject any dependencies required by this bean -->
	</bean>

	<bean class="example.SimpleMovieCatalog">
		<meta key="format" value="BLURAY"/>
		<meta key="genre" value="Comedy"/>
		<!-- inject any dependencies required by this bean -->
	</bean>

</beans>