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

简介: 《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的处理顺序。

相关文章
|
7天前
|
Java API 数据安全/隐私保护
掌握Spring Boot中的@Validated注解
【4月更文挑战第23天】在 Spring Boot 开发中,@Validated 注解是用于开启和利用 Spring 的验证框架的一种方式,特别是在处理控制层的输入验证时。本篇技术博客将详细介绍 @Validated 注解的概念和使用方法,并通过实际的应用示例来展示如何在项目中实现有效的数据验证
26 3
|
7天前
|
前端开发 Java 开发者
深入理解Spring Boot中的@Service注解
【4月更文挑战第22天】在 Spring Boot 应用开发中,@Service 注解扮演着特定的角色,主要用于标识服务层组件。本篇技术博客将全面探讨 @Service 注解的概念,并提供实际的应用示例,帮助开发者理解如何有效地使用这一注解来优化应用的服务层架构
120 1
|
7天前
|
Java 开发者 Spring
深入理解Spring Boot的@ComponentScan注解
【4月更文挑战第22天】在构建 Spring Boot 应用时,@ComponentScan 是一个不可或缺的工具,它使得组件发现变得自动化和高效。这篇博客将详细介绍 @ComponentScan 的基本概念、关键属性及其在实际开发中的应用。
33 4
|
7天前
|
Java 开发者 Spring
深入理解 Spring Boot 中的 @EnableAutoConfiguration 注解:概念与实践
【4月更文挑战第21天】在 Spring Boot 项目中,@EnableAutoConfiguration 注解是实现自动配置的核心,它可以根据项目的依赖和配置,自动地配置 Spring 应用程序中的 Bean
37 3
|
7天前
|
缓存 Java Sentinel
Springboot 中使用 Redisson+AOP+自定义注解 实现访问限流与黑名单拦截
Springboot 中使用 Redisson+AOP+自定义注解 实现访问限流与黑名单拦截
|
7天前
|
运维 Java 程序员
Spring5深入浅出篇:基于注解实现的AOP
# Spring5 AOP 深入理解:注解实现 本文介绍了基于注解的AOP编程步骤,包括原始对象、额外功能、切点和组装切面。步骤1-3旨在构建切面,与传统AOP相似。示例代码展示了如何使用`@Around`定义切面和执行逻辑。配置中,通过`@Aspect`和`@Around`注解定义切点,并在Spring配置中启用AOP自动代理。 进一步讨论了切点复用,避免重复代码以提高代码维护性。通过`@Pointcut`定义通用切点表达式,然后在多个通知中引用。此外,解释了AOP底层实现的两种动态代理方式:JDK动态代理和Cglib字节码增强,默认使用JDK,可通过配置切换到Cglib
|
5天前
|
Java
Springboot 使用自定义注解结合AOP方式校验接口参数
Springboot 使用自定义注解结合AOP方式校验接口参数
Springboot 使用自定义注解结合AOP方式校验接口参数
|
6天前
|
存储 缓存 Java
【JavaEE】Spring中注解的方式去获取Bean对象
【JavaEE】Spring中注解的方式去获取Bean对象
3 0
|
6天前
|
存储 Java 对象存储
【JavaEE】Spring中注解的方式去存储Bean对象
【JavaEE】Spring中注解的方式去存储Bean对象
9 0
|
7天前
|
JSON 前端开发 Java
【JAVA进阶篇教学】第七篇:Spring中常用注解
【JAVA进阶篇教学】第七篇:Spring中常用注解