@Conditional注解详细讲解及示例

深碍√TFBOYSˉ_ 2022-10-23 11:18 197阅读 0赞

### 本文目录 ###

*   *  1.前言
     *  2.示例
     *   *  2.1 标注在方法上
         *  2.2 标注在类上
     *  3.多个条件类
     *   *  3.1 结论

--------------------

## 1.前言 ##

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

@Conditional的定义：

//此注解可以标注在类和方法上
    @Target({ ElementType.TYPE, ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME) 
    @Documented
    public @interface Conditional { 
        Class<? extends Condition>[] value();
    }

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

public interface Condition { 
        boolean matches(ConditionContext var1, AnnotatedTypeMetadata var2);
    }

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

## 2.示例 ##

首先，创建Person类：

public class Person { 
     
        private String name;
        private Integer age;
     
        public String getName() { 
            return name;
        }
     
        public void setName(String name) { 
            this.name = name;
        }
     
        public Integer getAge() { 
            return age;
        }
     
        public void setAge(Integer age) { 
            this.age = age;
        }
     
        public Person(String name, Integer age) { 
            this.name = name;
            this.age = age;
        }
     
        @Override
        public String toString() { 
            return "Person{" + "name='" + name + '\'' + ", age=" + age + '}';
        }
    }

创建BeanConfig类，用于配置两个Person实例并注入，一个是比尔盖茨，一个是林纳斯。

@Configuration
    public class BeanConfig { 
     
        @Bean(name = "bill")
        public Person person1(){ 
            return new Person("Bill Gates",62);
        }
     
        @Bean("linus")
        public Person person2(){ 
            return new Person("Linus",48);
        }
    }

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

public class ConditionalTest { 
     
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);
     
        @Test
        public void test1(){ 
            Map<String, Person> map = applicationContext.getBeansOfType(Person.class);
            System.out.println(map);
        }
    }

运行，输出结果是这样的，两个Person实例被注入进容器。  
![在这里插入图片描述][20210305102456436.png]

--------------------

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

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

首先，创建一个WindowsCondition类：

/** * 自定义Condition条件 */
    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();
            //获取当前环境信息
            Environment environment = conditionContext.getEnvironment();
            //获取bean定义的注册类
            BeanDefinitionRegistry registry = conditionContext.getRegistry();
     
            //获得当前系统名
            String property = environment.getProperty("os.name");
            //包含Windows则说明是windows系统，返回true
            if (property.contains("Windows")){ 
                return true;
            }
            return false;
        }
    }

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

### 2.1 标注在方法上 ###

修改BeanConfig：

@Configuration
    public class BeanConfig { 
     
        //只有一个类时，大括号可以省略
        //如果WindowsCondition的实现方法返回true，则注入这个bean 
        @Conditional({ WindowsCondition.class})
        @Bean(name = "bill")
        public Person person1(){ 
            return new Person("Bill Gates",62);
        }
     
        //如果LinuxCondition的实现方法返回true，则注入这个bean
        @Conditional({ LinuxCondition.class})
        @Bean("linus")
        public Person person2(){ 
            return new Person("Linus",48);
        }
    }

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

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

运行结果如下：  
![在这里插入图片描述][20210305102953745.png]  
我是运行在windows上的所以只注入了bill，嗯，没毛病。

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

![在这里插入图片描述][20210305103041720.png]  
![在这里插入图片描述][20210305103236422.png]  
**修改后启动测试方法：**  
![在这里插入图片描述][2021030510330458.png]  
结论： 一个方法只能注入一个bean实例，所以@Conditional标注在方法上只能控制一个bean实例是否注入。

### 2.2 标注在类上 ###

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

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

@Conditional({ WindowsCondition.class})
    @Configuration
    public class BeanConfig { 
     
        @Bean(name = "bill")
        public Person person1(){ 
            return new Person("Bill Gates",62);
        }
     
        @Bean("linus")
        public Person person2(){ 
            return new Person("Linus",48);
        }
    }

结果两个实例都被注入：  
![在这里插入图片描述][20210305103602729.png]  
如果将类上的 `WindowsCondition.class` 改为 `LinuxCondition.class`，结果应该可以猜到：  
![在这里插入图片描述][20210305103641475.png]  
结果就是空的，类中所有bean都没有注入。

## 3.多个条件类 ##

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

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

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

BeanConfig修改一下：

@Conditional({ WindowsCondition.class,ObstinateCondition.class})
    @Configuration
    public class BeanConfig { 
     
        @Bean(name = "bill")
        public Person person1(){ 
            return new Person("Bill Gates",62);
        }
     
        @Bean("linus")
        public Person person2(){ 
            return new Person("Linus",48);
        }
    }

结果：  
![在这里插入图片描述][20210305103823120.png]  
现在如果将 ObstinateCondition 的 matches 方法返回值改成true，两个bean就被注入进容器：  
![在这里插入图片描述][20210305103847141.png]

### 3.1 结论 ###

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

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

--------------------

> 版权声明：本文为CSDN博主「阿云\_」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。  
> 原文链接：https://blog.csdn.net/xcy1193068639/article/details/81491071

[20210305102456436.png]: /images/20221023/599ee89c9a7a4d53afb81cf4d9e34e49.png
[20210305102953745.png]: /images/20221023/9518ed2a8d15424ebeb33c156c78df8a.png
[20210305103041720.png]: /images/20221023/781789a515db492db27783917eccb299.png
[20210305103236422.png]: /images/20221023/720f6ae18ea642cc9a423b863d9e8702.png
[2021030510330458.png]: /images/20221023/95f5f5aabfc64572b5820d4375253701.png
[20210305103602729.png]: /images/20221023/e93dd47c6d974b589c8f9116c20166c5.png
[20210305103641475.png]: /images/20221023/d6fc95bb7b944eef96355194b3debdfd.png
[20210305103823120.png]: /images/20221023/600be38d65ec470e95b8465265bd65df.png
[20210305103847141.png]: /images/20221023/119519215de64a03bfd998f3592768e3.png