Spring Boot中的那些條件判斷

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

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

Spring Boot中的那些Conditional

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

所有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)進行條件判斷，從而進行Bean配置。當Window時，實例化Bill的Person對象，當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("當前系統(tǒng)為：" + osName);
        Map map = applicationContext.getBeansOfType(Person.class);
        System.out.println(map);
    }
}

輸出的結(jié)果：

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

@ConditionalOnBean & @ConditionalOnMissingBean

這兩個注解會對Bean容器中的Bean對象進行判斷，使用的例子是配置的時候，如果發(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,那編譯也通過不了啊...這個主要用于集成相同功能的第三方組件時用，只要類路徑上有該組件的類，就進行自動配置，比如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是武士，使用套裝進行戰(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());
    }
}

測試類,默認情況，如果套裝AB都在類路徑上，兩套都會加載，A會設置為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ù)表達式進行條件判斷，這個作用和@ConditionalOnProperty大部分情況可以通用，表達式更靈活一點,因為可以使用SpEL。例子中會判斷properties中test.enabled的值進行判斷。BeanConfig分別對布爾，字符串和數(shù)字三種類型進行判斷。數(shù)字嘗試了很多其他的方式均不行，比如直接使用==，貌似配置的屬性都會當成字符串來處理。

@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進行條件判斷，而上面的@ConditionalOnExpress適合面對較為復雜的情況，比如多個property的關聯(lián)比較。這個例子也給了三種基本類型的條件判斷，不過貌似均當成字符串就可以...

@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的版本進行判斷。

@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

通過指定的資源文件是否存在進行條件判斷，比如判斷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

這個還沒有想到應用場景，條件通過的條件是：1 對應的bean容器中只有一個 2.對應的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

判斷當前環(huán)境是否是Web應用。

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

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

Spring Boot [組件學習-Spring Data JPA]

摘要：與的關系是什么是官方提出的持久化規(guī)范。它為開發(fā)人員提供了一種對象關聯(lián)映射工具來管理應用中的關系數(shù)據(jù)。他的出現(xiàn)主要是為了簡化現(xiàn)有的持久化開發(fā)工作和整合技術，結(jié)束現(xiàn)在，，等框架各自為營的局面。定義了在對數(shù)據(jù)庫中的對象處理查詢和事務運行時的的。導讀：在上篇文章中對Spring MVC常用的一些注解做了簡要的說明，在這篇文章中主要對Spring Data JPA 做一個簡要的說明，并附有一...

andong777 2019-08-14 17:45 評論0 收藏0
Spring-Boot學習筆記

摘要：學習筆記使用很容易創(chuàng)建一個獨立運行運行內(nèi)嵌容器準生產(chǎn)級別的基于框架的項目，使用你可以不用或者只需要很少的配置。異常消息如果這個錯誤是由異常引起的。錯誤發(fā)生時請求的路徑。 Spring-Boot 1.5 學習筆記使用Spring Boot很容易創(chuàng)建一個獨立運行（運行jar,內(nèi)嵌Servlet容器）、準生產(chǎn)級別的基于Spring框架的項目，使用Spring Boot你可以不用或者只需要很...

curlyCheng 2019-08-16 10:38 評論0 收藏0
《 Kotlin + Spring Boot ：下一代 Java 服務端開發(fā) 》

摘要：下一代服務端開發(fā)下一代服務端開發(fā)第部門快速開始第章快速開始環(huán)境準備，，快速上手實現(xiàn)一個第章企業(yè)級服務開發(fā)從到語言的缺點發(fā)展歷程的缺點為什么是產(chǎn)生的背景解決了哪些問題為什么是的發(fā)展歷程容器的配置地獄是什么從到下一代企業(yè)級服務開發(fā)在移動開發(fā)領域《 Kotlin + Spring Boot ：下一代 Java 服務端開發(fā) 》 Kotlin + Spring Boot ：下一代 Java...

springDevBird 2019-08-15 12:30 評論0 收藏0
第二十八章：SpringBoot使用AutoConfiguration自定義Starter

摘要：代碼如下所示自定義業(yè)務實現(xiàn)恒宇少年碼云消息內(nèi)容是否顯示消息內(nèi)容，我們內(nèi)的代碼比較簡單，根據(jù)屬性參數(shù)進行返回格式化后的字符串。在我們學習SpringBoot時都已經(jīng)了解到starter是SpringBoot的核心組成部分，SpringBoot為我們提供了盡可能完善的封裝，提供了一系列的自動化配置的starter插件，我們在使用spring-boot-starter-web時只需要在po...

fasss 2019-08-15 11:59 評論0 收藏0
Spring Boot 2.0 整合 Thymeleaf 模塊引擎

摘要：如果還在使用以前的版本，想要使用非嚴格的，需要做以下配置在中引入依賴在中配置更多屬性配置請參考中模塊的屬性介紹。這樣的話很好的做到了前后端分離。本文首發(fā)于：https://y0ngb1n.github.io/a/5... 開發(fā)環(huán)境 org.springframework.boot spring-boot-starter-parent 2.1.0.RELEASE ...

CoreDump 2019-08-16 13:52 評論0 收藏0