Spring Boot 自動配置之條件註解

來醉一場發表於2019-02-19

Spring Boot 神奇的自動配置,主要依靠大量的條件註解來使用配置自動化。

根據滿足某一個特定條件建立一個特定的Bean。比如說,在某些系統變數下建立Bean,或者只有在某個Bean建立後才去建立另外一個Bean. 就是根據條件來控制Bean的建立行為,可以利用該特性來進行一些自動配置。

一、常用的條件註解

  • @Conditional 依賴的條件
  • @ConditionalOnBean 在某個Bean存在的條件下
  • @ConditionalOnMissingBean 在某個Bean不存在的條件下
  • @ConditionalOnClass 在某個Class存在的條件下
  • @ConditionalOnMissingClass 在某個Class不存在的條件下

比較常見的是這些註解,還有其它的比如 @ConditionalOnWebApplication, @ConditionalOnProperty 等,可舉一反三

二、特別說明 @Conditional 註解

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {

	/**
	 * All {@link Condition Conditions} that must {@linkplain Condition#matches match}
	 * in order for the component to be registered.
	 */
	Class<? extends Condition>[] value();

}
複製程式碼

使用@Conditional註解,物件需要實現Condition介面,Condition 介面是一個函式式介面

@FunctionalInterface
public interface Condition {

	boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);
}

複製程式碼

三、條件註解示例

示例場景:專案中動態的配置Mysql或者Oracle資料來源

1. 定義配置檔案

db-type=oracle
複製程式碼

2. 定義Condition類

MySqlCondition.java

public class MySqlCondition implements Condition {

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return "mysql".equals(context.getEnvironment().getProperty("db-type"));
    }
}
複製程式碼

OracleCondition.java

public class OracleCondition implements Condition {

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return "oracle".equals(context.getEnvironment().getProperty("db-type"));
    }
}
複製程式碼

獲取配置檔案db-type的值

3. JdbcFactory介面

public interface JdbcFactory {

    void create();
}
複製程式碼

4. 預設的Mysql和Oracle實現

Mysql

@ConditionalOnMissingBean(value = JdbcFactory.class, ignored = MySqlDefaultFactory.class)
@Conditional(MySqlCondition.class)
@Component
public class MySqlDefaultFactory implements JdbcFactory {

    @Override
    public void create() {
        System.out.println("Default MySql create ..");
    }

}

複製程式碼

Oracle

@ConditionalOnMissingBean(value = JdbcFactory.class, ignored = OracleDefaultFactory.class)
@Conditional(OracleCondition.class)
@Component
public class OracleDefaultFactory implements JdbcFactory {

    @Override
    public void create() {
        System.out.println("Default oracle create..");
    }
}
複製程式碼

5. 測試預設實現方式

@Resource
private JdbcFactory jdbcFactory;

@Test
public void conditionOnMissBean() {
    jdbcFactory.create();
}
複製程式碼

結果:

Default MySql create ..
複製程式碼

6. 自定義實現方式

@Component
public class MysqlFactory implements JdbcFactory {

    @Override
    public void create() {
        System.out.println("mysql 。。 create");
    }
}
複製程式碼

7. 測試

@Resource
private JdbcFactory jdbcFactory;

@Test
public void conditionOnMissBean() {
    jdbcFactory.create();
}
複製程式碼

結果:

mysql 。。 create
複製程式碼

8.解析

當環境中不存在 JdbcFactory 的Bean時則使用預設的實現的方式,如例:沒有自定義實現時,則預設使用MySqlDefaultFactory。這在自動化配置中會經常用到。比如redisTemplate 的預設實現

四、GitHub原始碼

原始碼地址

相關文章