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

本文涉及的产品
全局流量管理 GTM,标准版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
云解析 DNS,旗舰版 1个月
简介: 《SpringBoot系列十四》:@ConditionalOnBean、@ConditionalOnMissingBean注解居然失效了

@[TOC]

一、前言

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

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

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

二、@ConditionalOnMissingBean失效场景复现

在这里插入图片描述

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对象。

在这里插入图片描述
实际效果:

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

三、@ConditionalOnMissingBean失效原因分析

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

为什么会这样呢?

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

  • 所以在配置类解析阶段,ClassA已经放入到了Spring的临时容器beanDefinitionNamesconfigurationClasses映射中,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> 增加自动装配配置:
在这里插入图片描述
3> 注册Bean阶段类的顺序如下:
在这里插入图片描述
4> 程序运行结果:
在这里插入图片描述

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

四、总结

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

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

相关文章
|
2月前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
56 0
|
9天前
|
Java Spring
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
136 73
|
3月前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
182 3
|
4天前
|
Java Spring 容器
【SpringFramework】Spring IoC-基于注解的实现
本文主要记录基于Spring注解实现IoC容器和DI相关知识。
36 21
|
9天前
|
存储 Java Spring
【Spring】获取Bean对象需要哪些注解
@Conntroller,@Service,@Repository,@Component,@Configuration,关于Bean对象的五个常用注解
|
9天前
|
Java Spring
【Spring配置】idea编码格式导致注解汉字无法保存
问题一:对于同一个项目,我们在使用idea的过程中,使用汉字注解完后,再打开该项目,汉字变成乱码问题二:本来a项目中,汉字注解调试好了,没有乱码了,但是创建出来的新的项目,写的注解又成乱码了。
|
2月前
|
前端开发 Java Spring
Spring MVC核心:深入理解@RequestMapping注解
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的核心,它将HTTP请求映射到控制器的处理方法上。本文将深入探讨`@RequestMapping`注解的各个方面,包括其注解的使用方法、如何与Spring MVC的其他组件协同工作,以及在实际开发中的应用案例。
47 4
|
2月前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
79 4
SpringBoot必须掌握的常用注解!
|
2月前
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
138 2
|
2月前
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
58 2