快捷導(dǎo)航

SpringBoot中@Conditional注解的使用

更新時(shí)間：2024年01月04日 08:34:16 作者：Splaying

這篇文章主要介紹了SpringBoot中@Conditional注解的使用,@Conditional注解是一個(gè)條件裝配注解,主要用于限制@Bean注解在什么時(shí)候才生效,以指定的條件形式控制bean的創(chuàng)建,需要的朋友可以參考下

1、基本介紹

@Conditional注解是一個(gè)條件裝配注解，主要用于限制@Bean注解在什么時(shí)候才生效。以指定的條件形式控制bean的創(chuàng)建
@Conditional可以自定義條件進(jìn)行裝配或者不裝配…
@Conditional本身還是一個(gè)父注解，派生出大量的子注解；可以按需加載！
因此在學(xué)習(xí)SpringBoot的時(shí)候是非常有必要學(xué)習(xí)這個(gè)注解的使用的，SpringBoot就是按需加載。
Conditional注解和所有子注解首先必須依托@Configuration配置類注解
都可以加載類或者方法上；加載類上的含義所有的方法都按照這個(gè)條件裝配、加載方法上只有該方法進(jìn)行條件裝配。
注：Conditional注解是Spring4.0就有的，旗下的子注解是SpringBoot1.0有的。

2、@Conditional注解

使用Conditional注解進(jìn)行條件裝配時(shí)需要自定義類實(shí)現(xiàn)Condition接口（spring包下的，不是JUC包下）

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {
	// 自定義類實(shí)現(xiàn)Condition接口，完成給出指定的條件。
	Class<? extends Condition>[] value();
}

2.1、自定義條件

如果存在dog1則不會(huì)對(duì)條件裝配bean進(jìn)行創(chuàng)建。

public class MyCondition implements Condition {
    /**
     * @param context: 判斷條件使用的上下文環(huán)境
     * @param metadata: 掃描的注解信息
     */
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // 1. 獲取bean工廠
        ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
        // 2. 獲取運(yùn)行環(huán)境, 可以根據(jù)操作系統(tǒng)的環(huán)境進(jìn)行限制bean
        Environment environment = context.getEnvironment();
        // 3. 獲取BeanDefinition注冊(cè)定義表
        context.getRegistry();
        // 4. 獲取資源加載器
        context.getResourceLoader();
        // 5. 獲取類加載器
        ClassLoader classLoader = context.getClassLoader();
        if (beanFactory.containsBean("dog1")) {
            return false;
        }
        /**
         *      可以根據(jù)以上條件進(jìn)行條件裝配
         *      true: 裝配
         *      false： 不裝配
         */
        return true;
    }
}

2.2、條件裝配測(cè)試

@Configuration
public class MyConfig {
    @Bean("user1")
    public User user1(){
        return new User("splay", 22, "男");
    }
    @Bean("dog1")
    //@ConditionalOnBean(name = {"dog2"})
    public Dog dog1(){
        return new Dog("金毛", 4,"公");
    }
    @Bean("dog2")
    @Conditional(value = MyCondition.class)
    public Dog dog2(){
        return new Dog("拉布拉多", 3,"母");
    }
}

在dog2上加上條件裝配，當(dāng)掃描到這個(gè)bean時(shí)會(huì)進(jìn)行條件判斷。

在這里插入圖片描述

3、@ConditionalOnBean子注解

子注解其實(shí)也是Conditional注解的特定裝配，只不過(guò)條件類已經(jīng)實(shí)現(xiàn)好了。

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnBeanCondition.class)			//OnBeanCondition是一個(gè)Condition接口的實(shí)現(xiàn)類
public @interface ConditionalOnBean {

	// 1. 按照bean的類型進(jìn)行檢查
	Class<?>[] value() default {};

	// 2. 按照bean的類型進(jìn)行檢查
	String[] type() default {};

	// 3. 按照bean的注解進(jìn)行檢查
	Class<? extends Annotation>[] annotation() default {};

	// 4. 按照BeanName進(jìn)行檢查
	String[] name() default {};

	// 5. 搜索策略
	SearchStrategy search() default SearchStrategy.ALL;

	// 6. 不詳
	Class<?>[] parameterizedContainer() default {};
}

3.1、條件裝配測(cè)試（一）

當(dāng)容器中存在dog1的時(shí)候在創(chuàng)建dog2，否則就不會(huì)進(jìn)行創(chuàng)建。

@Configuration
public class MyConfig {

    @Bean("user1")
    public User user1(){
        return new User("splay", 22, "男");
    }


    @Bean("dog1")
    public Dog dog1(){
        return new Dog("金毛", 4,"公");
    }

    @Bean("dog2")
    @ConditionalOnBean(name = {"dog1"})
    public Dog dog2(){
        return new Dog("拉布拉多", 3,"母");
    }
}

在這里插入圖片描述

3.2、條件裝配測(cè)試（二）

在使用時(shí)發(fā)現(xiàn)條件裝配與bean的編寫注冊(cè)順序有關(guān)系，如果先后順序?qū)е聦?huì)出現(xiàn)失敗的情況。

@Configuration
public class MyConfig {

    @Bean("user1")
    public User user1(){
        return new User("splay", 22, "男");
    }


    @Bean("dog1")
    @ConditionalOnBean(name = {"dog2"})		//當(dāng)有dog2組件的時(shí)候創(chuàng)建dog1
    public Dog dog1(){
        return new Dog("金毛", 4,"公");
    }

    @Bean("dog2")
    public Dog dog2(){
        return new Dog("拉布拉多", 3,"母");
    }
}

在這里插入圖片描述