淺談SpringBoot中的@Conditional注解的使用

概述

Spring boot 中的 @Conditional 注解是一個(gè)不太常用到的注解，但確實(shí)非常的有用，我們知道 Spring Boot 是根據(jù)配置文件中的內(nèi)容，決定是否創(chuàng)建 bean，以及如何創(chuàng)建 bean 到 Spring 容器中，而 Spring boot 自動(dòng)化配置的核心控制，就是 @Conditional 注解。

@Conditional 注解是 Spring 4.0 之后出的一個(gè)注解，與其搭配的一個(gè)接口是 Condition，@Conditional 注解會(huì)根據(jù)具體的條件決定是否創(chuàng)建 bean 到容器中，接下來看看 @Conditional 注解的簡單使用。

1. @Conditional 和 Condition 接口搭配使用

這里需要實(shí)現(xiàn)的功能是，我們根據(jù)配置文件中的具體內(nèi)容，來決定是否創(chuàng)建 bean，首先我們在 application.yml 中加上一個(gè)自定義配置：

這里我們決定，這個(gè)配置中包含了 product 這個(gè)字符串的時(shí)候，才創(chuàng)建 bean。Product 是我自己隨便創(chuàng)建的一個(gè)實(shí)體類，你可以自行創(chuàng)建。

新建一個(gè)類 ProductCondition，內(nèi)容如下：

public class ProductCondition implements Condition {
  @Override
  public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
    //從配置文件中獲取屬性
    String property = conditionContext.getEnvironment().getProperty("create.bean");
    if (property != null){
      return property.contains("product");
    }
    else {
      return false;
    }
  }
}

這個(gè)類實(shí)現(xiàn)了 Condition 接口，這個(gè)接口只有一個(gè)方法，我們從配置文件中獲取剛才創(chuàng)建的自定義配置，如果配置中包含了 product 這個(gè)字符串，就會(huì)返回 true。

接下來創(chuàng)建一個(gè)配置類 ProductConfig，內(nèi)容如下：

@Configuration
public class ProductConfig {

  @Conditional(ProductCondition.class)
  @Bean(name = "product")
  public Product createProd(){
    return Product.builder().id(12312).categoryId(12).
        productName("Mac Book Pro").productImg("prod.png")
        .productPrice(18000).build();
  }
}

我們在創(chuàng)建的 bean 方法前面加上了 @Conditional 注解，判斷的標(biāo)準(zhǔn)是剛才的 ProductCondition，如果是 true，則創(chuàng)建 bean，否則不創(chuàng)建。我們寫一個(gè)測試類，來測試一下 bean 是否被創(chuàng)建了。測試代碼如下：

@Slf4j
@SpringBootTest
@RunWith(SpringRunner.class)
public class ProductConfigTest {

  @Test
  public void createProd() {
    try {
      Product product = SpringContextUtil.getBean("product", Product.class);
      if (product != null){
        System.out.println("創(chuàng)建了 bean : " + product.toString());
      }
    }
    catch (Exception e){
      log.info("發(fā)生異常，{}", e.getMessage());
      System.out.println("沒有創(chuàng)建 bean");
    }

  }
}

運(yùn)行測試代碼，發(fā)現(xiàn) bean 已經(jīng)創(chuàng)建了：

如果把 application.yml 中的配置改一下，不包含 product 這個(gè)字符串，那么返回的是 false，bean 則不會(huì)被創(chuàng)建，你可以試一下。

2. @ConditionalOnClass 的使用

這個(gè)注解的屬性可以跟上一個(gè)類的完整路徑或者是類的 Class 對(duì)象，如果類存在，則會(huì)創(chuàng)建 bean，例如下面的例子：

@Configuration
public class ProductConfig {

  @ConditionalOnClass(name = "com.roseduan.demo.entity.Product")
  @Bean(name = "product")
  public Product createProd(){

    return Product.builder().id(12312).categoryId(12).
        productName("Mac Book Pro").productImg("prod.png")
        .productPrice(18000).build();
  }
}

這個(gè)路徑下面的實(shí)體類 Product 是存在的，所以會(huì)創(chuàng)建 bean，如果是一個(gè)不存在的類，則不會(huì)創(chuàng)建。

3. @ConditionalOnProperty 的使用

這個(gè)注解可以直接從配置文件中獲取屬性，然后做為是否創(chuàng)建 bean 的依據(jù)。例如我們在 application.yml 中添加一個(gè)自定義配置：

ProductConfig 類的內(nèi)容是這樣的：

@Configuration
public class ProductConfig {

  @ConditionalOnProperty(value = "create.product.bean")
  @Bean(name = "product")
  public Product createProd(){

    return Product.builder().id(12312).categoryId(12).
        productName("Mac Book Pro").productImg("prod.png")
        .productPrice(18000).build();
  }
}

這里使用了 @ConditionalOnProperty 注解，從文件中讀取配置，因?yàn)槲覀冊O(shè)置的是 true，所以這個(gè) bean 會(huì)被創(chuàng)建，如果設(shè)置成 false，則 bean 不會(huì)被創(chuàng)建，你可以自己試一下。根據(jù)這個(gè)特性，我們可以給一些特定的配置加上一個(gè)開關(guān)，非常方便控制。

這里我只是列舉了幾個(gè)常用的注解，你可以查看官方文檔，里面有更詳細(xì)的說明：

參考文檔：Spring Boot 官網(wǎng)文檔

以上就是本文的全部內(nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持億速云。