Spring中@Conditional注解的詳細講解及示例
1.前言
@Conditional是Spring4新提供的注解，它的作用是按照一定的條件進行判斷，滿足條件給容器注冊bean。
@Conditional的定義：
//此注解可以標注在類和方法上
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {
Class<? extends Condition>[] value();
}
從代碼中可以看到，需要傳入一個Class數組，并且需要繼承Condition接口：
public interface Condition {
boolean matches(ConditionContext var1, AnnotatedTypeMetadata var2);
}
Condition是個接口，需要實現matches方法，返回true則注入bean，false則不注入。
2.示例
首先，創(chuàng)建Person類：
public class Person {
private String name;
private Integer age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public Person(String name, Integer age) {
this.name = name;
this.age = age;
}
@Override
public String toString() {
return "Person{" + "name='" + name + '\'' + ", age=" + age + '}';
}
}
創(chuàng)建BeanConfig類，用于配置兩個Person實例并注入，一個是比爾蓋茨，一個是林納斯。
@Configuration
public class BeanConfig {
@Bean(name = "bill")
public Person person1(){
return new Person("Bill Gates",62);
}
@Bean("linus")
public Person person2(){
return new Person("Linus",48);
}
}
接著寫一個測試類進行驗證這兩個Bean是否注入成功。
public class ConditionalTest {
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);
@Test
public void test1(){
Map<String, Person> map = applicationContext.getBeansOfType(Person.class);
System.out.println(map);
}
}
運行，輸出結果是這樣的，兩個Person實例被注入進容器。
這是一個簡單的例子，現在問題來了，如果我想根據當前操作系統(tǒng)來注入Person實例，windows下注入bill，linux下注入linus，怎么實現呢？
這就需要我們用到@Conditional注解了，前言中提到，需要實現Condition接口，并重寫方法來自定義match規(guī)則。
首先，創(chuàng)建一個WindowsCondition類：
/**
* 自定義Condition條件
*/
public class WindowsCondition implements Condition {
/**
* @param conditionContext:判斷條件能使用的上下文環(huán)境
* @param annotatedTypeMetadata:注解所在位置的注釋信息
* */
@Override
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
//獲取ioc使用的beanFactory
ConfigurableListableBeanFactory beanFactory = conditionContext.getBeanFactory();
//獲取類加載器
ClassLoader classLoader = conditionContext.getClassLoader();
//獲取當前環(huán)境信息
Environment environment = conditionContext.getEnvironment();
//獲取bean定義的注冊類
BeanDefinitionRegistry registry = conditionContext.getRegistry();
//獲得當前系統(tǒng)名
String property = environment.getProperty("os.name");
//包含Windows則說明是windows系統(tǒng)，返回true
if (property.contains("Windows")){
return true;
}
return false;
}
}
matches方法的兩個參數的意思在注釋中講述了，值得一提的是：conditionContext 提供了多種方法，方便獲取各種信息，也是SpringBoot中 @ConditonalOnXX 注解多樣擴展的基礎。
2.1 標注在方法上
修改BeanConfig：
@Configuration
public class BeanConfig {
//只有一個類時，大括號可以省略
//如果WindowsCondition的實現方法返回true，則注入這個bean
@Conditional({WindowsCondition.class})
@Bean(name = "bill")
public Person person1(){
return new Person("Bill Gates",62);
}
//如果LinuxCondition的實現方法返回true，則注入這個bean
@Conditional({LinuxCondition.class})
@Bean("linus")
public Person person2(){
return new Person("Linus",48);
}
}
修改測試方法，使其可以打印當前系統(tǒng)名：
@Test
public void test1(){
String osName = applicationContext.getEnvironment().getProperty("os.name");
System.out.println("當前系統(tǒng)為：" + osName);
Map<String, Person> map = applicationContext.getBeansOfType(Person.class);
System.out.println(map);
}
運行結果如下：
我是運行在windows上的所以只注入了bill，嗯，沒毛病。
接著實驗linux下的情況，不能運行在linux下，但可以修改運行時參數：
修改后啟動測試方法：
結論： 一個方法只能注入一個bean實例，所以@Conditional標注在方法上只能控制一個bean實例是否注入。
2.2 標注在類上
一個類中可以注入很多實例，@Conditional標注在類上就決定了一批bean是否注入。
我們試一下，將BeanConfig改寫，這時，如果WindowsCondition返回true，則兩個Person實例將被注入(注意：上一個測試將os.name改為linux，這是我將把這個參數去掉)：
@Conditional({WindowsCondition.class})
@Configuration
public class BeanConfig {
@Bean(name = "bill")
public Person person1(){
return new Person("Bill Gates",62);
}
@Bean("linus")
public Person person2(){
return new Person("Linus",48);
}
}
結果兩個實例都被注入：
如果將類上的 WindowsCondition.class 改為 LinuxCondition.class，結果應該可以猜到： 
結果就是空的，類中所有bean都沒有注入。
3.多個條件類
前言中說，@Conditional注解傳入的是一個Class數組，存在多種條件類的情況。
這種情況貌似判斷難度加深了，測試一波，新增新的條件類，實現的matches返回false（這種寫死返回false的方法純屬測試用，沒有實際意義O(∩_∩)O）
public class ObstinateCondition implements Condition {
@Override
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
return false;
}
}
BeanConfig修改一下：
@Conditional({WindowsCondition.class,ObstinateCondition.class})
@Configuration
public class BeanConfig {
@Bean(name = "bill")
public Person person1(){
return new Person("Bill Gates",62);
}
@Bean("linus")
public Person person2(){
return new Person("Linus",48);
}
}
結果：
現在如果將 ObstinateCondition 的 matches 方法返回值改成true，兩個bean就被注入進容器：
3.1 結論
第一個條件類實現的方法返回true，第二個返回false，則結果false，不注入進容器。
第一個條件類實現的方法返回true，第二個返回true，則結果true，注入進容器中。
到此這篇關于Spring中@Conditional注解的詳細講解及示例的文章就介紹到這了,更多相關@Conditional注解詳細講解內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
Java通過wait()和notifyAll()方法實現線程間通信
這篇文章主要為大家詳細介紹了Java通過wait()和notifyAll()方法實現線程間通信的相關資料，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-04-04
這篇文章主要介紹了SpringBoot中的自定義starter,Starter是Spring?Boot中的一個非常重要的概念,Starter相當于模塊,它能將模塊所需的依賴整合起來并對模塊內的Bean根據環(huán)境(條件)進行自動配置,需要的朋友可以參考下2024-01-01
java的arraylist排序示例(arraylist用法)
這篇文章主要介紹了java的arraylist排序示例，學習一下arraylist的用法,需要的朋友可以參考下2014-03-03
spring boot整合scurity做簡單的登錄校驗的實現
這篇文章主要介紹了spring boot整合scurity做簡單的登錄校驗的實現，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-04-04
這篇文章主要介紹了Java并發(fā)之串行線程池實例解析，分享了相關代碼示例，小編覺得還是挺不錯的，具有一定借鑒價值，需要的朋友可以參考下2018-02-02
這篇文章主要介紹了Java設計模式編程中的訪問者模式,訪問者模式的合理利用可以避免項目中出現大量重復的代碼,需要的朋友可以參考下2016-02-02
Java工程的Resources目錄從基礎到高級應用深入探索
這篇文章主要介紹了Java工程中的resources目錄,從基礎概念到高級應用,涵蓋了如何創(chuàng)建、使用以及資源文件的加載方法,文中通過代碼介紹的非常詳細,需要的朋友可以參考下2025-01-01
這篇文章主要介紹了如何使用Java注解和反射實現JSON字段自動重命名,文中通過代碼示例和圖文介紹的非常詳細,對大家的學習或工作有一定的幫助,需要的朋友可以參考下2024-08-08
Java獲取指定父節(jié)點、子節(jié)點的方法實現
在Java中,要獲取指定節(jié)點的父節(jié)點和子節(jié)點,通常需要使用 DOM,文中通過示例代碼介紹的非常詳細,需要的朋友們下面隨著小編來一起學習學習吧2024-02-02
獲取Bean對象也叫做對象裝配，就是把對象取出來放到某個類中，有時候也叫對象注入，這篇文章主要介紹了Spring使用注解進行對象裝配(DI),需要的朋友可以參考下2023-07-07