SpringBoot @ConditionalOnBean、@ConditionalOnMissingBean注解源码分析与示例

时间:2024-11-07 09:01:45

前言:

Spring4推出了@Conditional注解,方便程序根据当前环境或者容器情况来动态注入bean,对@Conditional注解不熟悉的朋友可移步至 Spring @Conditional注解 详细讲解及示例 这篇博客进行学习。

继@Conditional注解后,又基于此注解推出了很多派生注解,比如@ConditionalOnBean、@ConditionalOnMissingBean、@ConditionalOnExpression、@ConditionalOnClass......动态注入bean变得更方便了。本篇将讲解@ConditionalOnBean注解。

配置类中有两个Computer类的bean,一个是笔记本电脑,一个是备用电脑。如果当前容器中已经有电脑bean了,就不注入备用电脑,如果没有,则注入备用电脑,这里需要使用到@ConditionalOnMissingBean。

@Configuration
public class BeanConfig {

    @Bean(name = "notebookPC")
    public Computer computer1(){
        return new Computer("笔记本电脑");
    }

    @ConditionalOnMissingBean()
    @Bean("reservePC")
    public Computer computer2(){
        return new Computer("备用电脑");
    }
}

这个注解就实现了功能,这个@ConditionalOnMissingBean为我们做了什么呢?我们来一探究竟.。

一探究竟:

首先,来看@ConditionalOnMissingBean的声明:

//可以标注在类和方法上
@Target({, })
@Retention()
@Documented
//使用了@Conditional注解,条件类是OnBeanCondition
@Conditional({})
public @interface ConditionalOnMissingBean {
    Class<?>[] value() default {};

    String[] type() default {};

    Class<?>[] ignored() default {};

    String[] ignoredType() default {};

    Class<? extends Annotation>[] annotation() default {};

    String[] name() default {};

    SearchStrategy search() default ;
}

这时候,我们就看到了我们熟悉的@Conditional注解,OnBeanCondition作为条件类。

OnBeanCondition类的声明:

//定义带注释的组件的排序顺序,2147483647即为默认值
@Order(2147483647)
class OnBeanCondition extends SpringBootCondition implements ConfigurationCondition {

它继承了SpringBootCondition类,OnBeanCondition类中没有matches方法,而SpringBootCondition类中有实现matches方法。OnBeanCondition还实现了ConfigurationCondition,ConfigurationCondition接口不熟悉的读者可以到Spring ConfigurationCondition接口详解 了解接口。OnBeanCondition类重写了getConfigurationPhase()方法,表示在注册bean的时候注解生效:

    public ConfigurationPhase getConfigurationPhase() {
        return ConfigurationPhase.REGISTER_BEAN;
    }

就从matches方法开始:

    //SpringBootCondition类中的matches方法
    public final boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        //获取当前的类名或者方法名(由标注的位置决定)
        String classOrMethodName = getClassOrMethodName(metadata);

        try {
            //关键代码:这里就会判断出结果
            ConditionOutcome outcome = (context, metadata);
            //存入日志
            (classOrMethodName, outcome);
            //存入记录
            (context, classOrMethodName, outcome);
            //最后返回ConditionOutcome的isMatch就是返回boolean类型结果
            return ();
        } catch (NoClassDefFoundError var5) {
            throw new IllegalStateException("Could not evaluate condition on " + classOrMethodName + " due to " + () + " not found. Make sure your own configuration does not rely on that class. This can also happen if you are @ComponentScanning a springframework package (. if you put a @ComponentScan in the default package by mistake)", var5);
        } catch (RuntimeException var6) {
            throw new IllegalStateException("Error processing condition on " + (metadata), var6);
        }
    }

关键代码在OnBeanCondition的getMatchOutcome方法上:

    /**
     * 获得判断结果的方法,ConditionOutcome类中存着boolean类型的结果
     */
    public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) {
	//返回一个新的ConditionMessage
        ConditionMessage matchMessage = ();
         spec;
        List matching;
        //这是metadata会调用isAnnotated方法判断当前标注的注解是不是ConditionalOnMissingBean
	//其实@ConditionalOnBean、@ConditionalOnMissingBean和@ConditionalOnSingleCandidate都是使用这个条件类,所以这里做判断
        if ((())) {
            spec = new (context, metadata, );
            matching = (context, spec);
            if (()) {
                return ((, new Object[]{spec}).didNotFind("any beans").atAll());
            }

            matchMessage = (, new Object[]{spec}).found("bean", "beans").items(, matching);
        }

        if ((())) {
             spec = new (context, metadata, );
            matching = (context, spec);
            if (()) {
                return ((, new Object[]{spec}).didNotFind("any beans").atAll());
            }

            if (!((), matching, () == )) {
                return ((, new Object[]{spec}).didNotFind("a primary bean from beans").items(, matching));
            }

            matchMessage = (, new Object[]{spec}).found("a primary bean from beans").items(, matching);
        }

        //如果当前注入的bean是@ConditionalOnMissingBean
        if ((())) {
            //返回一个spec(说明),这里的spec规定了搜索的内容,比如搜索策略、需要搜索的类名......
            spec = new (context, metadata, );
            //主要的搜索实现在这个方法里,最后返回一个list
            matching = (context, spec);
            //判断搜索出来的结果
            if (!()) {
                return ((, new Object[]{spec}).found("bean", "beans").items(, matching));
            }

            matchMessage = (, new Object[]{spec}).didNotFind("any beans").atAll();
        }

        return (matchMessage);
    }

