一文了解ConfigurationConditon接口

布满荆棘的人生 2021-06-22 15:36 491阅读 0赞

## ConfigurationCondition 接口说明 ##

### @Conditional 和 Condition ###

在了解ConfigurationCondition 接口之前，先通过一个示例来了解一下@Conditional 和 Condition。(你也可以通过 https://www.cnblogs.com/cxuanBlog/p/10960575.html 详细了解)

*  首先新建一个Maven项目(可以使用SpringBoot快速搭建)，添加Spring4.0 的pom.xml 依赖

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.5.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.cxuan.configuration</groupId>
        <artifactId>configuration-condition</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>configuration-condition</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
            <spring.version>4.3.13.RELEASE</spring.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>${spring.version}</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-beans</artifactId>
                <version>${spring.version}</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-core</artifactId>
                <version>${spring.version}</version>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

*  新建一个`IfBeanAExistsCondition` 类，该类继承了Condition接口，提供某些注册条件的逻辑

public class IfBeanAExistsCondition implements Condition {
    
        @Override
        public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
            boolean IfContainsbeanA = context.getBeanFactory().containsBeanDefinition("beanA");
            return IfContainsbeanA;
        }
    }

> Condition是一个接口，里面只有一个方法就是matches，上述表明如果ConditionContext的beanFactory包括名称为beanA的bean就返回true，否则返回false不进行注册。

*  为了测试Condition是否可用，我们新建一个`ConfigurationConditionApplication`类，注册两个Bean分别为BeanA和BeanB，BeanB的注册条件是BeanA首先进行注册，采用手动注册和刷新的方式。详见https://www.cnblogs.com/cxuanBlog/p/10958307.html，具体代码如下：

public class ConfigurationConditionApplication {
    
        private static void loadContextAndVerifyBeans(Class...classToRegistry){
            AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
            context.register(classToRegistry);
            context.refresh();
            System.out.println("Has BeanA? " + context.containsBean("beanA"));
            System.out.println("Has BeanB? " + context.containsBean("beanB"));
        }
    
    
        public static void main(String[] args) {
            loadContextAndVerifyBeans(BeanA.class);
            loadContextAndVerifyBeans(BeanA.class,BeanB.class);
            loadContextAndVerifyBeans(BeanB.class);
            loadContextAndVerifyBeans(BeanB.class,BeanA.class);
        }
    }
    
    @Configuration()
    class BeanA{}
    
    @Conditional(IfBeanAExistsCondition.class)
    @Configuration()
    class BeanB{}

输出结果：

...
    Has BeanA? true
    Has BeanB? false
    ...
    Has BeanA? true
    Has BeanB? true
    ...
    Has BeanA? false
    Has BeanB? false
    ...
    Has BeanA? true
    Has BeanB? false

来解释一下上面的输出结果，第一次只注册了一个BeanA的bean，@Configuration标注的BeanA默认注册的definitionName为beanA，首字母小写。

第二次同时传入了BeanA.class 和 BeanB.class, 由于BeanB的注解上标明@Conditional(IfBeanAExistsCondition.class)表示的是注册BeanA之后才会注册BeanB，所以注册了beanA，因为beanA被注册了，所以同时也就注册了beanB。

第三次只传入了BeanB.class，因为没有注册BeanA和BeanB，所以两次输出都是false。

第四次先传入了BeanB.class，后又传入了BeanA.class，根据加载顺序来看，BeanB.class 首先被加载，然后是BeanA.class 被加载，BeanB被加载的时候BeanA.class 还没有被注入，之后BeanA才会注入，所以输出的结果是true和false。

> 上述例子可以把BeanA和BeanB类放入ConfigurationConditionApplication中，类似
> 
>     public class ConfigurationConditionApplication {
>        
>     @Configuration()
>     static class BeanA{}
>     
>     @Conditional(IfBeanAExistsCondition.class)
>     @Configuration()
>     static class BeanB{}
>       
>     }
> 
> 但是需要把BeanA和BeanB定义为静态类，因为静态类与外部类无关能够独立存在，如果定义为非静态的，启动会报错。

### 关于ConfigurationConditon ###

ConfigurationCondition接口是Spring4.0提供的注解。位于**org.springframework.context.annotation**包内，继承于Condition接口。Condition接口和@Configuration以及@Conditional接口为bean的注册提供更细粒度的控制，允许某些Condition在匹配时根据配置阶段进行调整。

public interface ConfigurationCondition extends Condition {
    
        // 评估condition返回的ConfigurationPhase
        ConfigurationPhase getConfigurationPhase();
    
        // 可以评估condition的各种配置阶段。
        enum ConfigurationPhase {
        
            // @Condition 应该被评估为正在解析@Configuration类
            // 如果此时条件不匹配，则不会添加@Configuration 类。
            PARSE_CONFIGURATION,
    
            // 添加常规(非@Configuration)bean时，应评估@Condition。Condition 将不会阻止@Configuration 类
            // 添加。在评估条件时，将解析所有@Configuration
            REGISTER_BEAN
        }
    
    }

