二、Spring註解之@Conditional

Spring註解之@Conditional

【1】@Conditional介紹

​ @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】@Conditional示例

​ 首先，創建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 + '}';
    }
}

​ 創建MyConfig類，用於配置兩個Person實例並註入，一個是Bill Gates，一個是linus。

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

​ 寫一個測試類，測試是否註入成功

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);
    }
}
/**測試結果
{bill=Person{name='Bill Gates',age=62},linus=Person{name='Linus',age='48'}}
*/

​ 這是一個簡單的例子，現在問題來了，如果我想根據當前操作系統來註入Person實例，windows下註入bill，linux下註入linus，怎麼實現呢？

​ 這就需要我們用到@Conditional註解了，前言中提到，需要實現Condition介面，並重寫方法來自定義match規則。

​ 首先，創建一個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;
    }
}

​ 修改MyConfig：

@Configuration
public class MyConfig {
 
    //只有一個類時，大括弧可以省略
    //如果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);
    }
}

標註在方法上：

​ 修改測試程式，開始測試：

public class ConditionalTest {
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);
 
    @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);
    }
}
/**測試結果
當前系統為：Windows 10
{bill=Person{name='Bill Gates',age=62}}
*/

一個方法只能註入一個bean實例，所以@Conditional標註在方法上只能控制一個bean實例是否註入

標註在類上:

@Configuration
@Conditional({WindowsCondition.class})
public class MyConfig {
 
    //只有一個類時，大括弧可以省略
    //如果WindowsCondition的實現方法返回true，則註入這個bean    
    @Bean(name = "bill")
    public Person person1(){
        return new Person("Bill Gates",62);
    }
 
    //如果LinuxCondition的實現方法返回true，則註入這個bean
    @Bean("linus")
    public Person person2(){
        return new Person("Linus",48);
    }
}

一個類中可以註入很多實例，@Conditional標註在類上就決定了一批bean是否註入。