springboot根據不一樣的條件建立bean，動態建立bean，@Conditional註解使用

 

 

這個需求應該也比較常見，在不一樣的條件下建立不一樣的bean，具體場景不少，能看到這篇的確定懂個人意思。

假若不瞭解spring4.X新加入的@Conditional註解的話，要實現不一樣條件建立不一樣的bean仍是比較麻煩的，可能須要硬編碼一些東西作if判斷。那麼如今有個@Conditional註解後，事情就簡單多了。用法很簡單，直接上代碼。

新建一個springboot項目，添加一個Configuration標註的類，咱們經過不一樣的條件表達式來建立bean。

 

1.  
   package com.tianyalei.condition;
2.  
    
3.  
   import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
4.  
   import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
5.  
   import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
6.  
   import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
7.  
   import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
8.  
   import org.springframework.context.annotation.Bean;
9.  
   import org.springframework.context.annotation.Conditional;
10.  
    import org.springframework.context.annotation.Configuration;
11.  
     
12.  
    /**
13.  
    * Created by wuweifeng on 2017/10/11.
14.  
    */
15.  
    @Configuration
16.  
    public class Config {
17.  
     
18.  
    @Conditional(MyCondition.class)
19.  
    @Bean
20.  
    public String condition() {
21.  
    System.err.println( "自定義的condition的match方法返回值爲true時，纔會進入該方法建立bean");
22.  
    return "";
23.  
    }
24.  
     
25.  
    /**
26.  
    * 該Abc class位於類路徑上時
27.  
    */
28.  
    @ConditionalOnClass(Abc.class)
29.  
    @Bean
30.  
    public String abc() {
31.  
    System.err.println( "ConditionalOnClass true");
32.  
    return "";
33.  
    }
34.  
     
35.  
    // @ConditionalOnClass(Abc.class)
36.  
    // @Bean
37.  
    // public Abc newAbc() {
38.  
    // System.err.println("ConditionalOnClass true");
39.  
    // return new Abc();
40.  
    // }
41.  
     
42.  
    /**
43.  
    * 存在Abc類的實例時
44.  
    */
45.  
    @ConditionalOnBean(Abc.class)
46.  
    @Bean
47.  
    public String bean() {
48.  
    System.err.println( "ConditionalOnBean is exist");
49.  
    return "";
50.  
    }
51.  
     
52.  
    @ConditionalOnMissingBean(Abc.class)
53.  
    @Bean
54.  
    public String missBean() {
55.  
    System.err.println( "ConditionalOnBean is missing");
56.  
    return "";
57.  
    }
58.  
     
59.  
    /**
60.  
    * 表達式爲true時
61.  
    */
62.  
    @ConditionalOnExpression(value = "true")
63.  
    @Bean
64.  
    public String expresssion() {
65.  
    System.err.println( "expresssion is true");
66.  
    return "";
67.  
    }
68.  
     
69.  
    /**
70.  
    * 配置文件屬性是否爲true
71.  
    */
72.  
    @ConditionalOnProperty(
73.  
    value = { "abc.property"},
74.  
    matchIfMissing = false)
75.  
    @Bean
76.  
    public String property() {
77.  
    System.err.println( "property is true");
78.  
    return "";
79.  
    }
80.  
    }

 

這裏面有個空類Abc.class，你能夠就建立個叫Abc的類，裏面是空的就行。

 

1.  
   import org.springframework.context.annotation.Condition;
2.  
   import org.springframework.context.annotation.ConditionContext;
3.  
   import org.springframework.core.type.AnnotatedTypeMetadata;
4.  
    
5.  
   /**
6.  
   * Created by wuweifeng on 2017/10/11.
7.  
   */
8.  
   public class MyCondition implements Condition {
9.  
   @Override
10.  
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
11.  
    //判斷當前系統是Mac，Windows，Linux
12.  
    return conditionContext.getEnvironment().getProperty("os.name").contains("Mac");
13.  
    }
14.  
    }

 

@Conditional(MyCondition.class)
這句代碼能夠標註在類上面，表示該類下面的全部@Bean都會啓用配置
也能夠標註在方法上面，只是對該方法啓用配置


除了本身自定義Condition以外，Spring還提供了不少Condition給咱們用
@ConditionalOnBean（僅僅在當前上下文中存在某個對象時，纔會實例化一個Bean）
@ConditionalOnClass（某個class位於類路徑上，纔會實例化一個Bean）
@ConditionalOnExpression（當表達式爲true的時候，纔會實例化一個Bean）
@ConditionalOnMissingBean（僅僅在當前上下文中不存在某個對象時，纔會實例化一個Bean）
@ConditionalOnMissingClass（某個class類路徑上不存在的時候，纔會實例化一個Bean）
@ConditionalOnNotWebApplication（不是web應用）

以上是一些經常使用的註解，其實就是條件判斷，若是爲true了就建立Bean，爲false就不建立，就這麼簡單。

這些註解裏的條件能夠是多個，也能夠賦默認值，也能夠標註在類上，若是標註在類上，則對類裏的全部@Bean方法都生效。

其中@ConditionalOnProperty是指在application.yml裏配置的屬性是否爲true，其餘的幾個都是對class的判斷。

我在配置里加上abc.property = true這個配置就能夠測試上面的代碼了。

而後再來一個對類進行多個條件標註的例子：

 

1.  
   package com.tianyalei.condition;
2.  
    
3.  
   import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
4.  
   import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
5.  
   import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
6.  
   import org.springframework.context.annotation.Bean;
7.  
   import org.springframework.context.annotation.Configuration;
8.  
    
9.  
   /**
10.  
    * Created by wuweifeng on 2017/10/11.
11.  
    */
12.  
    @Configuration
13.  
    @ConditionalOnProperty(
14.  
    value = { "abc.property"},
15.  
    matchIfMissing = false
16.  
    )
17.  
    @ConditionalOnClass(Abc.class)
18.  
    public class Multi {
19.  
    @Bean
20.  
    @ConditionalOnMissingBean({Abc.class})
21.  
    public String check() {
22.  
    System.err.println( "multi check");
23.  
    return "check";
24.  
    }
25.  
    }

OK，代碼很簡單，運行看看結果

 

可能上面的那些你用的地方不常見，那我來舉一個我正在使用的例子。個人應用是基於SpringCloud的，在線上部署時有eureka來作註冊中心，而在本地環境下，個人應用是單機的，不須要eureka，可是代碼裏已經引入了eureka了，每次啓動就會自動去鏈接eureka，而後控制檯就開始報錯。雖然不影響功能，可是看着一直不停的報錯也是不順眼。

那麼我就可使用Condition註解來解決它。

 

1.  
   /**
2.  
   * @author wuweifeng wrote on 2017/11/25.
3.  
   * 根據部署環境動態決定是否啓用eureka
4.  
   */
5.  
   @Component
6.  
   @ConditionalOnProperty(value = "open.eureka")
7.  
   @EnableDiscoveryClient
8.  
   public class JudgeEnableDiscoveryClient {
9.  
   }

我把EnableDiscoveryClient這個註解單獨放個類裏，裏面什麼也不寫，條件就是application.yml裏配置的open.eureka
若是我只想讓線上的環境開啓eureka，那麼我就在application-prod.yml裏配上open.eureka=true，其餘的yml什麼也不寫就好了。這樣本地啓動時就至關於沒有開啓EnableDiscoveryClient。

 

使用場景仍是蠻多的，具體的看狀況，可是須要記住有這麼個註解，以便不時之需。