> getConfigurationPhase()方法返回ConfigurationPhase 的枚举。枚举类内定义了两个enum，PARSE\_CONFIGURATION 和 REGISTER\_BEAN，表示不同的注册阶段。

我们现在对condition实现更细粒度的控制，实现了ConfigurationCondition接口，我们现在需要实现getConfigurationPhase()方法获得condition需要评估的阶段。

*  新建`IfBeanAExistsConfigurationCondition`类，实现了ConfigurationCondition接口，分别返回ConfigurationPhase.REGISTER\_BEAN 和 ConfigurationPhase.PARSE\_CONFIGURATION 阶段。

public class IfBeanAExistsConfigurationCondition implements ConfigurationCondition {
    
        @Override
        public ConfigurationPhase getConfigurationPhase() {
            return ConfigurationPhase.REGISTER_BEAN;
        }
    
    //    @Override
    //    public ConfigurationPhase getConfigurationPhase() {
    //        return ConfigurationPhase.PARSE_CONFIGURATION;
    //    }
    
        @Override
        public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
            return context.getBeanFactory().containsBeanDefinition("beanA");
        }
    }

*  新建`SpringConfigurationConditionExample`类，与上述测试类基本相同，就是把@Conditional 换为了**@Conditional(IfBeanAExistsConfigurationCondition.class)**

测试类启动，输出结果

...
    Has BeanA? true
    Has BeanB? false
    ...
    Has BeanA? true
    Has BeanB? true
    ...
    Has BeanA? false
    Has BeanB? false
    ...
    Has BeanA? true
    Has BeanB? true

也就是说，如果返回的是**PARSE\_CONFIGURATION**阶段的话，不会阻止@Configuration的标记类的注册顺序，啥意思呢？

第一个结果，只注册了BeanA，因为只有BeanA加载。

第二个结果，注册了BeanA和BeanB，因为BeanA和BeanB都被加载

第三个结果，因为BeanB注册的条件是BeanA注册，因为BeanA没有注册，所以BeanB不会注册

第四个结果，**不论BeanA和BeanB的加载顺序如何**，都会直接进行注册。

*  如果把**REGISTER\_BEAN**改为**PARSE\_CONFIGURATION **，会发现加载顺序第一次一致。

发表评论取消回复

表情：

评论列表（有 0 条评论，491人围观）

还没有评论，来说两句吧...

相关阅读

相关一文了解反射

[CSDN话题挑战赛第2期][CSDN_2] 参赛话题：[学习笔记][Link 1] 前情回顾在学习反射之前我们可以先回顾一下在Java中创建对象的几种方式。

野性酷女/ 2024年04月06日 12:03/ 0 赞/ 66 阅读

相关一文了解Docker

> 假期把之前买的几本docker的书籍阅读一遍，本文是docker的学习笔记，了解docker的核心概念。一 docker 是什么 Docker是dotCloud公

末蓝、/ 2023年07月09日 13:28/ 0 赞/ 16 阅读

相关一文带你了解TypeScript接口使用

目录本文概览： 1. 接口的基本用法 2. 接口的可选属性 3. 接口的多余属性检查

﹏ヽ暗。殇╰゛Y/ 2022年12月27日 01:11/ 0 赞/ 258 阅读

相关一文了解protobuf

目录 1、什么是protobuf 2、.proto文件中的关键字： 3、protobuf中的字段类型（message） 3.1 保留字段（reserved） 3.2

Bertha 。/ 2022年10月22日 07:54/ 0 赞/ 266 阅读

相关 C++ | 一文了解【STL】

文章目录一、概述 1.1 容器 1.2 算法 1.3 迭代器

迷南。/ 2022年09月11日 08:21/ 0 赞/ 257 阅读

相关一文了解Zookeeper

![640?wx\_fmt=gif][640_wx_fmt_gif] ![640?wx\_fmt=jpeg][640_wx_fmt_jpeg] 前言相信大家对 Zo

不念不忘少年蓝@/ 2022年04月15日 01:30/ 0 赞/ 268 阅读

相关一文了解ConfigurationConditon接口

ConfigurationCondition 接口说明 @Conditional 和 Condition 在了解ConfigurationConditi

心已赠人/ 2021年11月01日 07:34/ 0 赞/ 336 阅读

相关一文了解ConfigurationConditon接口

ConfigurationCondition 接口说明 @Conditional 和 Condition 在了解ConfigurationCondition 接

约定不等于承诺〃/ 2021年09月19日 18:14/ 0 赞/ 383 阅读

相关一文了解Zookeeper

Zookeeper是Apache开源的一个分布式框架，它主要为分布式应用提供协调服务。 Zookeeper主要负责存储和管理大家都关心的数据，一旦这些数据的状态发生变化，Zo

客官°小女子只卖身不卖艺/ 2021年09月18日 05:54/ 0 赞/ 451 阅读

相关一文了解ConfigurationConditon接口

ConfigurationCondition 接口说明 @Conditional 和 Condition 在了解ConfigurationCondition 接

布满荆棘的人生/ 2021年06月22日 15:36/ 0 赞/ 492 阅读