《SpringBoot系列十四》：@ConditionalOnBean、@ConditionalOnMissingBean注解居然失效了

心已赠人 2023-09-29 15:51 10阅读 0赞

#### 文章目录 ####

*  一、前言
 *  二、@ConditionalOnMissingBean失效场景复现
 *  三、@ConditionalOnMissingBean失效原因分析
 *   *  解决方案：
 *  四、总结

## 一、前言 ##

在上一篇博文（[《SpringBoot系列十三》：图文精讲@Conditional条件装配实现原理][SpringBoot_Conditional]）中我们讨论了@Conditional条件装配的原理。其中会牵扯到各个bean加载到Spring临时容器`beanDefinitionNames`和`manualSingletonNames`的顺序，如果对顺序的控制不当会导致@ConditionalOnBean、@ConditionalOnMissingBean注解失效。

条件装配的其他文章如下：

> 1.  [《SpringBoot系列十一》：精讲如何使用@Conditional系列注解做条件装配][SpringBoot_Conditional 1]
> 2.  [《SpringBoot系列十二》：如何自定义条件装配（由@ConditionalOnClass推导）][SpringBoot_ConditionalOnClass]
> 3.  [《SpringBoot启动流程六》：SpringBoot自动装配时做条件装配的原理（万字图文源码分析）（含@ConditionalOnClass原理）][SpringBoot_SpringBoot_ConditionalOnClass]

## 二、@ConditionalOnMissingBean失效场景复现 ##

![在这里插入图片描述][86de086254044c1c984f377a1de43f61.png]

**1> 一个被`@Component`注解和`@ConditionalOnMissingBean(ClassC.class)`注解标注的ClassA：**

package com.saint;
    
    import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
    import org.springframework.stereotype.Component;
    
    /**
     * @author Saint
     */
    @Component
    @ConditionalOnMissingBean(ClassC.class)
    public class ClassA {
        
    
        public ClassA() {
        
            System.out.println("初始化了ClassA!");
        }
    }

**2> 一个被`@Configuration`注解标注，其中有一个@Bean方法的ClassB：**

package com.saint;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    /**
     * @author Saint
     */
    @Configuration
    public class ClassB {
        
    
        public ClassB() {
        
            System.out.println("初始化了ClassB!!!");
        }
    
        @Bean
        public ClassC getClassC() {
        
            return new ClassC();
        }
    }

**3> 普通的ClassC对象：**

package com.saint;
    
    /**
     * @author Saint
     */
    public class ClassC {
        
        public ClassC() {
        
            System.out.println("初始化了ClassC!!");
        }
    }

**期望的效果：**

*  如果没有人注册了类型为ClassC的bean对象，就往Spring容器里注册一个类型为ClassA的bean对象；
 *  而ClassB对象中通过@Bean方法向Spring容器中注册了类型为ClassC的bean对象；
 *  按照正常的逻辑，并不会向Spring容器中注册ClassA对象。

![在这里插入图片描述][e6466b6873c54811bd6aeac2c02e7b3d.png]  
**实际效果：**

*  从控制台的输出来看，实际上ClassA对象被注册到了Spring容器中；

## 三、@ConditionalOnMissingBean失效原因分析 ##

结合我们对@ConditionalOnMissingBean的理解，很容易得到表面结论：在解析ClassA中的`@ConditionalOnMissingBean(ClassC.class)`注解时，ClassC还没有注册到Spring 容器中。

为什么会这样呢？

我们结合Spring Boot对ConfigurationClass配置类的处理过程来看一下，在博文（[《SpringBoot系列十三》：图文精讲@Conditional条件装配实现原理][SpringBoot_Conditional]）中我们聊过：SpringBoot对配置类的处理分为两个阶段：配置类解析 和 Bean注册。  
![在这里插入图片描述][da7b802a85374defb8936c42886f49da.png]  
在配置类解析阶段会将所有被@Component衍生注解标注的类全部添加到Spring临时容器`beanDefinitionNames`和`manualSingletonNames`中，而其他的配置类（@Import、@Bean等导入的类）在此阶段完成后会临时存放在`ConfigurationClassParser`对象的`configurationClasses`映射（Map<ConfigurationClass, ConfigurationClass>）中，在Bean注册阶段才会把映射里所有的ConfigurationClass转为BeanDefinition注册到BeanFactory的String集合类型的beanDefinitionNames成员中。如下代码块所示：  
![在这里插入图片描述][4a6bdd76b9db4b8285db50284debd224.png]  
变量`configClasses` 的数据结构是 `LinkedHashSet`，所以其排序规则就是先来的放前面。  
![在这里插入图片描述][044af8f9707c4757a07cf130920d9c72.png]

