springboot注解之@Conditional使用解析

更新時(shí)間：2023年11月27日 10:50:40 作者：碼農(nóng)打工人

這篇文章主要介紹了springboot注解之@Conditional使用解析,conditional 這個(gè)英文單詞翻譯過(guò)來(lái)是有條件的,所以 @Conditional 注解是作為條件存在的,如果滿足配置的條件則執(zhí)行,如果沒(méi)有滿足的話就不執(zhí)行,需要的朋友可以參考下

前言

conditional 這個(gè)英文單詞翻譯過(guò)來(lái)是有條件的，所以 @Conditional 注解是作為條件存在的，如果滿足配置的條件則執(zhí)行，如果沒(méi)有滿足的話就不執(zhí)行。

一、@Conditional

@Conditional 注解上面說(shuō)了是作為條件執(zhí)行的，那么是作為什么條件呢？這我們就需要知道 @Conditional 主要是作用在什么上面。

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {
    Class<? extends Condition>[] value();
}

上面是 @Conditional 注解的源碼。我們看到注解的作用域是類、方法上。既然是作用在類上，即可以大體猜測(cè)到與 IOC 容器添加 bean 有關(guān)系。事實(shí)上 @Conditional 注解一般與 @Configuration、@Bean 共同使用，也可以與 @Controller、@Service、@Component、@Repository 等等這些注解一起使用。所以 @Conditional 通常是作為是否添加這個(gè)對(duì)象為 IOC 容器組件的條件出現(xiàn)的。既然知道 @Conditional 注解的作用，那么該注解應(yīng)該如何使用呢？我們看到該注解有一個(gè)必填的屬性 value，value 屬性的類型是 Condition 接口的實(shí)現(xiàn)類數(shù)組。我們看下 Condition 接口的源碼。

@FunctionalInterface
public interface Condition {
    boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);
}

Condition 接口只有一個(gè)抽象方法，返回 boolean 類型，可以知道返回為 true 則條件成立，返回 false 條件不成立。方法中有兩個(gè)參數(shù)，context 中包含容器、bean 工廠、類加載器、資源加載器、環(huán)境配置這五大核心屬性獲取方法，metadata 是注解的信息。從這里我們也可以自己實(shí)現(xiàn) matches 方法，去自定義一個(gè)條件類。自己去實(shí)現(xiàn) Condition 接口比較復(fù)雜，那么有沒(méi)有一些已經(jīng)實(shí)現(xiàn)好的常用的一些類呢？springboot 給我們提供了大量的這樣的實(shí)現(xiàn)類，讓我們基本不用自己去實(shí)現(xiàn) Condition 接口，就可以滿足日常的開(kāi)發(fā)。

二、@Conditional 的實(shí)現(xiàn)子注解

springboot 提供了大量的 @Conditional 子注解供我們使用，我們只需知道有哪些常用的子注解供我們使用即可。

springboot 提供的 @Conditional 子注解有：

@ConditionalOnBean
@ConditionalOnClass
@ConditionalOnCloudPlatform
@ConditionalOnExpression
@ConditionalOnJava
@ConditionalOnJndi
@ConditionalOnMissingBean
@ConditionalOnMissingClass
@ConditionalOnNotWebApplication
@ConditionalOnProperty
@ConditionalOnResource
@ConditionalOnSingleCandidate
@ConditionalOnWarDeployment
@ConditionalOnWebApplication

這些子注解是如何實(shí)現(xiàn)的呢？我們以 @ConditionalOnBean 注解為例看下源碼：

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional({OnBeanCondition.class})
public @interface ConditionalOnBean {
    Class<?>[] value() default {};

    String[] type() default {};

    Class<? extends Annotation>[] annotation() default {};

    String[] name() default {};

    SearchStrategy search() default SearchStrategy.ALL;

    Class<?>[] parameterizedContainer() default {};
}

可以看到 OnBeanCondition 是 Condition 接口的具體實(shí)現(xiàn)類。我們挑選一些日常常用的子注解做具體的說(shuō)明。

三、@ConditionalOnClass 注解

@ConditionalOnClass 的意思是以是否有該類為為條件。我們以 springboot 自動(dòng)配置 aop 的配置類做例子進(jìn)行解讀。我們打開(kāi) springboot 的自動(dòng)配置包 spring-boot-autoconfigure-2.7.0.jar 包，找到 AopAutoConfiguration.class，打開(kāi)后有這么一段代碼。

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass({Advice.class})
static class AspectJAutoProxyingConfiguration {
    AspectJAutoProxyingConfiguration() {
    }

