快捷導(dǎo)航

Spring中@Conditional注解的用法

更新時(shí)間：2024年01月04日 09:49:11 作者：時(shí)間不會(huì)賴著不走

這篇文章主要介紹了Spring中@Conditional注解的用法,@Conditional是Spring4新提供的注解,它的作用是按照一定的條件進(jìn)行判斷,滿足條件給容器注冊(cè)bean,需要的朋友可以參考下

@Conditional

@Conditional是Spring4新提供的注解，它的作用是按照一定的條件進(jìn)行判斷，滿足條件給容器注冊(cè)bean。

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

從代碼中可以看到，需要傳入一個(gè)Class數(shù)組，并且需要繼承Condition接口：

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

Condition是個(gè)接口，需要實(shí)現(xiàn)matches方法，返回true則注入bean，false則不注入。

用法如下

在這里插入圖片描述

下面舉例測(cè)試Condition的注入Bean

舉例測(cè)試

首先創(chuàng)建Dog類

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Dog {
    private String name;
    private String gender;
}

然后創(chuàng)建MyCondition類

重寫(xiě)matches方法，返回true則注入bean，false則不注入如果容器中注入了 dog 就返回true

public class MyCondition implements Condition {
    /**
     * 重寫(xiě)matches方法， 返回true則注入bean，false則不注入。
     * */
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
        // 如果容器中注入了 dog 就返回true
        if(beanFactory.containsBean("dog")){
            return true;
        }
        return false;
    }
}

定義兩個(gè)Bean

@Configuration
public class MyConfig {

    @Bean("dog")
    //@ConditionalOnBean(name = {"dog2"})
    public Dog dog1(){
        return new Dog("金毛","公");
    }

    @Bean("dog1")
    @Conditional(value = MyCondition.class)
    public Dog dog2(){
        return new Dog("拉布拉多","母");
    }
}

測(cè)試方法AnnotationConfigApplicationContext

AnnotationConfigApplicationContext是一個(gè)獨(dú)立的應(yīng)用上下文，它接受帶注釋的類作為輸入。例如@Configuration或@Component。可以使用scan()查找 Bean，也可以使用register()注冊(cè) Bean。

public class tets {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(MyConfig.class);
         Map<String, Dog> beansOfType = applicationContext.getBeansOfType(Dog.class);
        System.out.println(beansOfType);
    }
}

測(cè)試結(jié)果如下

[外鏈圖片轉(zhuǎn)存失敗,源站可能有防盜鏈機(jī)制,建議將圖片保存下來(lái)直接上傳(img-0E3qWV9I-1673088393503)(Spring%20@Conditional%E6%B3%A8%E8%A7%A3.assets/image-20230104162057475.jpg)]

如果將MyCondition類中邏輯改為，如果如果容器中之前注入了 dog 就返回false，不注入其他的，即:

public class MyCondition implements Condition {
    /**
     * 重寫(xiě)matches方法， 返回true則注入bean，false則不注入。
     * */
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
        // 如果容器中之前注入了 dog 就返回false
        if(beanFactory.containsBean("dog")){
            return false;
        }
        return true;
    }
}

那么結(jié)果如下:

[外鏈圖片轉(zhuǎn)存失敗,源站可能有防盜鏈機(jī)制,建議將圖片保存下來(lái)直接上傳(img-Y5YxGAQx-1673088393504)(Spring%20@Conditional%E6%B3%A8%E8%A7%A3.assets/image-20230104162343817.jpg)]

@Conditional本身還是一個(gè)父注解，派生出大量的子注解,如下:

@ConditionalOnBean：當(dāng)容器中有指定Bean的條件下進(jìn)行實(shí)例化。
@ConditionalOnMissingBean：當(dāng)容器里沒(méi)有指定Bean的條件下進(jìn)行實(shí)例化。
@ConditionalOnClass：當(dāng)classpath類路徑下有指定類的條件下進(jìn)行實(shí)例化。
@ConditionalOnMissingClass：當(dāng)類路徑下沒(méi)有指定類的條件下進(jìn)行實(shí)例化。
@ConditionalOnWebApplication：當(dāng)項(xiàng)目是一個(gè)Web項(xiàng)目時(shí)進(jìn)行實(shí)例化。
@ConditionalOnNotWebApplication：當(dāng)項(xiàng)目不是一個(gè)Web項(xiàng)目時(shí)進(jìn)行實(shí)例化。
@ConditionalOnProperty：當(dāng)指定的屬性有指定的值時(shí)進(jìn)行實(shí)例化。
@ConditionalOnExpression：基于SpEL表達(dá)式的條件判斷。
@ConditionalOnJava：當(dāng)JVM版本為指定的版本范圍時(shí)觸發(fā)實(shí)例化。
@ConditionalOnResource：當(dāng)類路徑下有指定的資源時(shí)觸發(fā)實(shí)例化。
@ConditionalOnJndi：在JNDI存在的條件下觸發(fā)實(shí)例化。
@ConditionalOnSingleCandidate：當(dāng)指定的Bean在容器中只有一個(gè)，或者有多個(gè)但是指定了首選的Bean時(shí)觸發(fā)實(shí)例化。

測(cè)試@ConditionalOnBean和@ConditionalOnMissingBean注解

修改之前的配置類如下

@Configuration
public class MyConfig {

    @Bean("dog")

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

    @Bean("dog1")
    @ConditionalOnBean(name = {"dog"})// spring容器中有dog這個(gè)Bean 才會(huì)創(chuàng)建dog1
//    @ConditionalOnMissingBean(name = {"dog"})// spring容器中不存在 dog這個(gè)Bean 才會(huì)創(chuàng)建dog1
    public Dog dog2(){
        return new Dog("拉布拉多","母");
    }
}

結(jié)果如下：

[外鏈圖片轉(zhuǎn)存失敗,源站可能有防盜鏈機(jī)制,建議將圖片保存下來(lái)直接上傳(img-hPUXUWPh-1673088393505)(Spring%20@Conditional%E6%B3%A8%E8%A7%A3.assets/image-20230104163639174.jpg)]

然后再將第二個(gè)注釋放開(kāi)，第一個(gè)注釋注釋掉結(jié)果如下：

[外鏈圖片轉(zhuǎn)存失敗,源站可能有防盜鏈機(jī)制,建議將圖片保存下來(lái)直接上傳(img-z9erSSTI-1673088393505)(Spring%20@Conditional%E6%B3%A8%E8%A7%A3.assets/image-20230104163855985.jpg)]