Spring Boot中的那些條件判斷

Nekron 發(fā)布于2019-08-19 11:36 / 3246人閱讀

摘要：通過操作系統(tǒng)進(jìn)行條件判斷，從而進(jìn)行配置。分別對布爾，字符串和數(shù)字三種類型進(jìn)行判斷。通過指定的資源文件是否存在進(jìn)行條件判斷，比如判斷來決定是否自動裝配組件。判斷當(dāng)前環(huán)境是否是應(yīng)用。

Spring Boot中的那些Conditional

spring boot中為我們提供了豐富的Conditional來讓我們得以非常方便的在項目中向容器中添加Bean。本文主要是對各個注解進(jìn)行解釋并輔以代碼說明其用途。

所有ConditionalOnXXX的注解都可以放置在class或是method上，如果方式在class上，則會決定該class中所有的@Bean注解方法是否執(zhí)行。

@Conditional

下面其他的Conditional注解均是語法糖，可以通過下面的方法自定義ConditionalOnXXX
Conditional注解定義如下，接收實現(xiàn)Condition接口的class數(shù)組。

public @interface Conditional {
    Class[] value();
}

而Condition接口只有一個matchs方法，返回是否匹配的結(jié)果。

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

通過操作系統(tǒng)進(jìn)行條件判斷，從而進(jìn)行Bean配置。當(dāng)Window時，實例化Bill的Person對象，當(dāng)Linux時，實例化Linus的Person對象。

//LinuxCondition,為方便起見，去掉判斷代碼，直接返回true了
public class LinuxCondition implements Condition {
    @Override
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
        return true;
    }
}

//WindowsCondition,為方便起見，去掉判斷代碼，直接返回false了
public class WindowsCondition implements Condition {
    @Override
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata metadata) {
        return false;
    }
}

@Data
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class Person {
    private String name;
    private Integer age;
}

//配置類
@Configuration
public class BeanConfig {

    @Bean(name = "bill")
    @Conditional({WindowsCondition.class})
    public Person person1(){
        return new Person("Bill Gates",62);
    }

    @Bean("linus")
    @Conditional({LinuxCondition.class})
    public Person person2(){
        return new Person("Linus",48);
    }
}

public class AppTest {
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);

    @Test
    public void test(){
        String osName = applicationContext.getEnvironment().getProperty("os.name");
        System.out.println("當(dāng)前系統(tǒng)為：" + osName);
        Map map = applicationContext.getBeansOfType(Person.class);
        System.out.println(map);
    }
}

輸出的結(jié)果：

當(dāng)前系統(tǒng)為：Mac OS X
{linus=Person(name=Linus, age=48)}

@ConditionalOnBean & @ConditionalOnMissingBean

這兩個注解會對Bean容器中的Bean對象進(jìn)行判斷，使用的例子是配置的時候，如果發(fā)現(xiàn)如果沒有Computer實例，則實例化一個備用電腦。

@Data
@AllArgsConstructor
@ToString
public class Computer {
    private String name;
}

@Configuration
public class BeanConfig {
    @Bean(name = "notebookPC")
    public Computer computer1(){
        return new Computer("筆記本電腦");
    }

    @ConditionalOnMissingBean(Computer.class)
    @Bean("reservePC")
    public Computer computer2(){
        return new Computer("備用電腦");
    }
}

public class TestApp {
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);
    @Test
    public void test1(){
        Map map = applicationContext.getBeansOfType(Computer.class);
        System.out.println(map);
    }
}

修改BeanConfig,如果注釋掉第一個@Bean,會實例化備用電腦，否則就不會實例化備用電腦

@ConditionalOnClass & @ConditionalOnMissingClass

這個注解會判斷類路徑上是否有指定的類，一開始看到的時候比較困惑，類路徑上如果沒有指定的class,那編譯也通過不了啊...這個主要用于集成相同功能的第三方組件時用，只要類路徑上有該組件的類，就進(jìn)行自動配置，比如spring boot web在自動配置視圖組件時，是用Velocity，還是Thymeleaf,或是freemaker時，使用的就是這種方式。
例子是兩套盔甲A(光明套裝)和B(暗黑套裝)，如果A不在則配置B。

public interface Fighter {
    void fight();
}
public class FighterA implements Fighter {
    @Override
    public void fight() {
        System.out.println("使用光明套裝");
    }
}
public class FighterB implements Fighter {
    @Override
    public void fight() {
        System.out.println("使用暗黑套裝");
    }
}