    @Configuration(
        proxyBeanMethods = false
    )
    @EnableAspectJAutoProxy(
        proxyTargetClass = true
    )
    @ConditionalOnProperty(
        prefix = "spring.aop",
        name = {"proxy-target-class"},
        havingValue = "true",
        matchIfMissing = true
    )
    static class CglibAutoProxyConfiguration {
        CglibAutoProxyConfiguration() {
        }
    }

    @Configuration(
        proxyBeanMethods = false
    )
    @EnableAspectJAutoProxy(
        proxyTargetClass = false
    )
    @ConditionalOnProperty(
        prefix = "spring.aop",
        name = {"proxy-target-class"},
        havingValue = "false"
    )
    static class JdkDynamicAutoProxyConfiguration {
        JdkDynamicAutoProxyConfiguration() {
        }
    }
}

我們看到在內(nèi)部類 AspectJAutoProxyingConfiguration 上標(biāo)注了 @ConditionalOnClass({Advice.class}) 表示如果有 Advice.class 這個(gè)類則 AspectJAutoProxyingConfiguration 生效，否則就不生效。

那么我們測(cè)試以下。首先我們測(cè)試以下沒(méi)有的時(shí)候。

@SpringBootApplication
public class SpringbootFunctionApplication {

    public static void main(String[] args) {
        // 返回 IOC 容器
        ConfigurableApplicationContext run = SpringApplication.run(SpringbootFunctionApplication.class, args);
        // 測(cè)試沒(méi)有 Advice.class 的時(shí)候，是否有 AspectJAutoProxyingConfiguration 組件
        try {
            // 反射獲取內(nèi)部類的 Class 對(duì)象
            Class<?> clazz = Class.forName("org.springframework.boot.autoconfigure.aop.AopAutoConfiguration$AspectJAutoProxyingConfiguration");
            System.out.println(MessageFormat.format("容器中 AspectJAutoProxyingConfiguration 類型的組件個(gè)數(shù)有：{0}", run.getBeanNamesForType(clazz).length));
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
}

結(jié)果為：

容器中 AspectJAutoProxyingConfiguration 類型的組件個(gè)數(shù)有：0

可以看到如果沒(méi)有 Advice.class 的時(shí)候，@ConditionalOnClass 標(biāo)簽做了攔截，沒(méi)有添加 AspectJAutoProxyingConfiguration 為組件。

我們看下如果導(dǎo)入 Advice.class 之后會(huì)有什么現(xiàn)象。

我們?cè)?pom 文件中導(dǎo)入 aspectj 依賴

<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.9.19</version>
    <scope>runtime</scope>
</dependency>

最后執(zhí)行我們看到的結(jié)果為：

容器中 AspectJAutoProxyingConfiguration 類型的組件個(gè)數(shù)有：1

可以看到有了 Advice.class 之后，在容器添加 AspectJAutoProxyingConfiguration 作為 bean 的時(shí)候，通過(guò)了 @ConditionalOnClass 的校驗(yàn)。

四、@ConditionalOnMissingClass 注解

我們說(shuō)完了 @ConditionalOnClass，我們說(shuō)一下它的相反意思的注解：@ConditionalOnMissingClass。 @ConditionalOnMissingClass 是如果沒(méi)有這個(gè) class 類則執(zhí)行。我們同樣以 springboot 自動(dòng)配置 aop 的配置類做例子，不同的是我們選擇了 AopAutoConfiguration.class 中的另一個(gè)內(nèi)部類 ClassProxyingConfiguration。

@Configuration(proxyBeanMethods = false)
@ConditionalOnMissingClass({"org.aspectj.weaver.Advice"})
@ConditionalOnProperty(
    prefix = "spring.aop",
    name = {"proxy-target-class"},
    havingValue = "true",
    matchIfMissing = true
)
static class ClassProxyingConfiguration {
    ClassProxyingConfiguration() {
    }

