SpringBoot自動裝配之Condition深入講解

更新時間：2023年01月16日 08:53:08 作者：不死鳥.亞歷山大.狼崽子

@Conditional表示僅當所有指定條件都匹配時，組件才有資格注冊。該@Conditional注釋可以在以下任一方式使用：作為任何@Bean方法的方法級注釋、作為任何類的直接或間接注釋的類型級別注釋@Component，包括@Configuration類、作為元注釋，目的是組成自定義構造型注釋

Exception in thread "main" org.springframework.beans.factory.NoSuchBeanDefinitionException: No bean named 'redisTemplate' available
	at org.springframework.beans.factory.support.DefaultListableBeanFactory.getBeanDefinition(DefaultListableBeanFactory.java:874)
	at org.springframework.beans.factory.support.AbstractBeanFactory.getMergedLocalBeanDefinition(AbstractBeanFactory.java:1358)
	at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:309)
	at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:208)
	at org.springframework.context.support.AbstractApplicationContext.getBean(AbstractApplicationContext.java:1154)
	at com.example.condition.SpringbootDemo01Application.main(SpringbootDemo01Application.java:13)

當導入redis起步依賴后

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

org.springframework.data.redis.core.RedisTemplate@5a6d5a8f

問題：

SpringBoot是怎么知道我們導入redis坐標的呢？

案例一

需求：

在 Spring 的 IOC 容器中有一個 User 的 Bean，現(xiàn)要求：

通過condition設置加載或者不加載。

新建實體類：

package com.example.condition.entity;
public class User {
}

新建配置文件：

package com.example.condition.config;
import com.example.condition.condition.ClassCondition;
import com.example.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
    @Conditional(ClassCondition.class)
    public User user(){
        return new User();
    }
}

新建condition:

如果為true則加載，如果為false則不加載

package com.example.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) {
        return true;
    }
}

測試：

package com.example.condition;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class SpringbootDemo01Application {
    public static void main(String[] args) {
        //啟動SpringBoot應用，返回Spring的IOC容器
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootDemo01Application.class, args);
        Object user = context.getBean("user");
        System.out.println(user);
    }
}

案例二

需求：

在 Spring 的 IOC 容器中有一個 User 的 Bean，現(xiàn)要求：

導入Jedis坐標后，加載該Bean，沒導入，則不加載。

新建User實體類：

package com.example.condition.entity;
public class User {
}

新建配置文件：

package com.example.condition.config;
import com.example.condition.condition.ClassCondition;
import com.example.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
    @Conditional(ClassCondition.class)
    public User user(){
        return new User();
    }
}

condition通過反射判斷jedis是否已經(jīng)加載完畢

package com.example.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) {
        boolean flag =true;
        try {
            Class<?> cls = Class.forName("redis.clients.jedis.Jedis");
        }catch (ClassNotFoundException e){
            flag =false;
        }
        return flag;
    }
}

測試類：

package com.example.condition;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class SpringbootDemo01Application {
    public static void main(String[] args) {
        //啟動SpringBoot應用，返回Spring的IOC容器
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootDemo01Application.class, args);
        Object user = context.getBean("user");
        System.out.println(user);
    }
}

引入jedis進行測試判斷：

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

案例三

需求：

在 Spring 的 IOC 容器中有一個 User 的 Bean，現(xiàn)要求：

導入Jedis坐標后，加載該Bean，沒導入，則不加載。
將類的判斷定義為動態(tài)的。判斷哪個字節(jié)碼文件存在可以動態(tài)指定。

實體類：

package com.example.condition.entity;
public class User {
}

自定義注解：

package com.example.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();}

Condition類：

package com.example.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();
}

配置類：

package com.example.condition.condition;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotatedTypeMetadata;
import java.util.Map;
public class ClassCondition implements Condition {
    /**
     * @param context  上下文對象，用于獲取環(huán)境，ClassLoader對象
     * @param metadata 注解的元對象，可以用于注解定義的屬性值
     * @return
     */
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        Environment environment = context.getEnvironment();
        //1.需求：導入指定坐標后創(chuàng)建Bean
        //思路：判斷指定坐標文件是否存在
        //獲取注解屬性值 value
        Map<String, Object> map = metadata.getAnnotationAttributes(ConditionOnClass.class.getName());
        String[] value = (String[]) map.get("value");
        boolean flag = true;
        try {
            for (String className : value) {
                Class<?> cls = Class.forName(className);
            }
        } catch (ClassNotFoundException e) {
            flag = false;
        }
        return flag;
    }
}