Van是武士，使用套裝進(jìn)行戰(zhàn)斗

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Van {
    private Fighter fighter;
    public void fight(){
        fighter.fight();
    }
}

VanConfigA/B實例化武士

@Configuration
@ConditionalOnClass({FighterA.class})
public class VanConfigA {
    @Primary
    @Bean
    public Van vanA(){
        return new Van(new FighterA());
    }
}
@Configuration
@ConditionalOnClass({FighterB.class})
public class VanConfigB {
    @Bean
    public Van vanB(){
        return new Van(new FighterB());
    }
}

測試類,默認(rèn)情況，如果套裝AB都在類路徑上，兩套都會加載，A會設(shè)置為PRIMARY，如果在target class中將FightA.class刪除，則只會加載套裝B。

@SpringBootApplication
public class TestApp implements CommandLineRunner {
    @Autowired
    private Van van;
    public static void main(String[] args) {
        SpringApplication.run(TestApp.class, args);
    }
    @Override
    public void run(String... args) throws Exception {
        //do something
       van.fight();
    }
}

另外，嘗試將兩個VanConfigA/B合并，將注解ConditionalOnClass放到方法上，如果刪除一個套裝就會運行出錯。

@ConditionalOnExpress

依據(jù)表達(dá)式進(jìn)行條件判斷，這個作用和@ConditionalOnProperty大部分情況可以通用，表達(dá)式更靈活一點,因為可以使用SpEL。例子中會判斷properties中test.enabled的值進(jìn)行判斷。BeanConfig分別對布爾，字符串和數(shù)字三種類型進(jìn)行判斷。數(shù)字嘗試了很多其他的方式均不行，比如直接使用==，貌似配置的屬性都會當(dāng)成字符串來處理。

@Data
public class TestBean {
    private String name;
}

@Configuration
@ConditionalOnExpression("#{${test.enabled:true} }")
//@ConditionalOnExpression(""zz".equalsIgnoreCase("${test.name2}")")
//@ConditionalOnExpression("new Integer("${test.account}")==1")
public class BeanConfig {
    @Bean
    public TestBean testBean(){
        return new TestBean("我是美猴王");
    }
}

@SpringBootApplication
public class TestAppCommand implements CommandLineRunner {
    @Autowired
    private TestBean testBean;

    public static void main(String[] args) {
        SpringApplication.run(TestAppCommand.class, args);
    }

    @Override
    public void run(String... args) throws Exception {
        System.out.println(testBean.getName());
    }
}

@ConditionalOnProperty

適合對單個Property進(jìn)行條件判斷，而上面的@ConditionalOnExpress適合面對較為復(fù)雜的情況，比如多個property的關(guān)聯(lián)比較。這個例子也給了三種基本類型的條件判斷，不過貌似均當(dāng)成字符串就可以...

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

@Configuration
@ConditionalOnProperty(prefix = "test", name="enabled", havingValue = "true",matchIfMissing = false)
//@ConditionalOnProperty(prefix = "test", name="account", havingValue = "1",matchIfMissing = false)
//@ConditionalOnProperty(prefix = "test", name="name1", havingValue = "zz",matchIfMissing = false)
public class BeanConfig {

    @Bean
    public TestBean testBean(){
        return new TestBean("我是美猴王");
    }
}

@SpringBootApplication
public class TestAppCommand implements CommandLineRunner {
    @Autowired
    private TestBean testBean;
    public static void main(String[] args) {
        SpringApplication.run(TestAppCommand.class, args);
    }
    @Override
    public void run(String... args) throws Exception {
        System.out.println(testBean.getName());

    }
}

@ConditionalOnJava

可以通過java的版本進(jìn)行判斷。

@Data
public class TestBean {
}

@Configuration
@ConditionalOnJava(JavaVersion.EIGHT)
public class BeanConfig {

    @Bean
    public TestBean testBean(){
        return new TestBean();
    }
}

public class TestApp {
    AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(BeanConfig.class);
    @Test
    public void test(){
        Map map = context.getBeansOfType(TestBean.class);
        System.out.println(map);
    }
}

@ConditionalOnResource

通過指定的資源文件是否存在進(jìn)行條件判斷，比如判斷ehcache.properties來決定是否自動裝配ehcache組件。

@Data
public class TestBean {
}

