前言

• SpringBoot內部提供了特有的註解：條件註解(Conditional Annotation)。比如@ConditionalOnBean、@ConditionalOnClass、@ConditionalOnExpression、@ConditionalOnMissingBean等。

• 條件註解存在的意義在於動態識別(也可以說是程式碼自動化執行)。比如@ConditionalOnClass會檢查類載入器中是否存在對應的類，如果有的話被註解修飾的類就有資格被Spring容器所註冊，否則會被skip。

一、條件註解內部

在分析條件註解的底層實現之前，我們先來看一下這些條件註解的定義。以@ConditionalOnClass註解為例，它的定義如下：

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnClassCondition.class)
public @interface ConditionalOnClass {
  Class<?>[] value() default {}; // 需要匹配的類
  String[] name() default {}; // 需要匹配的類名
}

它有2個屬性，分別是類陣列和字串陣列(作用一樣，型別不一樣)，而且被@Conditional註解所修飾，這個@Conditional註解有個名為values的Class< ? extends Condition >[]型別的屬性。 這個Condition是個介面，用於匹配元件是否有資格被容器註冊，定義如下：

public interface Condition {
      // ConditionContext內部會儲存Spring容器、應用程式環境資訊、資源載入器、類載入器
      boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);
    }

也就是說@Conditional註解屬性中可以持有多個Condition介面的實現類，所有的Condition介面需要全部匹配成功後這個@Conditional修飾的元件才有資格被註冊。

Condition介面有個子介面ConfigurationCondition：

public interface ConfigurationCondition extends Condition {

  ConfigurationPhase getConfigurationPhase();

  public static enum ConfigurationPhase {

    PARSE_CONFIGURATION,

    REGISTER_BEAN
  }

}

這個子介面是一種特殊的條件介面，多了一個getConfigurationPhase方法，也就是條件註解的生效階段。只有在ConfigurationPhase中定義的兩種階段下才會生效。

Condition介面有個實現抽象類SpringBootCondition，SpringBoot中所有條件註解對應的條件類都繼承這個抽象類。它實現了matches方法：

@Override
public final boolean matches(ConditionContext context,
        AnnotatedTypeMetadata metadata) {
  String classOrMethodName = getClassOrMethodName(metadata); // 得到類名或者方法名(條件註解可以作用的類或者方法上)
  try {
    ConditionOutcome outcome = getMatchOutcome(context, metadata); // 抽象方法，具體子類實現。ConditionOutcome記錄了匹配結果boolean和log資訊
    logOutcome(classOrMethodName, outcome); // log記錄一下匹配資訊
    recordEvaluation(context, classOrMethodName, outcome); // 報告記錄一下匹配資訊
    return outcome.isMatch(); // 返回是否匹配
  }
  catch (NoClassDefFoundError ex) {
    throw new IllegalStateException(
            "Could not evaluate condition on " + classOrMethodName + " due to "
                    + ex.getMessage() + " not "
                    + "found. Make sure your own configuration does not rely on "
                    + "that class. This can also happen if you are "
                    + "@ComponentScanning a springframework package (e.g. if you "
                    + "put a @ComponentScan in the default package by mistake)",
            ex);
  }
  catch (RuntimeException ex) {
    throw new IllegalStateException(
            "Error processing condition on " + getName(metadata), ex);
  }
}

二、基於Class的條件註解

SpringBoot提供了兩個基於Class的條件註解：@ConditionalOnClass(類載入器中存在指明的類)或者@ConditionalOnMissingClass(類載入器中不存在指明的類)。

@ConditionalOnClass或者@ConditionalOnMissingClass註解對應的條件類是OnClassCondition，定義如下：

@Order(Ordered.HIGHEST_PRECEDENCE) // 優先順序、最高級別
class OnClassCondition extends SpringBootCondition {

  @Override
  public ConditionOutcome getMatchOutcome(ConditionContext context,
        AnnotatedTypeMetadata metadata) {

    StringBuffer matchMessage = new StringBuffer(); // 記錄匹配資訊

    MultiValueMap<String, Object> onClasses = getAttributes(metadata,
            ConditionalOnClass.class); // 得到@ConditionalOnClass註解的屬性
    if (onClasses != null) { // 如果屬性存在
        List<String> missing = getMatchingClasses(onClasses, MatchType.MISSING,
                context); // 得到在類載入器中不存在的類
        if (!missing.isEmpty()) { // 如果存在類載入器中不存在對應的類，返回一個匹配失敗的ConditionalOutcome
            return ConditionOutcome
                    .noMatch("required @ConditionalOnClass classes not found: "
                            + StringUtils.collectionToCommaDelimitedString(missing));
        }
                // 如果類載入器中存在對應的類的話，匹配資訊進行記錄
        matchMessage.append("@ConditionalOnClass classes found: "
                + StringUtils.collectionToCommaDelimitedString(
                        getMatchingClasses(onClasses, MatchType.PRESENT, context)));
    }
        // 對@ConditionalOnMissingClass註解做相同的邏輯處理(說明@ConditionalOnClass和@ConditionalOnMissingClass可以一起使用)
    MultiValueMap<String, Object> onMissingClasses = getAttributes(metadata,
            ConditionalOnMissingClass.class);
    if (onMissingClasses != null) {
        List<String> present = getMatchingClasses(onMissingClasses, MatchType.PRESENT,
                context);
        if (!present.isEmpty()) {
            return ConditionOutcome
                    .noMatch("required @ConditionalOnMissing classes found: "
                            + StringUtils.collectionToCommaDelimitedString(present));
        }
        matchMessage.append(matchMessage.length() == 0 ? "" : " ");
        matchMessage.append("@ConditionalOnMissing classes not found: "
                + StringUtils.collectionToCommaDelimitedString(getMatchingClasses(
                        onMissingClasses, MatchType.MISSING, context)));
    }
        // 返回全部匹配成功的ConditionalOutcome
    return ConditionOutcome.match(matchMessage.toString());
    }

  private enum MatchType { // 列舉：匹配型別。用於查詢類名在對應的類載入器中是否存在。

    PRESENT { // 匹配成功
        @Override
        public boolean matches(String className, ConditionContext context) {
            return ClassUtils.isPresent(className, context.getClassLoader());
        }
    },

    MISSING { // 匹配不成功
        @Override
        public boolean matches(String className, ConditionContext context) {
            return !ClassUtils.isPresent(className, context.getClassLoader());
        }
    };

    public abstract boolean matches(String className, ConditionContext context);

  }

}

SpringBoot還提供了其他比如ConditionalOnBean、ConditionalOnJava、ConditionalOnNotWebApplication、ConditionalOnWebApplication、ConditionalOnResource、ConditionalOnProperty、ConditionalOnExpression等條件註解，有興趣的讀者可以自行檢視它們的底層處理邏輯。

三、各種條件註解的總結

四、SpringBoot條件註解的啟用機制

想了解SpringBoot條件註解的啟用機制的可以參考原文章；