在使用 @Autowired 如果出现 NoUniqueBeanDefinitionException 除了使用 Primary 难道没有别的办法了么?
- 设置 @Bean 注解中 autowireCandidate 属性为 false
- 使用 @Qualifier 注解
- 使用 @Primary 注解
- 使用 @Priority 注解
- 使用 bean 名称
- 总结
假设系统里面有同个接口有多个实现,有可能就会出现 NoUniqueBeanDefinitionException。如下例:
public interface Human {
String getGender();
}
public class Man implements Human {
@Override
public String getGender() {
return "男";
}
}
public class Woman implements Human {
@Override
public String getGender() {
return "女";
}
}
public class MultiBeanExample {
public static void main(String[] args) {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.register(MultiBeanExample.class);
ctx.refresh();
ctx.close();
}
@Bean
public Human man() {
return new Man();
}
@Bean
public Human woman() {
return new Woman();
}
//控制台会输出: Caused by: org.springframework.beans.factory.NoUniqueBeanDefinitionException:
// No qualifying bean of type 'xxxx.Human' available:
// expected single matching bean but found 2: man,woman
@Bean
public String extractGender(Human human) {
String gender = human.getGender();
System.out.println("性别为:" + gender);
return gender;
}
}
设置 @Bean 注解中 autowireCandidate 属性为 false
public class MultiBeanExample {
public static void main(String[] args) {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.register(MultiBeanExample.class);
ctx.refresh();
// 控制台会输出:女
System.out.println(ctx.getBean("woman", Human.class).getGender());
ctx.close();
}
@Bean
public Human man() {
return new Man();
}
@Bean(autowireCandidate = false)
public Human woman() {
return new Woman();
}
@Bean
public String extractGender(Human human) {
String gender = human.getGender();
// 控制台会输出 性别为:男
System.out.println("性别为:" + gender);
return gender;
}
}
DefaultListableBeanFactory#isAutowireCandidate 方法中会调用 QualifierAnnotationAutowireCandidateResolver#isAutowireCandidate 方法,判断 BeanDefinition 中 isAutowireCandidate 是否是 true,在 woman() 方法上的 @Bean 注解中 设置为 false,所以在自动装配的时候就排除它。虽然自动装配排查了它,但是可以通过依赖查找(getBean)方式获得 Bean。
使用 @Qualifier 注解
public class MultiBeanExample {
public static void main(String[] args) {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.register(MultiBeanExample.class);
ctx.refresh();
ctx.close();
}
@Bean
public Human man() {
return new Man();
}
@Bean
public Human woman() {
return new Woman();
}
@Bean
public String extractGender(@Qualifier("man") Human human) {// 限定 bean 名称
String gender = human.getGender();
// 控制台会输出 性别为:男
System.out.println("性别为:" + gender);
return gender;
}
}
DefaultListableBeanFactory#isAutowireCandidate 方法中会调用 QualifierAnnotationAutowireCandidateResolver#checkQualifiers 方法,当是 beanName 是 man 时返回 true,beanName 为 woman 时返回 false。
使用 @Primary 注解
public class MultiBeanExample {
public static void main(String[] args) {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.register(MultiBeanExample.class);
ctx.refresh();
ctx.close();
}
@Bean
@Primary
public Human man() {
return new Man();
}
@Bean
public Human woman() {
return new Woman();
}
// 控制台输出 性别为:男
@Bean
public String extractGender(Human human) {
String gender = human.getGender();
System.out.println("性别为:" + gender);
return gender;
}
}
由于在 woman() 方法上标注了 @Primary 注解,在构建 RootBeanDefinition 时候会把 primary 属性设置成 true。
在 DefaultListableBeanFactory#doResolveDependency 中的 findAutowireCandidates(beanName, type, descriptor) 中获取了 man 和 woman 2 个 Bean
在 DefaultListableBeanFactory#determineAutowireCandidate 中调用 determinePrimaryCandidate(candidates, requiredType) 返回 bean 名称为 man
使用 @Priority 注解
public interface Human {
String getGender();
}
@Priority(1)
public class Man implements Human {
@Override
public String getGender() {
return "男";
}
}
@Priority(2)
public class Woman implements Human {
@Override
public String getGender() {
return "女";
}
}
public class MultiBeanExample {
public static void main(String[] args) {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.register(MultiBeanExample.class);
ctx.refresh();
ctx.close();
}
@Bean
public Human man() {
return new Man();
}
@Bean
public Human woman() {
return new Woman();
}
@Bean
public String extractGender(Human human) {
String gender = human.getGender();
// 控制台会输出 性别为:男(即 @Priority 注解值越小优先级越高)
System.out.println("性别为:" + gender);
return gender;
}
}
在 DefaultListableBeanFactory#determineAutowireCandidate 方法中调用 determineHighestPriorityCandidate(candidates, requiredType) 方法返回 bean 名称为 man
使用 bean 名称
public class MultiBeanExample {
public static void main(String[] args) {
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
ctx.register(MultiBeanExample.class);
ctx.refresh();
ctx.close();
}
@Bean
public Human man() {
return new Man();
}
@Bean
public Human woman() {
return new Woman();
}
@Bean
public String extractGender(Human man) {// 方法参数名称为 man
String gender = man.getGender();
// 控制台会输出 性别为:男
System.out.println("性别为:" + gender);
return gender;
}
}
在 DefaultListableBeanFactory#determineAutowireCandidate 中经过 (beanInstance != null && this.resolvableDependencies.containsValue(beanInstance)) || matchesBeanName(candidateName, descriptor.getDependencyName()) 判断,即依赖的名称与候选 bean 名称相同
总结
@Autowired 注解是按需要注入的类型来筛选,如果有多个同类型的 Bean 先按照 BeanDefintion 的 isAutowireCandidate() 过滤(默认是 true),如果有 @Qualifier 注解则根据指定的 Bean 名称过滤。否则后面再根据 @Primary 注解过滤,否则再根据 @Priority 注解过滤,否则最后再根据名称过滤。