Spring入门(八):自动装配的歧义性
1. 什么是自动装配的歧义性?
在Spring中,装配bean有以下3种方式:
- 自动装配
- Java配置
- xml配置
在这3种方式中,自动装配为我们带来了很大的便利,大大的降低了我们需要手动装配bean的代码量。
不过,自动装配也不是万能的,因为仅有一个bean匹配条件时,Spring才能实现自动装配,如果出现不止1个bean匹配条件时,Spring就会不知道要装配哪个bean,抛出org.springframework.beans.factory.NoUniqueBeanDefinitionException
异常,这就是自动装配的歧义性。
为了方便理解,我们举个具体的例子。
首先,我们新建个接口Dessert,该接口仅有1个方法showName():
package chapter03.ambiguity;
public interface Dessert {
void showName();
}
然后定义3个该接口的实现类Cake,Cookies,IceCream:
package chapter03.ambiguity;
import org.springframework.stereotype.Component;
@Component
public class Cake implements Dessert {
@Override
public void showName() {
System.out.println("蛋糕");
}
}
package chapter03.ambiguity;
import org.springframework.stereotype.Component;
@Component
public class Cookies implements Dessert {
@Override
public void showName() {
System.out.println("饼干");
}
}
package chapter03.ambiguity;
import org.springframework.stereotype.Component;
@Component
public class IceCream implements Dessert {
@Override
public void showName() {
System.out.println("冰激凌");
}
}
然后新建甜点店类DessertShop,该类的setDessert()方法需要装配1个Dessert的实例bean:
package chapter03.ambiguity;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Component
public class DessertShop {
private Dessert dessert;
public Dessert getDessert() {
return dessert;
}
@Autowired
public void setDessert(Dessert dessert) {
this.dessert = dessert;
}
public void showDessertName() {
this.dessert.showName();
}
}
不过现在符合装配条件的有3个bean,它们的bean ID(默认情况下是类名首字母小写)分别为cake,cookies,iceCream,Spring该自动装配哪个呢?
带着这个疑问,我们先新建配置类AmbiguityConfig:
package chapter03.ambiguity;
import org.springframework.context.annotation.ComponentScan;
@ComponentScan
public class AmbiguityConfig {
}
这个类的关键是添加了@ComponentScan
注解,让Spring自动扫描已经定义好的bean。
最后,新建类Main,在其main()方法中添加如下测试代码:
package chapter03.ambiguity;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
public class Main {
public static void main(String[] args) {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AmbiguityConfig.class);
DessertShop dessertShop = context.getBean(DessertShop.class);
dessertShop.showDessertName();
context.close();
}
}
运行代码,发现抛出org.springframework.beans.factory.NoUniqueBeanDefinitionException
异常,如下所示:
那么如何解决自动装配的歧义性呢?Spring提供了以下2种方案:
- 标记首选的bean
- 使用限定符
2. 标记首选的bean
既然现在有3个匹配条件的bean,我们可以通过@Primary
注解标记下哪个是首选的bean,这样当Spring发现有不止1个匹配条件的bean时,就会选择这个首选的bean。
比如3种甜点里,我最喜欢吃饼干,那么我就把Cookies标记为首选的bean:
package chapter03.ambiguity;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;
@Component
@Primary
public class Cookies implements Dessert {
@Override
public void showName() {
System.out.println("饼干");
}
}
再次运行测试代码,输出结果如下所示:
饼干
圆满解决了歧义性的问题,不过有一天,有个同事不小心在IceCream上也添加了@Primary
注解:
package chapter03.ambiguity;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;
@Component
@Primary
public class IceCream implements Dessert {
@Override
public void showName() {
System.out.println("冰激凌");
}
}
编译都正常,因此都没注意,但发布后运行时,却抛出如下异常:
意思就是发现了不止1个首选的bean,因为此时Spring又不知道该选择哪个了,也就是有了新的歧义性,所以甩锅抛出了异常。
3. 使用限定符
3.1 基于bean ID的限定符
Spring还提供了另一个注解@Qualifier
注解来解决自动装配的歧义性,它可以与@Autowired
或者@Inject
一起使用,在注入的时候指定想要注入哪个bean。
比如,我们把IceCream注入到setDessert()的方法参数之中:
@Autowired
@Qualifier("iceCream")
public void setDessert(Dessert dessert) {
this.dessert = dessert;
}
这里传递的iceCream指的是IceCream类默认生成的bean ID。
再次运行测试代码,输出结果如下所示:
冰激凌
我们可以发现,使用了@Qualifier
注解后,我们之前标记的@Primary
注解被忽略了,也就是说,@Qualifier
注解的优先级比@Primary
注解的优先级高。
使用默认的限定符虽然解决了问题,不过可能会引入一些问题。比如我在重构代码时,将IceCream类名修改成了Gelato:
package chapter03.ambiguity;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;
@Component
@Primary
public class Gelato implements Dessert {
@Override
public void showName() {
System.out.println("冰激凌");
}
}
此时运行代码,会发现抛出org.springframework.beans.factory.NoSuchBeanDefinitionException
异常,如下所示:
这是因为IceCream重命名为Gelato之后,bean ID由iceCream变成了gelato,但我们注入地方的代码仍然使用的是iceCream这个bean ID,导致没有找到匹配条件的bean。
鉴于使用默认的限定符的这种局限性,我们可以使用自定义的限定符来解决这个问题。
为不影响后面代码的测试结果,将Gelato类再改回IceCream
3.2 基于面向特性的限定符
为了避免因为修改类名而导致自动装配失效的问题,我们可以在@Component或者@Bean注解声明bean时添加上@Qualifier注解,如下所示:
package chapter03.ambiguity;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Component;
@Component
@Qualifier("cold")
public class IceCream implements Dessert {
@Override
public void showName() {
System.out.println("冰激凌");
}
}
然后在注入的地方,不再使用默认生成的bean ID,而是使用刚刚指定的cold限定符:
@Autowired
@Qualifier("cold")
public void setDessert(Dessert dessert) {
this.dessert = dessert;
}
运行测试代码,输入结果如下所示:
冰激凌
此时将IceCream类重命名为Gelato,代码可以正常运行,不会受影响。
然后有一天,某位开发又新建了类Popsicle,该类也使用了cold限定符:
package chapter03.ambiguity;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Component;
@Component
@Qualifier("cold")
public class Popsicle implements Dessert {
@Override
public void showName() {
System.out.println("棒冰");
}
}
此时又带来了新的歧义性问题,因为Spring又不知道该如何选择了,运行代码会抛出org.springframework.beans.factory.NoUniqueBeanDefinitionException
异常,如下所示:
此时,我们就需要用到自定义的限定符了。
3.3 自定义的限定符注解
首先,我们新建以下3个注解:
package chapter03.ambiguity;
import org.springframework.beans.factory.annotation.Qualifier;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Cold {
}
package chapter03.ambiguity;
import org.springframework.beans.factory.annotation.Qualifier;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Creamy {
}
package chapter03.ambiguity;
import org.springframework.beans.factory.annotation.Qualifier;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Fruity {
}
注意事项:这3个注解在定义时都添加了@Qualifier注解,因此它们具有了@Qualifier注解的特性
然后将IceCream类修改为:
package chapter03.ambiguity;
import org.springframework.stereotype.Component;
@Component
@Cold
@Creamy
public class IceCream implements Dessert {
@Override
public void showName() {
System.out.println("冰激凌");
}
}
将Popsicle类修改为:
package chapter03.ambiguity;
import org.springframework.stereotype.Component;
@Component
@Cold
@Fruity
public class Popsicle implements Dessert {
@Override
public void showName() {
System.out.println("棒冰");
}
}
最后,修改下注入地方的代码,使其只能匹配到1个满足条件的bean,如下所示:
@Autowired
@Cold
@Creamy
public void setDessert(Dessert dessert) {
this.dessert = dessert;
}
运行测试代码,输出结果如下所示:
冰激凌
由此,我们也可以发现,自定义注解与@Qualifier注解相比,有以下2个优点:
- 可以同时使用多个自定义注解,但@Qualifier注解只能使用1个
- 使用自定义注解比@Qualifier注解更为类型安全
4. 源码及参考
源码地址:https://github.com/zwwhnly/spring-action.git,欢迎下载。
Craig Walls 《Spring实战(第4版)》
原创不易,如果觉得文章能学到东西的话,欢迎点个赞、评个论、关个注,这是我坚持写作的最大动力。
如果有兴趣,欢迎添加我的微信:zwwhnly,等你来聊技术、职场、工作等话题(PS:我是一名奋斗在上海的程序员)。
Spring入门(八):自动装配的歧义性的更多相关文章
- Spring实战之处理自动装配的歧义性
仅有一个bean匹配所需的结果时,自动装配才是有效的.如果不仅有一个bean能够匹配结果的话,这种歧义性会阻碍Spring自动装配属性.构造器参数或方法参数.为了阐述自动装配的歧义性,假设我们使用@A ...
- spring装配---处理自动装配的歧义性
一.歧义性 当我们使用spring的注解进行自动装配bean时,如果不仅有一个bean能够匹配结果的话,会抛出NoUniqueBeanDefinitionException: 例如本例中 当sprin ...
- spring学习总结——高级装配学习二(处理自动装配的歧义性)
我们已经看到如何使用自动装配让Spring完全负责将bean引用注入到构造参数和属性中.自动装配能够提供很大的帮助.不过,spring容器中仅有一个bean匹配所需的结果时,自动装配才是有效的.如果不 ...
- Spring实战(六)自动装配的歧义性
1.Spring进行自动装配时碰到的bean歧义性问题. 在进行自动装配时,只有仅有一个bean匹配所需结果时,才是可行的. 如果不仅仅一个bean能够匹配结果,例如一个接口有多个实现,这种歧义性会阻 ...
- Spring-处理自动装配的歧义性
自动装配可以对依赖注入提供很大帮助,因为它会减少装配应用程序组件时所需的显式装配的数量. 不过,仅有一个bean匹配所需的结果时,自动装配才是有效的.如果不仅有一个bean能够匹配的话,这种歧义性会阻 ...
- SpringInAction--Bean自动装配的歧义性处理
在前面,学习如何装配Bean的时候,或许会发现,有的同类型的Bean智能配置一个 如下: package com.bean.java; import org.springframework.conte ...
- Spring处理自动装配的歧义性
1.标识首选的bean 2.使用限定符@Qualifier 首先在bean的声明上添加@Qualifier 注解: @Component @Qualifier("cdtest") ...
- Spring(六)之自动装配
一.自动装配模型 下面是自动连接模式,可以用来指示Spring容器使用自动连接进行依赖注入.您可以使用元素的autowire属性为bean定义指定autowire模式. 可以使用 byType 或者 ...
- Spring 由构造函数自动装配
Spring 由构造函数自动装配,这种模式与 byType 非常相似,但它应用于构造器参数. Spring 容器看作 beans,在 XML 配置文件中 beans 的 autowire 属性设置为 ...
随机推荐
- 谷歌地球 Google Earth v7.3.2.5495 专业版
谷歌地球(Google Earth,GE)是一款谷歌公司开发的虚拟地球软件,它把卫星照片.航空照相和GIS布置在一个地球的三维模型上.谷歌地球于2005年向全球推出,被<PC 世界杂志>评 ...
- Asp.Net url参数加密存在特殊符号处理方法
Url出现了有+,空格,/,?,%,#,&,=等特殊符号的时候,服务器端无法获得正确的参数值,解决办法. 使用System.Web.HttpUtility.UrlEncode()方法将这些字符 ...
- android_viewFlipper(一)
需要注意的地方已在代码中表明 package cn.com.sxp; import android.app.Activity; import android.os.Bundle; import and ...
- mybatis学习(五)(动态mybatis(多条件查询))
有时候要查询条件是多条件的,尤其是使用mybatis的时候如何创建sql语句呢? 这里mybatis有自己的办法,如下: 案例:通过传入map,根据map里面的数据来查询 mapper配置如下: &l ...
- python基本用法
PYTHONPATH PYTHONPATH是python moudle的搜索路径.即import xxx会从$PYTHONPATH寻找xxx. 中文编码问题 #coding=utf-8 查看导入的包的 ...
- 微信小程序生成随机数
const charts = ['0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F','G','H','I','J','K', ...
- spring配置文件比较全的约束
个人总结:Spring的配置文件applicationContext.xml约束文件.全面约束 <?xml version="1.0" encoding="utf- ...
- [virtualenvwrapper] 命令小结
创建环境 mkvirtualenv env1 mkvirtualenv env2 环境创建之后,会自动进入该目录,并激活该环境. 切换环境 workon env1 workon env2 列出已有环境 ...
- Docker 工作原理及容器化简易指南
Docker 非常棒! 它使软件开发者无需担心配置和依赖性,在任何地方打包,发送和运行他们的应用程序.而在与 Kubernetes 相结合后,它使应用集群部署和管理变得更方便.这使得 Docker 深 ...
- 如何启用linux的路由转发功能
如何使用iptables的NAT功能把红帽企业版Linux作为一台路由器使用? 方法: 提示: 以下方法只适用于红帽企业版Linux 3 以上. 1.打开包转发功能: echo "1&quo ...