Spring自動設定之condition條件判斷上篇

2022-08-17 14:02:57

前言

Condition是在Spring4.0增加的條件判斷功能，通過這個功能可以實現選擇性的建立Bean物件。

引入一個例子

SpringBoot是如何知道要建立哪個Bean的？比如SpringBoot是如何知道要建立RedisTemplate的？
在SpringBoot中獲取應用上下文物件context，通過其getBean方法獲取Bean物件

package cs.yangtze.springboot_condition;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class SpringbootConditionApplication {
    public static void main(String[] args) {
        //啟動springboot的應用，返回spring的IOC容器
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootConditionApplication.class, args);
        //獲取bean，redisTemplate
        Object redisTemplate = context.getBean("redisTemplate");
        System.out.println(redisTemplate);
    }
}

啟動專案之後會報一個這樣的錯誤：No Such Bean，這是因為我們還沒有匯入redis的起步依賴

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

匯入依賴後，這時SpringBoot就能夠識別這樣的bean物件了

通過這個例子，我們來想一想，為什麼我們沒有匯入redis依賴的時候，SpringBoot不會為我們建立這個redisTemplate的bean物件？

SpringBoot做的事情就是判斷當前環境中有沒有一個redis對應的所需要的位元組碼檔案，有的話就會幫你建立被俺物件，沒有就不會建立。這時候我們就會用condition來實現。

condition的一個案例

需求：在Spring的IOC容器中有一個USer的Bean，現要求：匯入Jedis座標後載入該Bean，沒匯入，則不載入。

首先建立一個實體類User，不需要成員變數

然後建立condition的實現類ClassCondition，它只有一個需要重寫的方法matches，返回值型別為布林型別，至於這個返回值有什麼作用，下面會有解釋。

在這個重寫的方法中我們就要去實現需求：匯入Jedis座標後載入該Bean。其中是一個很簡單的邏輯，如果我們匯入了Jedis的依賴，那我們就可以通過Class.forName(“redis.clients.jedis.Jedis”)來獲取與給定的字串名稱相關聯類或介面的Class物件，如果能夠獲取到就返回true，否則返回false。

package cs.yangtze.springboot_condition.condition;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
public class ClassCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        //需求：匯入jedis座標後建立Bean
        boolean flag = true;
        try {
            Class<?> aClass = Class.forName("redis.clients.jedis.Jedis");
        } catch (ClassNotFoundException e) {
            flag = false;
        }
        return flag;
    }
}

然後建立一個設定類UserConfig，用來建立User的Bean物件
注意：在方法的上面還有一個Conditional的註解，這就是今天的重點！！！
Conditional括號中的引數是一個或多個condition的實現類，這時候就會用到上面提到的返回值，若重寫的match方法返回的是TRUE，則條件成立（即我匯入了Jedis座標），那麼IOC容器就會幫我去建立bean物件，否則不會。

package cs.yangtze.springboot_condition.config;
import cs.yangtze.springboot_condition.condition.ClassCondition;
import cs.yangtze.springboot_condition.entity.User;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
@Configuration
public class UserConfig {
    @Bean//用於在容器中闖進Bean物件
    @Conditional(ClassCondition.class)  //引數是一個或多個condition的實現類
    public User user(){
        return new User();
    }
}

最後在啟動類中通過上下文物件來獲取該bean物件

package cs.yangtze.springboot_condition;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class SpringbootConditionApplication {
    public static void main(String[] args) {
        //啟動springboot的應用，返回spring的IOC容器
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootConditionApplication.class, args);
        //獲取bean，redisTemplate
        Object redisTemplate = context.getBean("redisTemplate");
        System.out.println(redisTemplate);
 		//此處getBean方法中的引數是UserConfig類中的方法名稱，當然也可以在@Bean註解後加入名稱，如@Bean("aaa"),那麼此處的user就應換成aaa
        Object user = context.getBean("user");
        System.out.println(user);
    }
}

結果演示：當我匯入Jedis座標時，能夠正常獲取物件

未匯入時

補充：Jedis座標

  <dependency>
        <groupId>redis.clients</groupId>
        <artifactId>jedis</artifactId>
  </dependency>

總結

本文中的是否jedis座標只是一個簡單的例子，當然也可以換成其他的條件，目的就是為了展示condition的功能，就是通過判斷來選擇性的建立bean物件。

到此這篇關於Spring自動設定之condition條件判斷上篇的文章就介紹到這了,更多相關Spring condition條件判斷內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

Spring自動設定之condition條件判斷上篇

目錄

前言

引入一個例子

condition的一個案例

總結

熱門文章