Spring4之@Conditional注解详细讲解及示例

女爷i 2023-01-08 12:23 93阅读 0赞

# 前言 #

@Conditional是Spring4新提供的注解，它的作用是按照条件进行判断，满足条件给容器注册bean。

@Conditional的定义：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70][]

从代码中可以看到，需要传入一个Class数组，并且需要继承Condition接口：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 1][]

Condition是个接口，需要实现matches方法，重写这个方法返回true则注入bean，false则不注入。

# 示例： #

首先，创建User类：

import lombok.AllArgsConstructor;
    import lombok.Data;
    import lombok.NoArgsConstructor;
    
    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    public class User {
        private Long userId;
        private String userName;
    }

创建BeanConfig类，用于配置两个Person实例并注入，一个是王者荣耀，一个是吃鸡。

import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration
    public class BeanConfig {
     
        @Bean(name = "wzry")
        public User person1(){
            return new User(1L, "王者荣耀");
        }
     
        @Bean("cj")
        public User person2(){
            return new User(2L, "吃鸡");
        }
    
    }

接着写一个测试类进行验证这两个Bean是否注入成功。

import org.junit.Test;
    import org.springframework.context.annotation.AnnotationConfigApplicationContext;
    
    import java.util.Map;
    
    public class ConditionalTest {
     
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);
     
        @Test
        public void test1(){
            Map<String, User> map = applicationContext.getBeansOfType(User.class);
            System.out.println(map);
        }
    }

运行，输出结果是这样的，两个Person实例被注入进容器。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 2][]

这是一个简单的例子，现在问题来了，如果我想**根据当前操作系统来注入Person实例**，windows下注入bill，linux下注入linus，怎么实现呢？

这就需要我们用到@Conditional注解了，前言中提到，需要实现Condition接口，并重写方法来自定义match规则。

首先，创建一个WindowsCondition类：

import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
    import org.springframework.beans.factory.support.BeanDefinitionRegistry;
    import org.springframework.context.annotation.Condition;
    import org.springframework.context.annotation.ConditionContext;
    import org.springframework.core.env.Environment;
    import org.springframework.core.type.AnnotatedTypeMetadata;
    
    public class WindowsCondition implements Condition {
     
        /**
         * @param conditionContext:判断条件能使用的上下文环境
         * @param annotatedTypeMetadata:注解所在位置的注释信息
         * */
        @Override
        public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
            //获取ioc使用的beanFactory
            ConfigurableListableBeanFactory beanFactory = conditionContext.getBeanFactory();
            //获取类加载器
            ClassLoader classLoader = conditionContext.getClassLoader();
            //获取bean定义的注册类
            BeanDefinitionRegistry registry = conditionContext.getRegistry();
            //获取当前环境信息
            Environment environment = conditionContext.getEnvironment();
     
            //获得当前系统名
            String property = environment.getProperty("os.name");
            //包含Windows则说明是windows系统，返回true
            if (property.contains("Windows")){
                return true;
            }
            return false;
        }
    }

matches方法的两个参数的意思在注释中讲述了，值得一提的是，conditionContext提供了多种方法，方便获取各种信息，也是SpringBoot中 @ConditonalOnXX注解多样扩展的基础。

接着，创建LinuxCondition类：

import org.springframework.context.annotation.Condition;
    import org.springframework.context.annotation.ConditionContext;
    import org.springframework.core.env.Environment;
    import org.springframework.core.type.AnnotatedTypeMetadata;
    
    public class LinuxCondition implements Condition {
     
        @Override
        public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
     
            Environment environment = conditionContext.getEnvironment();
     
            String property = environment.getProperty("os.name");
            if (property.contains("Linux")){
                return true;
            }
            return false;
        }
    }

接着就是使用这两个类了，因为此注解可以标注在方法上和类上，所以分开测试：

## 标注在方法上： ##

修改BeanConfig：

import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Conditional;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration
    public class BeanConfig {
    
        //只有一个类时，大括号可以省略
        //如果WindowsCondition的实现方法返回true，则注入这个bean
        @Conditional({WindowsCondition.class})
        @Bean(name = "wzry")
        public User person1(){
            return new User(1L, "王者荣耀");
        }
    
        //如果LinuxCondition的实现方法返回true，则注入这个bean
        @Conditional({LinuxCondition.class})
        @Bean("cj")
        public User person2(){
            return new User(2L, "吃鸡");
        }
    
    }

修改测试方法，使其可以打印当前系统名：

@Test
    public void test1(){
        String osName = applicationContext.getEnvironment().getProperty("os.name");
        System.out.println("当前系统为：" + osName);
        Map<String, User> map = applicationContext.getBeansOfType(User.class);
        System.out.println(map);
    }

运行结果如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 3][]

