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

2022-08-17 14:02:34

前言

本文章接上一篇文章繼續談一談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物件。