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

以上就是Spring中@Conditional注解如何使用，小編相信有部分知識點可能是我們日常工作會見到或用到的。希望你能通過這篇文章學到更多知識。更多詳情敬請關注億速云行業資訊頻道。