接着实验linux下的情况，不能运行在linux下，但可以修改运行时参数：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 4][]

![20210120105202117.png][]

-Dos.name=Linux

运行结果为：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 5][]

一个方法只能注入一个bean实例，所以@Conditional标注在方法上只能控制一个bean实例是否注入。

# 标注在类上： #

一个类中可以注入很多实例，@Conditional标注在类上就决定了一批bean是否注入。

我们试一下，将BeanConfig改写，这时，如果WindowsCondition返回true，则两个Person实例将被注入(注意：上一个测试将os.name改为linux，这时我将把这个参数去掉)：

import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Conditional;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration
    @Conditional({WindowsCondition.class})
    public class BeanConfig {
    
        //只有一个类时，大括号可以省略
        //如果WindowsCondition的实现方法返回true，则注入这个bean
    //    @Conditional({WindowsCondition.class})
        @Bean(name = "wzry")
        public User person1(){
            return new User(1L, "王者荣耀");
        }
    
        //如果LinuxCondition的实现方法返回true，则注入这个bean
    //    @Conditional({LinuxCondition.class})
        @Bean("cj")
        public User person2(){
            return new User(2L, "吃鸡");
        }
    }

结果两个实例都被注入：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 6][]

如果将类上的WindowsCondition.class改为LinuxCondition.class，结果应该可以猜到：

@Configuration
    @Conditional({LinuxCondition.class})
    public class BeanConfig {
    
        //只有一个类时，大括号可以省略
        //如果WindowsCondition的实现方法返回true，则注入这个bean
    //    @Conditional({WindowsCondition.class})
        @Bean(name = "wzry")
        public User person1(){
            return new User(1L, "王者荣耀");
        }
    
        //如果LinuxCondition的实现方法返回true，则注入这个bean
    //    @Conditional({LinuxCondition.class})
        @Bean("cj")
        public User person2(){
            return new User(2L, "吃鸡");
        }
    }

打印结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 7][]

结果就是空的，类中所有bean都没有注入。

## 多个条件类： ##

前言中说，@Conditional注解传入的是一个Class数组，存在多种条件类的情况。

这种情况貌似判断难度加深了，测试一波，新增新的条件类，实现的matches返回false（这种写死返回false的方法纯属测试用，做测试用例并没有实际意义）

public class ObstinateCondition implements Condition {
     
        @Override
        public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
             return false;
        }
    }

BeanConfig修改一下：

import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Conditional;
    import org.springframework.context.annotation.Configuration;
    
    @Configuration
    @Conditional({WindowsCondition.class, ObstinateCondition.class})
    public class BeanConfig {
    
        //只有一个类时，大括号可以省略
        //如果WindowsCondition的实现方法返回true，则注入这个bean
    //    @Conditional({WindowsCondition.class})
        @Bean(name = "wzry")
        public User person1(){
            return new User(1L, "王者荣耀");
        }
    
        //如果LinuxCondition的实现方法返回true，则注入这个bean
    //    @Conditional({LinuxCondition.class})
        @Bean("cj")
        public User person2(){
            return new User(2L, "吃鸡");
        }
    }

结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 8][]

现在如果将ObstinateCondition的matches方法返回值改成true，两个bean就被注入进容器：

import org.springframework.context.annotation.Condition;
    import org.springframework.context.annotation.ConditionContext;
    import org.springframework.core.type.AnnotatedTypeMetadata;
    
    public class ObstinateCondition implements Condition {
     
        @Override
        public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
             return true;
        }
    }

结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 9][]

# 结论得： #

第一个条件类实现的方法返回true，第二个返回false，则结果false，不注入进容器。

第一个条件类实现的方法返回true，第二个返回true，则结果true，注入进容器中。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70]: /images/20221119/889df330325b4461a9c2bbaf9ebb1b04.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 1]: /images/20221119/17fab430ca164885a36228e8f89b0e5b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 2]: /images/20221119/feee0352333f4cc3acb80cb0d2053d4c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 3]: /images/20221119/abb799fe635c4a27a3f157df47c28722.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 4]: /images/20221119/f394d0dc66a047f393b4ca803f9a9566.png
[20210120105202117.png]: /images/20221119/a4a11c60a1884ff7949457c0a5b1a80c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 5]: /images/20221119/086f75383cce4dd5b0e795211a0c6571.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 6]: /images/20221119/083bacd5c554463c9256d762821701a4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 7]: /images/20221119/bc3a352fb74347b1bbcdc8fa52d15390.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 8]: /images/20221119/45060af0efb649f1b02e4adde0ff88a0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4MjcwMTA2_size_16_color_FFFFFF_t_70 9]: /images/20221119/94d57269d0194f7a9bf69148f489f0f4.png