通常bean的自動裝配能夠給我們提供很大的方便,它會減少裝配應用程序組件時所需要的顯示配置的麻煩。不過,僅有一個bean匹配所需的結果時,自動裝配才是有效的。如果符合條件的bean不只一個,這時就會阻礙Spring自動裝配屬性、構造器參數或方法參數。
下面我們就來制造一種自動裝配歧義性的情況:
public interface Dessert {
String sayHello();
}
@Service
public class Cake implements Dessert{
@Override
public String sayHello() {
return "Hello World!";
}
}
@Service
public class IceCream implements Dessert {
@Override
public String sayHello() {
return "Hello World!";
}
}
@Service
public class Cookies implements Dessert{
@Override
public String sayHello() {
return "Hello World!";
}
}
@Autowired
private Dessert dessert;
public void sayHello(){
System.out.println(dessert.sayHello());
}
在Spring初始化bean之后,他會盡可能得去滿足bean的依賴,在本例中,依賴是通過帶有@Autowired注解的方法進行聲明的。通常為了當要注入的bean不存在時,不至于拋異常,將@Autowired的required屬性設置為false。
在進行組件掃描的時候,能夠發現它們并將其創建為Spring應用上下文里面的bean,但現在Spring要注入的Dessert類型有三個實現,所有Spring就不能決定要注入那一個了,所以就拋了異常:
nested excpetion is
org.springframework.beans.factory.NoUniqueBeanDefinitionException:
No quanlifying bean of type [com.ambiguity.service.Dessert] is defined:
expeted single matching bean but found 3: cake,cookies,iceCream
但是不要擔心,Spring提供了很多解決這個問題的方案,你可以將可選bean中的一個設置為首選(primary)的bean,或者使用限定符(qualifier)來幫助Spring將可選的bean的范圍縮小到只有一個bean。
1.標示首選的bean
在Spring中可以通過@Primary注解將一個bean標記為首選bean,比如下面我們將IceCream bean聲明為首選bean:
@Service
@Primary
public class IceCream implements Dessert {
@Override
public String sayHello() {
return "Hello World!";
}
}
或者,如果你通過bean配置顯示地聲明IceCream,那么@Bean方法應該如下所示:
@Configuration
public class IceCreamBean {
@Bean
@Primary
public Dessert iceCream(){
return new IceCream();
}
}
如果你使用的是XML裝配Bean,同樣可以使用這樣的功能:
<bean id="iceCream" class="com.ambiguity.service.impl.IceCream" primary="true" />
不管你使用哪種方式來標記首選bean,效果都是一樣的,都是告訴Spring在遇到歧義性的時候要選擇首選Bean。
但是當兩個bean都被標記了首選bean,那么Spring就有無法正常工作了。這時就要使用Spring提供的另一個強大的機制了,那就是限定符。
2.限定自動裝配的bean
Spring的限定符能夠在所有可選的bean上進行縮小范圍的操作,最終能夠達到只有一個bean滿足所有規定的限制條件。如果將所有限定符都用上后依然存在歧義性,那么你可以繼續使用限定符來縮小選擇范圍。
@Qualifier注解是使用限定符的重要方式。它可以與@Autowired和@Inject協同使用,在注入的時候指定想要注入進去的是哪一個bean。例如,我們確保將IceCream注入到setDessert()中:
@Service
public class AmbiguityTest {
@Autowired(required=false)
@Qualifier("iceCream")
private Dessert dessert;
public void sayHello(){
System.out.println(dessert.sayHello());
}
}
為@Qualifier注解所設置的參數就是想注入的bean的ID。所有使用了@Component注解聲明的的類都會創建為bean,并且bean的ID默認為類名首字母小寫,即:iceCream。因此,@Qualifier("iceCream")指向的是組件掃描時所創建的bean。并且這個bean是IceCream的實例。
更準確的講,@Qualifier("iceCream")所引用的bean具有String類型的"iceCream"作為限定符。默認情況下bean的限定符與bean的ID相同。
基于默認的bean ID作為限定符是非常簡單的,但這有可能會引發一些問題。如果你重構了IceCream,更改了了這個類的名,那么我們使用@Qualifier("iceCream")注入時就會發生異常,不要擔心我們可以自定義bean的限定符。
創建自定義限定符
我們可以為bean設置自己的限定符,我們只需在bean聲明上添加@Qualifier注解:
@Service
@Primary
@Qualifier("cold")
public class IceCream implements Dessert {
@Override
public String sayHello() {
return "Hello World!";
}
}
在使用bean的時候只需要在setDessert()方法上加上@Qualifier("cold"):
@Service
public class AmbiguityTest {
@Autowired(required=false)
@Qualifier("cold")
private Dessert dessert;
public void sayHello(){
System.out.println(dessert.sayHello());
}
}
如果bean是通過@Bean的方式顯示的裝配的,@Qualifier也可以和@Bean注解一起使用:
@Configuration
public class IceCreamBean {
@Bean
@Qualifier("cold")
public Dessert iceCream(){
return new IceCream();
}
}
使用自定義的限定符注解
當兩個bean的限定符相同時,在我們就再次遇到了歧義性:
@Service
@Qualifier("cold")
public class Cookies implements Dessert{
@Override
public String sayHello() {
return "Hello World!";
}
}
我們也許會想到使用多個@Qualifier注解,像這樣:
@Service
@Qualifier("cold")
@Qualifier("creamy")
public class IceCream implements Dessert {
@Override
public String sayHello() {
return "Hello World!";
}
}
但事實上,Java不予許同一個條目上重復出現相同類型的多個注解。這時候我們可以通過自定義注解的方式解決這一問題:
@Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Cold {
}
@Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Creamy {
}
這時候如果我們不想用@Qualifier注解的時候,就可以使用我們自定義的限定符注解@Cold和@Creamy:
@Service
@Cold
@Creamy
public class IceCream implements Dessert {
@Override
public String sayHello() {
return "Hello World!";
}
}
同樣,也可以自定義注解@Fruity注解,供Cookies bean使用:
@Service
@Cold
@Fruity
public class Cookies implements Dessert{
@Override
public String sayHello() {
return "Hello World!";
}
}
這樣解決自動自動裝配歧義性的解決方案就全部介紹完了!下節我們將會介紹如何在不同作用域中聲明bean。