Spring自動配置之condition條件判斷下篇

Posted on by

前言

本文章接上一篇文章繼續談一談condition的一些用法。

案例

上一篇文章我提的一個需求時導入jedis坐標後才能加載該Bean，否則不加載，那我們能不能將類的判斷定義為動態的，就不能寫死，判斷哪個或哪些字節碼文件可以動態指定。
那麼這時我們就要用到自定義條件註解。
首先我們來自定義一個註解ConditionOnClass

自定義的註解上要加上Conditionnal註解，而它的參數仍然是一個或多個字節碼文件，就可以實現相同的功能，註解內的方法返回值時一個字符串數組。

package cs.yangtze.springboot_condition.condition;
import org.springframework.context.annotation.Conditional;
import java.lang.annotation.*;
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(ClassCondition.class)
public @interface ConditionOnClass {
    String[] value();
}

然後我們在自定義配置文件config中添加自定義註解，註解中的參數為一個或多個想要判斷的條件，即當能夠使用或者存在該類的時候才能創建User的Bean對象。此處我導入的是這兩個類，當然也可以換成其它的。

package cs.yangtze.springboot_condition.config;
import cs.yangtze.springboot_condition.condition.ClassCondition;
import cs.yangtze.springboot_condition.condition.ConditionOnClass;
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
 @ConditionOnClass({"redis.clients.jedis.Jedis","com.alibaba.fastjson.JSON"})
    public User user(){
        return new User();
    }
}

最後去實現condition接口，matches方法的參數代碼中有註釋。如果你不知道Map裡面是什麼，你可以打印出來，它的鍵就是value，值就是一個數組，也就是上面提到的自定義註解中傳入的參數，即{“redis.clients.jedis.Jedis”,“com.alibaba.fastjson.JSON”}。

package cs.yangtze.springboot_condition.condition;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
import java.util.Map;
public class ClassCondition implements Condition {
    /**
     * @param context 上下文對象，用於獲取環境對象，IOC容器以及ClassLoader對象
     * @param metadata 註解元對象，可用於獲取註解定義的屬性值
     * @return
     */
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        //需求：動態的判斷是否有該類
        Map<String, Object> map = metadata.getAnnotationAttributes(ConditionOnClass.class.getName());
        String[] value = (String[]) map.get("value");
        try {
            for (String className : value) {
                Class<?> aClass = Class.forName(className);
            }
        } catch (Exception e) {
            flag = false;
        }
        return flag;
    }
}

最後能夠成功創建user的bean對象，你可以刪去pom文件中的任何一個依賴，最終都不能成功創建bean對象。

刪去redis或fastJson依賴後都不能成功創建

總結

Condition小結：

（1）自定義條件類：自定義類實現Condition接口，重寫matches方法，在matches方法中進行邏輯判斷，返回boolean值。matches方法的兩個參數：

· context：上下文對象，可以獲取屬性值，獲取類加載器，獲取BeanFactory等。

· metadata：元數據對象，用於獲取註解屬性。

（2）判斷條件：在初始化Bean時，使用@Conditional(條件類.class)註解。

但是一般我們都不用自定義條件註解，因為SpringBoot為我們提供瞭一些常用的條件註解：

· ConditionalOnProperty：判斷配置文件中是否有對應屬性和值才初始化Bean

· ConditionalOnClass：判斷環境中是否有對應字節碼文件才初始化Bean

· ConditionalOnMissingbean：判斷環境中沒有該Bean才初始化Bean

到此這篇關於Spring自動配置之condition條件判斷下篇的文章就介紹到這瞭,更多相關Spring condition條件判斷內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：