@Configuration
@ConditionalOnResource(resources = "classpath:application.yml")
public class BeanConfig {

    @Bean
    public TestBean testBean(){
        return new TestBean();
    }
}

public class TestApp {
    AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(BeanConfig.class);

    @Test
    public void test(){
        Map map = context.getBeansOfType(TestBean.class);
        System.out.println(map);
    }
}

@ConditionalOnSingleCandidate

這個還沒有想到應(yīng)用場景，條件通過的條件是：1 對應(yīng)的bean容器中只有一個 2.對應(yīng)的bean有多個，但是已經(jīng)制定了PRIMARY。例子中，BeanB裝配的時候需要看BeanA的裝配情況，所以BeanBConfig要排在BeanAConfig之后.可以修改BeanAConfig,將@Primary注解去掉，或者把三個@Bean注解去掉，BeanB就不會實例化了。

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

@Configuration
public class BeanAConfig {

    @Bean
    @Primary
    public BeanA bean1(){
        return new BeanA("bean1");
    }
    @Bean(autowireCandidate = false)
    public BeanA bean2(){
        return new BeanA("bean2");
    }
    //@Bean(autowireCandidate = false)
    public BeanA bean3(){
        return new BeanA("bean3");
    }
}

@Data
public class BeanB {
}

@Configuration
@AutoConfigureAfter(BeanAConfig.class)
@ConditionalOnSingleCandidate(BeanA.class)
public class BeanBConfig {

    @Bean
    public BeanB targetBean(){
        return new BeanB();
    }
}

public class TestApp {
    AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(BeanAConfig.class, BeanBConfig.class);

    @Test
    public void test(){
        Map map = context.getBeansOfType(BeanA.class);
        System.out.println(map);
        Map map2 = context.getBeansOfType(BeanB.class);
        System.out.println(map2);
    }
}

@ConditionalOnNotWebApplication & @ConditionalOnWebApplication

判斷當(dāng)前環(huán)境是否是Web應(yīng)用。

文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址：http://www.ezyhdfw.cn/yun/77536.html

發(fā)表評論

登陸后可評論

0條評論

Nekron

男|高級講師

我要關(guān)注我要私信

TA的文章

tensorflow

閱讀 2124·2023-04-26 02:23
芯片短缺重創(chuàng)汽車行業(yè) 福特8月美國汽車銷量驟降33%

閱讀 1862·2021-09-03 10:30
從css到頁面樣式渲染

閱讀 1432·2019-08-30 15:43
深入理解css之float

閱讀 1266·2019-08-29 16:29
重溫"什么是響應(yīng)式網(wǎng)頁設(shè)計？響應(yīng)式布局的實現(xiàn)原理"

閱讀 627·2019-08-29 12:28
微任務(wù)、宏任務(wù)與Event-Loop

閱讀 2400·2019-08-26 12:13
iOS Android中 h5鍵盤遮擋輸入框的問題和解決方案

閱讀 2365·2019-08-26 12:01
Touch UI：基于vue的移動端UI框架

閱讀 2490·2019-08-26 11:56

亚洲中字慕日产2020,大陆极品少妇内射AAAAAA,无码av大香线蕉伊人久久,久久精品国产亚洲av麻豆网站

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！

Spring Boot中的那些條件判斷

相關(guān)文章

Spring Boot [組件學(xué)習(xí)-Spring Data JPA]

Spring-Boot學(xué)習(xí)筆記

**《 Kotlin + Spring Boot ：下一代 Java 服務(wù)端開發(fā) 》**

**第二十八章：SpringBoot使用AutoConfiguration自定義Starter**

Spring Boot 2.0 整合 Thymeleaf 模塊引擎

發(fā)表評論

0條評論

Nekron

男|高級講師

TA的文章

tensorflow

芯片短缺重創(chuàng)汽車行業(yè) 福特8月美國汽車銷量驟降33%

從css到頁面樣式渲染

深入理解css之float

重溫"什么是響應(yīng)式網(wǎng)頁設(shè)計？響應(yīng)式布局的實現(xiàn)原理"

微任務(wù)、宏任務(wù)與Event-Loop

iOS Android中 h5鍵盤遮擋輸入框的問題和解決方案

Touch UI：基于vue的移動端UI框架

最新活動

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！

Spring Boot中的那些條件判斷

相關(guān)文章

發(fā)表評論

0條評論

男|高級講師

TA的文章

最新活動

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！