专栏首页路人甲JavaSpring系列第11篇:bean中的autowire-candidate又是干什么的?

Spring系列第11篇:bean中的autowire-candidate又是干什么的?

autowire-candidate做什么事情的?

上一篇文章Spring系列第10篇:primary可以解决什么问题?中遇到的问题我们再来回顾一下,当容器中某种类型的bean存在多个的时候,此时如果我们从容器中查找这种类型的bean的时候,会报下面这个异常:

org.springframework.beans.factory.NoUniqueBeanDefinitionException

原因:当从容器中按照类型查找一个bean对象的时候,容器中却找到了多个匹配的bean,此时spring不知道如何选择了,处于懵逼状态,就会报这个异常。

这种异常主要出现在2种场景中:

场景1:

从容器容器中查找符合指定类型的bean,对应BeanFactory下面的方法:

<T> T getBean(Class<T> requiredType) throws BeansException;

场景2:

自动注入方式设置为byType的时候,如下:

package com.javacode2018.lesson001.demo8;

public class SetterBean {
    public interface IService{} //@1
    public static class ServiceA implements IService{} //@2
    public static class ServiceB implements IService{} //@3

    private IService service;

    public void setService(IService service) {
        this.service = service;
    }
}
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-4.3.xsd">

    <bean id="serviceA" class="com.javacode2018.lesson001.demo8.SetterBean$ServiceA"/>
    <bean id="serviceB" class="com.javacode2018.lesson001.demo8.SetterBean$ServiceB"/>

    <bean id="setterBean" class="com.javacode2018.lesson001.demo8.SetterBean" autowire="byType" />
</beans>

setterBean的autowire设置的是byType,即按setter方法的参数类型自动注入,SetterBean的setService的类型是IService,而IService类有2个实现类:ServiceA和ServiceB,而容器容器中刚好有这2个实现类的bean:serviceA和serviceB,所以上面代码会报错,不知道注入的时候选择那个对象注入。

我们可以通过primary属性来指定一个主要的bean,当从容器中查找的时候,如果有多个候选的bean符合查找的类型,此时容器将返回primary="true"的bean对象。

spring还有一种方法也可以解决这个问题,可以设置某个bean是否在自动注入的时候是否为作为候选bean,通过bean元素的autowire-candidate属性类配置,如下:

<bean id="serviceA" class="com.javacode2018.lesson001.demo8.SetterBean$ServiceA" autowire-candidate="false"/>

autowire-candidate:设置当前bean在被其他对象作为自动注入对象的时候,是否作为候选bean,默认值是true。

来举例说明一下,以上面的setter注入的案例先来说一下注入的过程:

容器在创建setterBean的时候,发现其autowire为byType,即按类型自动注入,此时会在SetterBean类中查找所有setter方法列表,其中就包含了setService方法,setService方法参数类型是IService,然后就会去容器中按照IService类型查找所有符合条件的bean列表,此时容器中会返回满足IService这种类型并且autowire-candidate="true"的bean,刚才有说过bean元素的autowire-candidate的默认值是true,所以容器中符合条件的候选bean有2个:serviceA和serviceB,setService方法只需要一个满足条件的bean,此时会再去看这个列表中是否只有一个主要的bean(即bean元素的primary=“ture”的bean),而bean元素的primary默认值都是false,所以没有primary为true的bean,此时spring容器懵了,不知道选哪个了,此时就报错了,抛出NoUniqueBeanDefinitionException异常

从上面过程中可以看出将某个候选bean的primary置为true就可以解决问题了。

或者只保留一个bean的autowire-candidate为true,将其余的满足条件的bean的autowire-candidate置为false,此时也可以解决这个问题,下面我们使用autowire-candidate来解决上面问题看一下效果:

SetterBean.java

package com.javacode2018.lesson001.demo9;

public class SetterBean {
    public interface IService {} //@1

    public static class ServiceA implements IService {} //@2