spec = new (context, metadata, );

这句中,相当于从内部类中将标注@ConditionalOnMissingBean注解时的属性都取出来:

        BeanSearchSpec(ConditionContext context, AnnotatedTypeMetadata metadata, Class<?> annotationType) {
             = annotationType;
            MultiValueMap<String, Object> attributes = ((), true);
            //将attributes这个map中的数据放到对应的list成员变量中
            (attributes, "name", );
            (attributes, "value", );
            (attributes, "type", );
            (attributes, "annotation", );
            (attributes, "ignored", );
            (attributes, "ignoredType", );
             = (SearchStrategy)(()).get("search");
             deductionException = null;

            try {
                if (() && ()) {
                    (context, metadata, );
                }
            } catch ( var7) {
                deductionException = var7;
            }

            (deductionException);
        }

        //验证的方法
        protected void validate( ex) {
            if (!(, , )) {
                String message = () + " did not specify a bean using type, name or annotation";
                if (ex == null) {
                    throw new IllegalStateException(message);
                } else {
                    throw new IllegalStateException(message + " and the attempt to deduce the bean's type failed", ex);
                }
            }
        }

看一下OnBeanCondition类中的getMatchingBeans方法,里面有用到搜索策略,详见搜索策略介绍

    private List<String> getMatchingBeans(ConditionContext context,  beans) {
        //获得当前bean工厂
        ConfigurableListableBeanFactory beanFactory = ();
        //判断当前的搜索策略是否是PARENTS或者ANCESTORS,默认是ALL
        if (() ==  || () == ) {
            BeanFactory parent = ();
            (, parent, "Unable to use ");
            //如果是PARENTS或者ANCESTORS,当前bean工厂就用父工厂
            beanFactory = (ConfigurableListableBeanFactory)parent;
        }

        if (beanFactory == null) {
            return ();
        } else {
            List<String> beanNames = new ArrayList();
            //如果当前搜索策略等于CURRENT,为true
            boolean considerHierarchy = () != ;
            //这里的type就是需要查找的bean的类型
            //下面,会从属性中找bean
            Iterator var6 = ().iterator();

            String beanName;
            while(()) {
                beanName = (String)();
                //如果找到了类型,接下来就是根据类型找bean的实例名,找示例名的方法在下方,实际上就是一个getNamesForType
                ((beanFactory, beanName, (), considerHierarchy));
            }

            var6 = ().iterator();

            while(()) {
                beanName = (String)();
                ((beanFactory, beanName, (), considerHierarchy));
            }

            var6 = ().iterator();

            while(()) {
                beanName = (String)();
                (((beanFactory, beanName, (), considerHierarchy)));
            }

            var6 = ().iterator();

            while(()) {
                beanName = (String)();
                if ((beanFactory, beanName, considerHierarchy)) {
                    (beanName);
                }
            }
            //将存放bean实例名的list返回
            return beanNames;
        }
    }



    //根据类型获取bean的name
    private Collection<String> getBeanNamesForType(ListableBeanFactory beanFactory, String type, ClassLoader classLoader, boolean considerHierarchy) throws LinkageError {
        try {
            Set<String> result = new LinkedHashSet();
            (result, beanFactory, (type, classLoader), considerHierarchy);
            return result;
        } catch (ClassNotFoundException var6) {
            return ();
        } catch (NoClassDefFoundError var7) {
            return ();
        }
    }

    private void collectBeanNamesForType(Set<String> result, ListableBeanFactory beanFactory, Class<?> type, boolean considerHierarchy) {
        ((beanFactory).getNamesForType(type));
        if (considerHierarchy && beanFactory instanceof HierarchicalBeanFactory) {
            BeanFactory parent = ((HierarchicalBeanFactory)beanFactory).getParentBeanFactory();
            if (parent instanceof ListableBeanFactory) {
                (result, (ListableBeanFactory)parent, type, considerHierarchy);
            }
        }

    }

找完bean了之后,回到刚才的代码里:

        //如果当前注入的bean是@ConditionalOnMissingBean
        if ((())) {
            //返回一个spec(说明),这里的spec规定了搜索的内容,比如搜索策略、需要搜索的类名......
            spec = new (context, metadata, );
            matching = (context, spec);
            if (!()) {
                return ((, new Object[]{spec}).found("bean", "beans").items(, matching));
            }

            matchMessage = (, new Object[]{spec}).didNotFind("any beans").atAll();
        }

如果第5行返回的list不是空的,就会返回ConditionOutcome对象noMatch方法,表示不匹配。ConditionOutcome类用于存放过滤结果,只有两个变量:

/**
 * 过滤结果类
 */
public class ConditionOutcome {
	/**
	 * 匹配结果 true or false
	 */
    private final boolean match;
	/**
	 * 匹配结果信息
	 */
    private final ConditionMessage message;

两者区别:

@ConditionOnBean在判断list的时候,如果list没有值,返回false,否则返回true

@ConditionOnMissingBean在判断list的时候,如果list没有值,返回true,否则返回false,其他逻辑都一样

例子:

  • @ConditionalOnBean()    
    Spring容器或者所有父容器中需要存在至少一个类的实例