測試類：

package com.example.condition;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
@SpringBootApplication
public class SpringbootDemo01Application {
    public static void main(String[] args) {
        //啟動SpringBoot應用，返回Spring的IOC容器
        ConfigurableApplicationContext context = SpringApplication.run(SpringbootDemo01Application.class, args);
        Object user = context.getBean("user");
        System.out.println(user);
    }
}

總結

自定義條件：

① 定義條件類：自定義類實現(xiàn)Condition接口，重寫 matches 方法，在 matches 方法中進行邏輯判斷，返回 boolean值。 matches 方法兩個參數(shù)：

context：上下文對象，可以獲取屬性值，獲取類加載器，獲取BeanFactory等。
metadata：元數(shù)據(jù)對象，用于獲取注解屬性。

② 判斷條件：在初始化Bean時，使用 @Conditional(條件類.class)注解

SpringBoot 提供的常用條件注解：

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

@Bean
@ConditionalOnProperty(name = "com",havingValue = "example")
public User user1(){
    return new User();
}

配置文件添加一下屬性：

com = example

ConditionalOnClass：判斷環(huán)境中是否有對應字節(jié)碼文件才初始化Bean
ConditionalOnMissingBean：判斷環(huán)境中沒有對應Bean才初始化Bean

到此這篇關于SpringBoot自動裝配之Condition深入講解的文章就介紹到這了,更多相關SpringBoot Condition內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

詳解Java編程中向量(Vector)的應用
這篇文章主要介紹了Java中的向量(Vector)的應用,Vector也是Java中比較常用的一個類,需要的朋友可以參考下
2015-10-10
java使用HashMap實現(xiàn)斗地主(有序版)
這篇文章主要為大家詳細介紹了java使用ArrayList實現(xiàn)斗地主游戲，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2021-03-03
Java延遲隊列DelayQueue原理詳解
這篇文章主要介紹了Java延遲隊列DelayQueue原理詳解,DelayQueue 是一個通過PriorityBlockingQueue實現(xiàn)延遲獲取元素的無界隊列無界阻塞隊列,其中添加進該隊列的元素必須實現(xiàn)Delayed接口,而且只有在延遲期滿后才能從中提取元素,需要的朋友可以參考下
2023-12-12
Java實現(xiàn)圖片上文字內(nèi)容的動態(tài)修改的操作步驟
在數(shù)字圖像處理領域,Java提供了強大的庫來處理圖片,包括讀取、修改和寫入圖片,如果你需要在Java應用程序中修改圖片上的文字內(nèi)容,可以通過圖像處理技術來實現(xiàn),這篇博文將介紹如何使用Java實現(xiàn)圖片上文字內(nèi)容的動態(tài)修改,需要的朋友可以參考下
2024-07-07
Java EE項目中的異常處理總結（一篇不得不看的文章）
什么是異常？運行時發(fā)生的可被捕獲和處理的錯誤。這篇文章主要介紹了Java EE項目中的異常處理總結，有需要的可以了解一下。
2016-11-11
Java實現(xiàn)視頻時間維度剪切的工具類
這篇文章主要為大家詳細介紹了將視頻按照時間維度進行剪切的Java工具類，文中的示例代碼講解詳細，感興趣的小伙伴可以跟隨小編一起了解一下
2022-12-12
Json傳輸出現(xiàn)中文亂碼問題的解決辦法
最近遇到一個問題,就是將中文消息以json格式推給微信服務器時,收到的消息是亂碼,所以下面這篇文章主要給大家介紹了關于Json傳輸出現(xiàn)中文亂碼問題的解決辦法,需要的朋友可以參考下
2023-05-05
Java自動釋放鎖的三種實現(xiàn)方案
在筆者面試過程時,經(jīng)常會被問到各種各樣的鎖,如樂觀鎖、讀寫鎖等等,非常繁多,下面這篇文章主要給大家介紹了關于Java自動釋放鎖的三種實現(xiàn)方案,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下
2022-06-06
Java中獲取List中最后一個元素的三種方法
在Java編程中我們經(jīng)常需要獲取一個List集合中的最后一個元素,這篇文章主要給大家介紹了關于Java中獲取List中最后一個元素的三種方法,文中通過代碼介紹的非常詳細,需要的朋友可以參考下
2023-12-12
servlet異步請求的實現(xiàn)
本文主要介紹了servlet異步請求的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2022-07-07