    public static class ServiceB implements IService {} //@3

    private IService service;

    public void setService(IService service) {
        this.service = service;
    }

    @Override
    public String toString() {
        return "SetterBean{" +
                "service=" + service +
                '}';
    }
}

autowireCandidateBean.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-4.3.xsd">

    <bean id="serviceA" class="com.javacode2018.lesson001.demo9.SetterBean$ServiceA" autowire-candidate="false"/>
    <bean id="serviceB" class="com.javacode2018.lesson001.demo9.SetterBean$ServiceB"/>

    <bean id="setterBean" class="com.javacode2018.lesson001.demo9.SetterBean" autowire="byType" />
</beans>

上面我们将serviceA的autowire-candidate置为false了,serviceA在被其他bean自动按照类型注入的时候,将不再放入候选名单中

测试用例

package com.javacode2018.lesson001.demo9;

import com.javacode2018.lesson001.demo5.IocUtils;
import com.javacode2018.lesson001.demo8.NormalBean;
import com.javacode2018.lesson001.demo8.PrimaryBean;
import org.junit.Test;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import java.util.Arrays;
import java.util.Map;

/**
 * 公众号:路人甲Java,工作10年的前阿里P7分享Java、算法、数据库方面的技术干货!坚信用技术改变命运,让家人过上更体面的生活!
 * bean元素的autowire-candidate可以设置当前bean是否作为其他bean自动注入的候选bean
 */
public class AutowireCandidateTest {

    @Test
    public void setterBean() {
        String beanXml = "classpath:/com/javacode2018/lesson001/demo9/autowireCandidateBean.xml";
        ClassPathXmlApplicationContext context = IocUtils.context(beanXml);
        System.out.println(context.getBean(SetterBean.class)); //@1

        SetterBean.IService service = context.getBean(SetterBean.IService.class); //@2
        System.out.println(service);
    }

}

@1:查找容器中SetterBean类型的bean对象

@2:查找容器中SetterBean.IService接口类型的bean,实际上面容器中serviceA和serviceB都是这种类型的

下面我们运行一下,看看输出:

SetterBean{service=com.javacode2018.lesson001.demo9.SetterBean$ServiceB@29176cc1}
com.javacode2018.lesson001.demo9.SetterBean$ServiceB@29176cc1

注意一下输出,2行输出中都是ServiceB,因为serviceB的autowire-candidate是默认值true,自动注入的时候作为候选bean,而serviceA的autowire-candidate是false,自动注入的时候不作为候选bean,所以上面输出的都是serviceB。

autowire-candidates属性解析源码

beans元素是xml中定义bean的根元素,beans元素有个default-autowire-candidates属性,用于定义哪些bean可以作为候选者,default-autowire-candidates的值是个通配符如:

default-autowire-candidates="*Service"

再来说一下bean元素的autowire-candidate属性,这个属性有3个可选值:

  • default:这个是默认值,autowire-candidate如果不设置,其值就是default
  • true:作为候选者
  • false:不作为候选者

spring中由beans元素的default-autowire-candidates和bean元素的autowire-candidate来决定最终bean元素autowire-candidate的值,我们来看一下bean元素autowire-candidates的解析源码:

源码位置:org.springframework.beans.factory.xml.BeanDefinitionParserDelegate#parseBeanDefinitionAttributes

主要代码如下:

//获取bean元素的autowire-candidate元素,autowire-candidate如果不设置,其值就是default
String autowireCandidate = ele.getAttribute(AUTOWIRE_CANDIDATE_ATTRIBUTE);
//判断bean元素的autowire-candidate元素是否等于"default"或者是否等于""
if (isDefaultValue(autowireCandidate)) { 
    //获取beans元素default-autowire-candidates属性值
    String candidatePattern = this.defaults.getAutowireCandidates();
    //判断获取beans元素default-autowire-candidates属性值是否为空,default-autowire-candidates默认值就是null
    if (candidatePattern != null) {
        //判断bean的名称是否和default-autowire-candidates的值匹配,如果匹配就将bean的autowireCandidate置为true,否则置为false
        String[] patterns = StringUtils.commaDelimitedListToStringArray(candidatePattern);
        bd.setAutowireCandidate(PatternMatchUtils.simpleMatch(patterns, beanName));
    }
}else {
    //判断bean的autowire-candidate的值是否等于"true"
    bd.setAutowireCandidate(TRUE_VALUE.equals(autowireCandidate));
}

