前言

在Spring Boot的自動配置中經?？吹紷ConditionalOnProperty注解的使用，本篇文章帶大家來了解一下該注解的功能。下面話不多說了，來一起看看詳細的介紹吧。

Spring Boot中的使用

在Spring Boot的源碼中，比如涉及到Http編碼的自動配置、數據源類型的自動配置等大量的使用到了@ConditionalOnProperty的注解。

HttpEncodingAutoConfiguration類中部分源代碼：

@Configuration(proxyBeanMethods = false)@EnableConfigurationProperties(HttpProperties.class)@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)@ConditionalOnClass(CharacterEncodingFilter.class)@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)public class HttpEncodingAutoConfiguration {  // 省略內部代碼}

DataSourceConfiguration類中部分代碼：

@Configuration(proxyBeanMethods = false)@ConditionalOnClass(org.apache.tomcat.jdbc.pool.DataSource.class)@ConditionalOnMissingBean(DataSource.class)@ConditionalOnProperty(name = "spring.datasource.type", havingValue = "org.apache.tomcat.jdbc.pool.DataSource",    matchIfMissing = true)static class Tomcat { // 省略內部代碼}

很顯然，以上兩個自動配置類中都通過@ConditionalOnProperty來控制自動配置是否生效，下面我們來了解一下它的源碼和具體使用。

@ConditionalOnProperty源碼說明

@ConditionalOnProperty注解類源碼如下：

@Retention(RetentionPolicy.RUNTIME)@Target({ ElementType.TYPE, ElementType.METHOD })@Documented@Conditional(OnPropertyCondition.class)public @interface ConditionalOnProperty {  // 數組，獲取對應property名稱的值，與name不可同時使用  String[] value() default {};  // 配置屬性名稱的前綴，比如spring.http.encoding  String prefix() default "";  // 數組，配置屬性完整名稱或部分名稱  // 可與prefix組合使用，組成完整的配置屬性名稱，與value不可同時使用  String[] name() default {};  // 可與name組合使用，比較獲取到的屬性值與havingValue給定的值是否相同，相同才加載配置  String havingValue() default "";  // 缺少該配置屬性時是否可以加載。如果為true，沒有該配置屬性時也會正常加載；反之則不會生效  boolean matchIfMissing() default false;}

其中在歷史版本中還存在一個relaxedNames屬性：

//是否可以松散匹配boolean relaxedNames() default true;

最新版本中已經不存在該屬性了。

通過注解ConditionalOnProperty上的@Conditional(OnPropertyCondition.class)代碼，可以看出ConditionalOnProperty屬于@Conditional的衍生注解。生效條件由OnPropertyCondition來進行判斷。

使用方法

關于@ConditionalOnProperty的使用方法，我們在上面的Spring Boot中的使用已經看到。

@ConditionalOnProperty的核心功能是通過屬性name以及havingValue來實現的。

首先看matchIfMissing屬性，用來指定如果配置文件中未進行對應屬性配置時的默認處理：默認情況下matchIfMissing為false，也就是說如果未進行屬性配置，則自動配置不生效。如果matchIfMissing為true，則表示如果沒有對應的屬性配置，則自動配置默認生效。