    @Bean
    static BeanFactoryPostProcessor forceAutoProxyCreatorToUseClassProxying() {
        return (beanFactory) -> {
            if (beanFactory instanceof BeanDefinitionRegistry) {
                BeanDefinitionRegistry registry = (BeanDefinitionRegistry)beanFactory;
                AopConfigUtils.registerAutoProxyCreatorIfNecessary(registry);
                AopConfigUtils.forceAutoProxyCreatorToUseClassProxying(registry);
            }

        };
    }
}

可以看到內(nèi)部類 ClassProxyingConfiguration 上面標(biāo)注了 @ConditionalOnMissingClass 標(biāo)簽，條件是 org.aspectj.weaver.Advice 字符串，代表沒(méi)有該類則通過(guò)。

上面已經(jīng)引入了 aspectjweaver jar 包，我們看看容器中有沒(méi)有 ClassProxyingConfiguration 這個(gè) bean。

@SpringBootApplication
public class SpringbootFunctionApplication {

    public static void main(String[] args) {
        // 返回 IOC 容器
        ConfigurableApplicationContext run = SpringApplication.run(SpringbootFunctionApplication.class, args);
        // 測(cè)試有 Advice.class 的時(shí)候，是否有 ClassProxyingConfiguration 組件
        try {
            Class<?> clazz = Class.forName("org.springframework.boot.autoconfigure.aop.AopAutoConfiguration$ClassProxyingConfiguration");
            System.out.println(MessageFormat.format("容器中 ClassProxyingConfiguration 類型的組件個(gè)數(shù)有：{0}", run.getBeanNamesForType(clazz).length));
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }

}

結(jié)果為：

容器中 ClassProxyingConfiguration 類型的組件個(gè)數(shù)有：0

可以看出有 Advice.class 的時(shí)候 @ConditionalOnMissingClass 注解會(huì)判斷不通過(guò)，不會(huì)注冊(cè) ClassProxyingConfiguration 為 bean。

反過(guò)來(lái)如果沒(méi)有 Advice.class 的時(shí)候會(huì)是什么樣子呢？

容器中 ClassProxyingConfiguration 類型的組件個(gè)數(shù)有：1

五、@ConditionalOnBean 與 @ConditionalOnMissingBean

上面我們看了注解 @ConditionalOnClass、@ConditionalOnMissingClass，我們將要看的注解 @ConditionalOnBean 與 @ConditionalOnMissingBean 其實(shí)意思也是相似的，只不過(guò)前兩個(gè)注解以是否有 class 類作為判斷條件，后兩個(gè)注解以容器中是否有組件 bean 作為判斷條件。我們看一個(gè)例子

@Bean
@ConditionalOnBean({MultipartResolver.class})
@ConditionalOnMissingBean(name = {"multipartResolver"})
public MultipartResolver multipartResolver(MultipartResolver resolver) {
    return resolver;
}

這里 @ConditionalOnBean({MultipartResolver.class}) 如果容器中有 MultipartResolver 類型的 bean 則條件通過(guò)。 @ConditionalOnMissingBean(name = {“multipartResolver”}) 則表示如果容器中沒(méi)有 ID 為 multipartResolver 的 bean 則條件通過(guò)。可以看出這段代碼的功能是，如果容器中有 MultipartResolver 這個(gè)類型的 bean 但 ID 名稱不是 multipartResolver，則把名稱改為 multipartResolver。

六、@ConditionalOnProperty 注解

@ConditionalOnProperty 注解是以項(xiàng)目中的配置作為條件確定是否注冊(cè)為 bean。我們還是以 springboot 自動(dòng)配置 aop 的配置類 AopAutoConfiguration.class 中的子類 AspectJAutoProxyingConfiguration 做例子進(jìn)行解讀。

static class AspectJAutoProxyingConfiguration {
        AspectJAutoProxyingConfiguration() {
        }

        @Configuration(
            proxyBeanMethods = false
        )
        @EnableAspectJAutoProxy(
            proxyTargetClass = true
        )
        @ConditionalOnProperty(
            prefix = "spring.aop",
            name = {"proxy-target-class"},
            havingValue = "true",
            matchIfMissing = true
        )
        static class CglibAutoProxyConfiguration {
            CglibAutoProxyConfiguration() {
            }
        }