如果上面判断都没有进去,autowireCandidate属性默认值就是true,这个在下面定义的:

org.springframework.beans.factory.support.AbstractBeanDefinition#autowireCandidate

private boolean autowireCandidate = true;

所有的bean元素最后都会被解析为spring中的org.springframework.beans.factory.config.BeanDefinition对象,关于BeanDefinition以后我们会细说

问题

对上面的案例做个扩展,SetterBean类中加个方法:

public void setService1(List<IService> service) {//@0
    System.out.println(service); //@1
}

@0:需要注入一个IService的集合,判断一下@1输出的是容器中的serviceA,还是serviceB,还是2个都有呢?为什么?

案例源码

链接:https://pan.baidu.com/s/1p6rcfKOeWQIVkuhVybzZmQ 
提取码:zr99

本文分享自微信公众号 - 路人甲Java(javacode2018),作者:路人甲Java

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-02-21

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 终于,月薪过5万了!

    本文主要详解bean的生命周期,分为13个环节,每个环节中spring都提供了一些扩展点,我们都将进行详细说明,让大家全面掌握这块的知识。

    路人甲Java
  • Spring系列第4篇:xml中bean定义详解(-)

    我们再来回顾一下,被spring管理的对象统称为bean,我们程序中需要用到很多对象,我们将这些对象让spring去帮我们创建和管理,我们可以通过bean xm...

    路人甲Java
  • Spring系列第9篇:depend-on到底是干什么的?

    本文主要讨论一下bean的创建和销毁的顺序,如何来干预bean的创建和销毁的顺序。

    路人甲Java
  • spring之自动装配的三种方式

    springIOC容器可以自动装配Bean,需要做的仅仅是在<bean>中的autowire属性里指定自动装配的方式。

    绝命生
  • Spring面试基本问题(1)

    Spring框架是一个为Java应用程序的开发提供了综合、广泛的基础性支持的Java平台。Spring帮助开发者解决了开发中基础性的问题,使得开发人员可以专注于...

    yaohong
  • 有人说现在阿里和腾讯两头独大,对此你怎么看?

    从国内互联网公司的市值看,阿里和腾讯的确是独自占据一个档,两个巨无霸你追我赶的两个巨头加起来几乎占据了互联网的全部,曾经的bat现在变成了at之间的游戏了,两家...

    程序员互动联盟
  • 句子成分(主干部分)

    白胡杨同学
  • RS(2)--从文本数据到用户画像

    用户画像其实就是从海量的用户数据中,建模抽象出来每个用户的属性标签体系,这些属性通常需要具有一定的商业价值。

    材ccc
  • 持续打击“养号” 腾讯QQ对互联网黑色产业链挥出重拳

    腾讯科技讯 近年来,越来越多的不法分子通过非法买卖社交平台帐号来进行网络诈骗等违法违规行为。以QQ为例,号商们通过非法盗号、违规购买、收购大量非实名手机卡等方式...

    用户6966869
  • 英伟达推出LaneNet DNN模型,可以高精度检测道路标识和地标

    车道和道路边缘检测对于自动驾驶汽车的开发至关重要,车道检测为诸如车道偏离警告之类的系统提供动力,可帮助驾驶员避免偏离车道。除了检测车道线信息外,自动驾驶汽车还需...

    AiTechYun

扫码关注云+社区

领取腾讯云代金券