>  *  所以在配置类解析阶段，ClassA已经放入到了Spring的临时容器`beanDefinitionNames`和`configurationClasses`映射中，ClassB放入到了`configurationClasses`映射中，ClassC还没有被解析出来。
>  *  在配置类注册阶段，根据类所在包中的顺序，重新先将ClassA再次根据条件装配结果注入到Spring的临时容器`beanDefinitionNames`，然后才将ClassB注入到Spring的临时容器，再解析ClassB中的ClassC，并将其注入到Spring容器。

从上图可以看出，`用户自定义的类` 排在 `EnableAutoConfiguration自动配置加载的类` 的前面；

> 1.  `用户自定义的类`之间的顺序是按照文件的目录结构从上到下排序，并且无法干预， @Order，Order接口，@AutoConfigureBefore，@AutoConfigureAfter，AutoConfigureOrder 在这里都是无效的；
> 2.  `自动装配的类`之间 可以使用 @Order，Order接口，@AutoConfigureBefore，@AutoConfigureAfter，AutoConfigureOrder 五种方式去改变加载的顺序。

### 解决方案： ###

结合上述最后注册Bean阶段时，类的排序规则，我们可以将ClassA当做自动装配类，这样在注册bean阶段，ClassA的处理也就处于 `在ClassB中处理@Bean方法将ClassC注册到Spring容器中` 的处理之后，即ClassA中处理`@ConditionalOnMissingBean(ClassC.class)`注解时，ClassC对象已经处理完了。

**1> 修改ClassA类：**

package com.saint;
    
    import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
    import org.springframework.context.annotation.Configuration;
    
    /**
     * @author Saint
     */
    @Configuration
    @ConditionalOnMissingBean(ClassC.class)
    public class ClassA {
        
    
        public ClassA() {
        
            System.out.println("初始化了ClassA!");
        }
    }

**2> 增加自动装配配置：**  
![在这里插入图片描述][55402da710dc427182687d0c665a36ea.png]  
**3> 注册Bean阶段类的顺序如下：**  
![在这里插入图片描述][fe0c2297b83842f2aec86313f79ac5f7.png]  
**4> 程序运行结果：**  
![在这里插入图片描述][3b23e3ce3f534d1183ba79b7d188b4e9.png]

*  ClassA没有被注册到Spring容器中。

## 四、总结 ##

SpringBoot官网的JavaDoc强烈建议开发人员仅在自动装配中使用Bean Conditions条件注解。因为开发人员需要特别小心BeanDefinition的添加顺序，因为这些条件是依赖与迄今为止哪些bean已经被处理来评估的！  
![在这里插入图片描述][d4379880c96c4b16a8857297a140db36.png]

下一篇博文：我们详细讨论一下@Conditional条件装配时Condition的处理顺序。

[SpringBoot_Conditional]: https://blog.csdn.net/Saintmm/article/details/124872624
[SpringBoot_Conditional 1]: https://blog.csdn.net/Saintmm/article/details/124884831
[SpringBoot_ConditionalOnClass]: https://blog.csdn.net/Saintmm/article/details/124885010
[SpringBoot_SpringBoot_ConditionalOnClass]: https://blog.csdn.net/Saintmm/article/details/124838375
[86de086254044c1c984f377a1de43f61.png]: https://img-blog.csdnimg.cn/86de086254044c1c984f377a1de43f61.png
[e6466b6873c54811bd6aeac2c02e7b3d.png]: https://img-blog.csdnimg.cn/e6466b6873c54811bd6aeac2c02e7b3d.png
[da7b802a85374defb8936c42886f49da.png]: https://img-blog.csdnimg.cn/da7b802a85374defb8936c42886f49da.png
[4a6bdd76b9db4b8285db50284debd224.png]: https://img-blog.csdnimg.cn/4a6bdd76b9db4b8285db50284debd224.png
[044af8f9707c4757a07cf130920d9c72.png]: https://img-blog.csdnimg.cn/044af8f9707c4757a07cf130920d9c72.png
[55402da710dc427182687d0c665a36ea.png]: https://img-blog.csdnimg.cn/55402da710dc427182687d0c665a36ea.png
[fe0c2297b83842f2aec86313f79ac5f7.png]: https://img-blog.csdnimg.cn/fe0c2297b83842f2aec86313f79ac5f7.png
[3b23e3ce3f534d1183ba79b7d188b4e9.png]: https://img-blog.csdnimg.cn/3b23e3ce3f534d1183ba79b7d188b4e9.png
[d4379880c96c4b16a8857297a140db36.png]: https://img-blog.csdnimg.cn/d4379880c96c4b16a8857297a140db36.png