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

@Primary 和 @Fallback 是在有多个实例时通过类型进行自动装配的有效方法，当可以确定一个主要（或非回退）候选者时。

当您需要更多地控制选择过程时，可以使用 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 名称被视为默认限定符值。因此，您可以将 Bean 定义为 id 为 main 而不是嵌套的限定符元素，从而导致相同的匹配结果。但是，尽管您可以使用此约定按名称引用特定 Bean，但 @Autowired 从根本上来说是关于类型驱动的注入，并带有可选的语义限定符。这意味着限定符值，即使使用 Bean 名称回退，在类型匹配集中也始终具有缩小语义。它们在语义上并不表示对唯一 Bean id 的引用。良好的限定符值是 main 或 EMEA 或 persistent，表示特定组件的特性，这些特性独立于 Bean id，在匿名 Bean 定义（如前面示例中的定义）的情况下，Bean id 可能是自动生成的。

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

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

从 6.1 版开始，这需要 -parameters Java 编译器标志存在。从 6.2 版开始，容器对 Bean 名称匹配应用快速快捷方式解析，当参数名称与 Bean 名称匹配且没有类型、限定符或主要条件覆盖匹配时，绕过完整的类型匹配算法。因此，建议您的参数名称与目标 Bean 名称匹配。

作为按名称注入的替代方案，请考虑 JSR-250 @Resource 注解，它在语义上定义为通过其唯一名称识别特定目标组件，其中声明的类型与匹配过程无关。@Autowired 具有不同的语义：在按类型选择候选 Bean 后，指定的 String 限定符值仅在这些类型选择的候选中考虑（例如，将 account 限定符与标记有相同限定符标签的 Bean 进行匹配）。

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

@Autowired 还考虑自引用进行注入（即，引用回当前正在注入的 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 定义的信息。您可以添加 <qualifier/> 标签作为 <bean/> 标签的子元素，然后指定 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属性之外，还可以接受命名属性或替换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>