        @Configuration(
            proxyBeanMethods = false
        )
        @EnableAspectJAutoProxy(
            proxyTargetClass = false
        )
        @ConditionalOnProperty(
            prefix = "spring.aop",
            name = {"proxy-target-class"},
            havingValue = "false"
        )
        static class JdkDynamicAutoProxyConfiguration {
            JdkDynamicAutoProxyConfiguration() {
            }
        }
    }

可以看到 @ConditionalOnProperty 注解具有4個(gè)屬性 prefix（配置前綴）、name（配置名稱）、havingValue（匹配的值）、matchIfMissing（如果找不到這個(gè)配置的值則返回）在 AspectJAutoProxyingConfiguration 中有兩個(gè)內(nèi)部類 CglibAutoProxyConfiguration、JdkDynamicAutoProxyConfiguration。 CglibAutoProxyConfiguration 上面標(biāo)注的注解 @ConditionalOnProperty 屬性匹配的值為 true，如果沒(méi)有該配置則默認(rèn)通過(guò)。 JdkDynamicAutoProxyConfiguration 上面標(biāo)注的注解 @ConditionalOnProperty 屬性匹配的值為 false，沒(méi)有 matchIfMissing 屬性。我們進(jìn)行下面測(cè)試：

@SpringBootApplication(scanBasePackages = {"com.study.springbootfunction", "com.study.exclude"})
public class SpringbootFunctionApplication {

    public static void main(String[] args) {
        // 返回 IOC 容器
        ConfigurableApplicationContext run = SpringApplication.run(SpringbootFunctionApplication.class, args);
        // 是否包含 CglibAutoProxyConfiguration、JdkDynamicAutoProxyConfiguration
        try {
            Class<?> a = Class.forName("org.springframework.boot.autoconfigure.aop.AopAutoConfiguration$AspectJAutoProxyingConfiguration$CglibAutoProxyConfiguration");
            Class<?> j = Class.forName("org.springframework.boot.autoconfigure.aop.AopAutoConfiguration$AspectJAutoProxyingConfiguration$JdkDynamicAutoProxyConfiguration");
            System.out.println(MessageFormat.format("容器中 CglibAutoProxyConfiguration 類型的組件個(gè)數(shù)有：{0}", run.getBeanNamesForType(a).length));
            System.out.println(MessageFormat.format("容器中 JdkDynamicAutoProxyConfiguration 類型的組件個(gè)數(shù)有：{0}", run.getBeanNamesForType(j).length));
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }

    }
}

先不在項(xiàng)目中配置 spring.aop.proxy-target-class 運(yùn)行結(jié)果為：

容器中 CglibAutoProxyConfiguration 類型的組件個(gè)數(shù)有：1
容器中 JdkDynamicAutoProxyConfiguration 類型的組件個(gè)數(shù)有：0

能夠得出如果屬性 matchIfMissing 不配置的話默認(rèn)為 false。在項(xiàng)目中配置 spring.aop.proxy-target-class=true

spring:
  aop:
    proxy-target-class: true

運(yùn)行結(jié)果為：

容器中 CglibAutoProxyConfiguration 類型的組件個(gè)數(shù)有：1
容器中 JdkDynamicAutoProxyConfiguration 類型的組件個(gè)數(shù)有：0

如果在項(xiàng)目中配置 spring.aop.proxy-target-class=false

spring:
  aop:
    proxy-target-class: false

運(yùn)行結(jié)果為：

容器中 CglibAutoProxyConfiguration 類型的組件個(gè)數(shù)有：0
容器中 JdkDynamicAutoProxyConfiguration 類型的組件個(gè)數(shù)有：1

可以看出 @ConditionalOnProperty 屬性 havingValue 的值與項(xiàng)目中配置的值相匹配時(shí)為滿足條件，如果值不匹配的時(shí)候則條件不滿足。

七、@ConditionalOnWebApplication

如果是 web 應(yīng)用，則滿足條件。這個(gè)配置在 mvc 中的配置比較多，我們看下 mvc 中 DispatcherServlet 的自動(dòng)配置類。

@AutoConfigureOrder(-2147483648)
@AutoConfiguration(
    after = {ServletWebServerFactoryAutoConfiguration.class}
)
@ConditionalOnWebApplication(
    type = Type.SERVLET
)
@ConditionalOnClass({DispatcherServlet.class})
public class DispatcherServletAutoConfiguration {
}

我們看到 DispatcherServletAutoConfiguration 在是 servlet 的傳統(tǒng)項(xiàng)目中則成立，滿足條件。

到此這篇關(guān)于springboot注解之@Conditional使用解析的文章就介紹到這了,更多相關(guān)springboot注解@Conditional內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: