3 核心註解

開啟任意*AutoConfiguration檔案，一般都有下面的條件註解，在spring-boot-autoconfigure-1.5.3.RELEASE.jar的org.springframework.boot.autoconfigure.condition包下條件註解如下：

• @ConditionalOnBean：當前容器有指定Bean的條件下。
• @ConditionalOnClass：當前類路徑下有指定的類的條件下。
• @ConditionalOnExpression：基於SpEL表示式作為判斷條件。
• @ConditionalOnJava：基於JVM版本作為判斷條件。
• @ConditionalOnJndi：在JNDI存在的條件下查詢指定的位置。
• @ConditionalOnMissingBean：當容器裡沒有指定Bean的情況下。
• @ConditionalOnMissingClass：當類路徑下沒有指定的類的條件下。
• @ConditionalOnNotWebApplication：當前專案不是WEB專案的條件下。
• @ConditionalOnProperty：指定屬性是否有指定的值。
• @ConditionalOnResource：類路徑是否有指定的值。
• @ConditionalOnSingleCandidate：當指定Bean在容器中只有一個，或者雖然有多個但 是指定首選的Bean。
• @ConditionalOnWebApplication：當前專案是WEB專案的條件下。

這些註解都組合了@Conditional元註解，只是使用了不同的條件（Conditional），Spring 條件註解（@Conditional）我們介紹過根據不同條件建立不同Bean。

簡單分析一下@ConditionalOnWebApplication註解：

package org.springframework.boot.autoconfigure.condition;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation
 
.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.context.annotation.Conditional;

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

從原始碼我們可以看出，此註解使用的條件是OnWebApplicationCondition類，下面我們看看這個類是怎麼構造的：

package org.springframework.boot.autoconfigure.condition;

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.core.type.AnnotatedTypeMetadata;
import org.springframework.util.ClassUtils;
import org.springframework.util.ObjectUtils;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.StandardServletEnvironment;

@Order(Ordered.HIGHEST_PRECEDENCE + 20)
class OnWebApplicationCondition extends SpringBootCondition {

	private static final String WEB_CONTEXT_CLASS = "org.springframework.web.context."
			+ "support.GenericWebApplicationContext";

	@Override
	public ConditionOutcome getMatchOutcome(ConditionContext context,
			AnnotatedTypeMetadata metadata) {
		boolean webApplicationRequired = metadata
				.isAnnotated(ConditionalOnWebApplication.class.getName());
		ConditionOutcome webApplication = isWebApplication(context, metadata);

		if (webApplicationRequired && !webApplication.isMatch()) {
			return ConditionOutcome.noMatch(webApplication.getMessage());
		}

		if (!webApplicationRequired && webApplication.isMatch()) {
			return ConditionOutcome.noMatch(webApplication.getMessage());
		}

		return ConditionOutcome.match(webApplication.getMessage());
	}

	private ConditionOutcome isWebApplication(ConditionContext context,
			AnnotatedTypeMetadata metadata) {

		if (!ClassUtils.isPresent(WEB_CONTEXT_CLASS, context.getClassLoader())) {
			return ConditionOutcome.noMatch("web application classes not found");
		}

		if (context.getBeanFactory() != null) {
			String[] scopes = context.getBeanFactory().getRegisteredScopeNames();
			if (ObjectUtils.containsElement(scopes, "session")) {
				return ConditionOutcome.match("found web application 'session' scope");
			}
		}

		if (context.getEnvironment() instanceof StandardServletEnvironment) {
			return ConditionOutcome
					.match("found web application StandardServletEnvironment");
		}

		if (context.getResourceLoader() instanceof WebApplicationContext) {
			return ConditionOutcome.match("found web application WebApplicationContext");
		}

		return ConditionOutcome.noMatch("not a web application");
	}

}

從isWebApplication方法可以看出，判斷條件是：

1. GenericWebApplicationContext是否在類路徑中；
2. 容器中是否有名為session的scope；
3. 當前容器的Enviroment是否為StandardServletEnvironment；
4. 當前的ResourceLoader是否是WebApplicationContext（ResourceLoader是ApplicationContext的頂級介面之一）；
5. 我們需要構建ConditionOutcome類的物件來幫助我們，最終通過ConditionOutcome.isMatch方法返回值來確定條件。