1. 程式人生 > 程式設計 >Spring @Conditional註解講解及示例詳解

Spring @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則不注入。

示例:

首先,建立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例項被注入進容器。

這是一個簡單的例子,現在問題來了,如果我想根據當前作業系統來注入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;
  }
}

matches方法的兩個引數的意思在註釋中講述了,值得一提的是,conditionContext提供了多種方法,方便獲取各種資訊,也是SpringBoot中 @ConditonalOnXX註解多樣擴充套件的基礎。

接著,建立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;
  }
}

接著就是使用這兩個類了,因為此註解可以標註在方法上和類上,所以分開測試:

標註在方法上:

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

執行結果如下:

我是執行在windows上的所以只注入了bill,嗯,沒毛病。

接著實驗linux下的情況,不能執行在linux下,但可以修改執行時引數:

修改後啟動測試方法:

一個方法只能注入一個bean例項,所以@Conditional標註在方法上只能控制一個bean例項是否注入。

標註在類上:

一個類中可以注入很多例項,@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",48);
  }
}

結果兩個例項都被注入:

如果將類上的WindowsCondition.class改為LinuxCondition.class,結果應該可以猜到:

結果就是空的,類中所有bean都沒有注入。

多個條件類:

前言中說,@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",48);
  }
}

結果:

現在如果將ObstinateCondition的matches方法返回值改成true,兩個bean就被注入進容器:

結論得:

第一個條件類實現的方法返回true,第二個返回false,則結果false,不注入進容器。

第一個條件類實現的方法返回true,第二個返回true,則結果true,注入進容器中。

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。