Spring中@Conditional注解用法詳解

更新時間：2023年11月27日 08:30:43 作者：IT技術(shù)分享社區(qū)

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

1、@Conditional注解介紹

@Conditional是Spring4版本新提供的一種注解

它的作用是按照設(shè)定的條件進(jìn)行判斷，把滿足判斷條件的bean注冊到Spring容器。

2、@Conditional的源碼

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {
    /**
     * All {@link Condition Conditions} that must {@linkplain Condition#matches match}
     * in order for the component to be registered.
     */
    Class<? extends Condition>[] value();
}

說明：

@Conditional可以作用在方法上，也可以作用在類上。
使用的時候需要傳入實現(xiàn)Condition接口類數(shù)組。
如果是類和方法都加了@Conditional注解，最終在方法上的注解為最終的條件，如果返回true則加入容器，反之不會加入容器。
如果只是類上加了@Conditional注解，整個類的所有方法都會加入容器中。

3、用法示例

3.1 新建Book.java 文件

package com.spring.bean;
 
 
public class Book {
    private String bookName;
    private String bookType;
    private double price;
 
 
    public Book(String bookName, String bookType, double price) {
        this.bookName = bookName;
        this.bookType = bookType;
        this.price = price;
    }
 
 
    public String getBookName() {
        return bookName;
    }
 
 
    public void setBookName(String bookName) {
        this.bookName = bookName;
    }
 
 
    public String getBookType() {
        return bookType;
    }
 
 
    public void setBookType(String bookType) {
        this.bookType = bookType;
    }
 
 
    public double getPrice() {
        return price;
    }
 
 
    public void setPrice(double price) {
        this.price = price;
    }
 
 
    @Override
    public String toString() {
        return "Book{" +
                "bookName='" + bookName + '\'' +
                ", bookType='" + bookType + '\'' +
                ", price=" + price +
                '}';
    }
}

3.2 CNCondition.java 文件

package com.spring.condition;
 
 
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
 
 
public class CNCondition implements Condition {
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
        // user.language=CN 表示中文返回 true
        return conditionContext.getEnvironment().getProperty("user.language").contains("cn");
    }
}

3.3 ZHCondition.java 文件

package com.spring.condition;
 
 
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
 
 
public class ZHCondition implements Condition {
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
        // user.language=ZH Java默認(rèn)語言 表示中文返回 true
        return conditionContext.getEnvironment()
        .getProperty("user.language").contains("zh");
    }
}

3.4 新建TestConditionalConfig.java 配置文件

package com.spring.config;
 
 
import com.spring.bean.Book;
import com.spring.condition.CNCondition;
import com.spring.condition.ZHCondition;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
 
 
@Configuration
@Conditional(ZHCondition.class)
 
 
public class TestConditionalConfig {
    @Bean
    @Conditional(ZHCondition.class)//中文
    public Book bookZH()    {
        return new Book("紅樓夢","中國古典書籍",99.9);
    }
 
 
    @Bean
    @Conditional(CNCondition.class)//英文
    public Book bookCN()    {
        return new Book("哈姆雷特","外國經(jīng)典名著",66.6);
    }
}

3.5 新建TestConditional.java 測試文件

package com.spring.test;
 
 
import com.spring.bean.Book;
import com.spring.config.TestConditionalConfig;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 
 
import java.util.Map;
 
 
public class TestConditional {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext annotationContext = new AnnotationConfigApplicationContext(TestConditionalConfig.class);
        Map<String, Book> map = annotationContext.getBeansOfType(Book.class);
        System.out.println(map);
    }
}

4、@Conditional應(yīng)用場景

在一些需要條件滿足才是實例化的類中，使用此注解

比如項目中需要根據(jù)不同的場景使用不同的消息中間件，在消息隊列的實例化bean上，使用@Conditional注解，根據(jù)配置文件的不同，來判斷哪個bean需要加載到Spring容器中。

5、@Conditional的擴(kuò)展注解

@ConditionalOnBean：僅在當(dāng)前上下文中存在某個對象時，才會實例化一個Bean。
@ConditionalOnClass：某個class位于類路徑上，才會實例化一個Bean。
@ConditionalOnExpression：當(dāng)表達(dá)式值為true的時候，才會實例化一個Bean。
@ConditionalOnMissingBean：僅僅在當(dāng)前上下文中不存在某個對象時，才會實例化一個Bean。
@ConditionalOnMissingClass：某個class類路徑上不存在的時候，才會實例化一個Bean。
@ConditionalOnNotWebApplication：非web應(yīng)用，才會實例化一個Bean。
@ConditionalOnBean：當(dāng)容器中有指定Bean的條件下進(jìn)行實例化。
@ConditionalOnMissingBean：當(dāng)容器里沒有指定Bean的條件下進(jìn)行實例化。
@ConditionalOnClass：當(dāng)classpath類路徑下有指定類的條件下進(jìn)行實例化。
@ConditionalOnMissingClass：當(dāng)類路徑下沒有指定類的條件下進(jìn)行實例化。
@ConditionalOnWebApplication：當(dāng)項目是一個Web項目時進(jìn)行實例化。
@ConditionalOnNotWebApplication：當(dāng)項目不是一個Web項目時進(jìn)行實例化。
@ConditionalOnProperty：當(dāng)指定的屬性有指定的值時進(jìn)行實例化。
@ConditionalOnExpression：基于SpEL表達(dá)式的條件判斷。
@ConditionalOnJava：當(dāng)JVM版本為指定的版本范圍時觸發(fā)實例化。
@ConditionalOnResource：當(dāng)類路徑下有指定的資源時觸發(fā)實例化。
@ConditionalOnJndi：在JNDI存在的條件下觸發(fā)實例化。
@ConditionalOnSingleCandidate：當(dāng)指定的Bean在容器中只有一個，或者有多個但是指定了首選的Bean時，才會觸發(fā)實例化。