Spring高级装配之处理自动装配的歧义性

通常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,效果都是一样的,都是告诉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。

你可能感兴趣的