享学笔记：Spring注解之@Conditional

前言：

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

源码：

 

适用于方法和类上；

需要传入一个Class数组且继承Condition接口。

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

代码示例：

创建一个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 + '}';
    }
}

创建配置类

@Configuration
public class BeanConfig {
 
    @Bean(name = "windowBean")
    public Person person1(){
        return new Person("windows",50);
    }
 
    @Bean("linuxBean")
    public Person person2(){
        return new Person("linux",40);
    }
}

 测试类

public class Test {
 
    
    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);
        Map<String, Person> map = applicationContext.getBeansOfType(Person.class);
        System.out.println(map);
    }
}

输出：

{windowBean=Person{name='windows', age=50}, linuxBean=Person{name='linux', age=40}}

下面增加需求 根据当前操作系统来注入对应的bean

首先创建一个WindowsCondition类

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;
    }
}

再创建一个LinuxCondition类

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;
    }
}

在配置类中使用@Conditon注解决定是否注入bean

@Configuration
public class BeanConfig {
 

     @Conditional({WindowsCondition.class})
       @Bean(name = "windowBean")
    public Person person1(){
        return new Person("windows",50);
    }
  @Conditional({LinuxCondition.class})
    @Bean("linuxBean")
    public Person person2(){
        return new Person("linux",40);
    }
}

输出：

{windowBean=Person{name='windows', age=50}}

 

@Conditional注解可以作用在方法上也可以作用在类上，

作用在方法上时，控制单个bean的注入

作用在类上时，控制整个配置类内的bean注入。

同时@Conditional注解支持多个Condition.class同时使用，也就是支持多条件使用