在使用 @Autowired 注解的时候,如果有多个 bean 都能满足依赖关系,Spring 将抛出一个异常,这时,我们有必要处理自动装配的歧义性,来唯一确定一个要使用的 bean。
1.标示首选的 bean
在声明 bean 的时候,可通过将其中一个可选的 bean 设为首选( primary ) 来避免自动装配的歧义性,当遇到歧义性的时候,Spring 将使用首选的 bean,而不是其他可选的 bean,如下方式将声明一个首选的 bean:
@Component
@Primary
public class IceCream implements Dessert{
...
}
或者,使用如果你是用 Java 配置显式地声明,那么 @Bean 方法应该如下所示:
@Bean
@Primary
public Dessert iceCream(){
return new IceCream();
}
如果你是用 XML 配置的话,同样可以实现这样的功能:<bean>元素有一个 primary 属性用来指定首选的 bean
<bean id="iceCream" class="com.dessertdater.IceCream"
primary="true" />
不管你选用哪种方式,效果都是相同的,都是在告诉 Spring 在遇到歧义性的时候要选择首选的 bean。
但是,如果你标示了两个或更多的首选 bean,那么它就无法正常工作了,这带来了新的歧义性问题:就像 Spring 无法从多个可选的 bean 中做出选择一样,它也无法从多个首选 bean 中做出选择。限定符是一种更加强大的机制。
2.限定自动装配的 bean
@Qualifier 注解是使用限定符的主要方式,它可以与 @Autowired 和 @Inject 协同使用,在注入的时候指定想要注入进去的是哪个 bean。
@Autowired
@Qualifier("iceCream")
public void setDessert(Dessert dessert){
this.dessert = dessert;
}
这是使用限定符的最简单的例子。为 @Qualifier 注解所设置的参数就是想要注入的 bean 的 ID。
以上示例,Spring 会将 ID 为 iceCream 的 bean 注入到 方法中。
实际上,还有一点需要补充。更准确的讲,@Qualifier("iceCream") 所引用的 bean 要具有 String 类型的 “iceCream” 作为限定符。如果没有指定其他的限定符的话,所有的 bean 都会给定一个默认的限定符,这个限定符与 bean 的 ID 相同。因此,框架会将具有 “iceCream” 限定符的 bean 注入到 setDessert() 方法中。这恰巧就是 ID 为 iceCream 的 bean ,它是 IceCream 类在组件扫描的时候创建的。
基于默认的 bean ID 作为限定符是非常简单的,但这有时候会引入一些问题。
如果你重构了 IceCream 类,将其命名为 Gelato 的话,bean 的 ID 和默认的限定符会变成 gelato,这就无法匹配 setDessert() 方法中的限定符。自动装配会失败。
这里的问题在于 setDessert() 方法上所指定的限定符与要注入的 bean 的名称是紧耦合的。对类名称的任意改动都会导致限定符失效。
创建自定义的限定符
我们可以为 bean 设置自己的限定符,而不是依赖于将 bean ID 作为限定符。所需要做的就是在 bean 声明上添加 @Qualifier 注解:
@Component
@Qualifier("cold")
public class IceCream implements Dessert{
}
以上,“cold” 限定符和被它修饰的类(这里是 IceCream)做绑定,因为它没有耦合类名,因此你可以随意重构 IceCream 的类名,而不必担心会破坏自动装配。在注入的地方,只要引用 ”cold“ 限定符就可以了:
@Bean
@Qualifier("cold")
public Dessert iceCream(){
return new IceCream();
}
问题到这里看似已经完美解决,但是真的没有问题了吗?
在使用自定义的 @Qualifier 值时,最佳实践是为 bean 选择特征性或描述性的术语,而不是使用随意的名字
试想,如果两个 bean 都具有相同的特性,而你为两个 bean 都配置了相同的限定符,例如:
@Component
@Qualifier("cold")
public class Popsicle implements Dessert{
}
@Component
@Qualifier("cold")
public class IceCream implements Dessert{
}
这时,再次出现了歧义性问题。
可能想到的解决办法是在注入点和 bean 定义的地方同时再添加另外一个 @Qualifier 注解,IceCream 类大概就会如下所示:
@Component
@Qualifier("cold")
@Qualifier("creamy")
public class IceCream implements Dessert{
}
然而,Java 不允许在同一个条目上重复出现相同类型的多个注解(也不是完全不允许:Java 8 允许出现重复的注解,只要这个注解本身在定义的时候带有 @Repeatable 注解就可以。不过,Spring 的 @Qualifier 注解并没有在定义时添加 @Repeatable 注解),如果你试图这样做,编译器会提示错误。
所以,在这里,使用 @Qualifier 注解并没有办法将自动装配的可选 bean 缩小范围到仅有一个可选的 bean。
但是,我们可以创建自定义的限定符注解,当自定义的限定符注解被修饰到多个类上,注入 bean 仍然具有歧义性的时候,我们只需要再创建一个自定义注解,如此就能绕过 @Qualifier 注解不能重复出现的规则,却又能达到如上例所示的效果。
首先我们需要创建注解,它本身要用 @Qualifier 注解来标注,这样它便具有了 @Qualifier 注解的特性,它本身实际上就成为了限定符注解。
定义 @Cold 注解如下:
@Target({ElementType.CONSTRUCTOR, ElementType.FIELD,
ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Cold{
}
定义 @Creamy 注解如下:
@Target({ElementType.CONSTRUCTOR, ElementType.FIELD,
ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Creamy{
}
现在,我们来看一下 IceCream ,并为其添加 @Cold 和 @Creamy 注解:
@Component
@Cold
@Creamy
public class IceCream implements Dessert{
}
由于是不同的注解,这种方式完全合法。
到此,已经完全解决了自动装配 bean 所遇到的歧义性问题。
|