在之前我們分析SpringBoot的自動(dòng)化配置原理的時(shí)候叼屠，分析了freemarker的自動(dòng)化配置類FreeMarkerAutoConfiguration驼抹，這個(gè)自動(dòng)化配置類需要classloader中的一些類需要存在并且在其他的一些配置類之后進(jìn)行加載感憾。
但是還存在一些自動(dòng)化配置類史辙，它們需要在使用一些注解開關(guān)的情況下才會(huì)生效各淀。比如spring-boot-starter-batch里的@EnableBatchProcessing注解安皱、@EnableCaching等胯杭。
一個(gè)需求
在分析這些開關(guān)的原理之前船响，我們來(lái)看一個(gè)需求：
定義一個(gè)Annotation哈肖，讓使用了這個(gè)Annotaion的應(yīng)用程序自動(dòng)化地注入一些類或者做一些底層的事情吻育。
我們會(huì)使用Spring提供的@Import注解配合一個(gè)配置類來(lái)完成。
我們以一個(gè)最簡(jiǎn)單的例子來(lái)完成這個(gè)需求：定義一個(gè)注解EnableContentService淤井，使用了這個(gè)注解的程序會(huì)自動(dòng)注入ContentService這個(gè)bean布疼。
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(ContentConfiguration.class)
public @interface EnableContentService {}
public interface ContentService {
void doSomething();
}
public class SimpleContentService implements ContentService {
@Override
public void doSomething() {
System.out.println("do some simple things");
}
}
然后在應(yīng)用程序的入口加上@EnableContentService注解摊趾。
這樣的話，ContentService就被注入進(jìn)來(lái)了游两。 SpringBoot也就是用這個(gè)完成的砾层。只不過(guò)它用了更加高級(jí)點(diǎn)的ImportSelector。
ImportSelector的使用
用了ImportSelector之后贱案，我們可以在Annotation上添加一些屬性肛炮，然后根據(jù)屬性的不同加載不同的bean。
我們?cè)贎EnableContentService注解添加屬性policy宝踪，同時(shí)Import一個(gè)Selector侨糟。
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(ContentImportSelector.class)
public @interface EnableContentService {
String policy() default "simple";
}
這個(gè)ContentImportSelector根據(jù)EnableContentService注解里的policy加載不同的bean。
public class ContentImportSelector implements ImportSelector {
@Override
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
Class<?> annotationType = EnableContentService.class;
AnnotationAttributes attributes = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(
annotationType.getName(), false));
String policy = attributes.getString("policy");
if ("core".equals(policy)) {
return new String[] { CoreContentConfiguration.class.getName() };
} else {
return new String[] { SimpleContentConfiguration.class.getName() };
}
}
}
CoreContentService和CoreContentConfiguration如下：
public class CoreContentService implements ContentService {
@Override
public void doSomething() {
System.out.println("do some import things");
}
}
public class CoreContentConfiguration {
@Bean
public ContentService contentService() {
return new CoreContentService();
}
}
這樣的話瘩燥，如果在@EnableContentService注解的policy中使用core的話秕重，應(yīng)用程序會(huì)自動(dòng)加載CoreContentService，否則會(huì)加載SimpleContentService厉膀。
ImportSelector在SpringBoot中的使用
SpringBoot里的ImportSelector是通過(guò)SpringBoot提供的@EnableAutoConfiguration這個(gè)注解里完成的溶耘。
這個(gè)@EnableAutoConfiguration注解可以顯式地調(diào)用，否則它會(huì)在@SpringBootApplication注解中隱式地被調(diào)用服鹅。
@EnableAutoConfiguration注解中使用了EnableAutoConfigurationImportSelector作為ImportSelector凳兵。下面這段代碼就是EnableAutoConfigurationImportSelector中進(jìn)行選擇的具體代碼：
@Override
public String[] selectImports(AnnotationMetadata metadata) {
try {
AnnotationAttributes attributes = getAttributes(metadata);
List<String> configurations = getCandidateConfigurations(metadata,
attributes);
configurations = removeDuplicates(configurations); // 刪除重復(fù)的配置
Set<String> exclusions = getExclusions(metadata, attributes); // 去掉需要exclude的配置
configurations.removeAll(exclusions);
configurations = sort(configurations); // 排序
recordWithConditionEvaluationReport(configurations, exclusions);
return configurations.toArray(new String[configurations.size()]);
}
catch (IOException ex) {
throw new IllegalStateException(ex);
}
}
其中g(shù)etCandidateConfigurations方法將獲取配置類：
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
AnnotationAttributes attributes) {
return SpringFactoriesLoader.loadFactoryNames(
getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());
}
SpringFactoriesLoader.loadFactoryNames方法會(huì)根據(jù)FACTORIES_RESOURCE_LOCATION這個(gè)靜態(tài)變量從所有的jar包中讀取META-INF/spring.factories文件信息：
public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {
String factoryClassName = factoryClass.getName();
try {
Enumeration<URL> urls = (classLoader != null ? classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
List<String> result = new ArrayList<String>();
while (urls.hasMoreElements()) {
URL url = urls.nextElement();
Properties properties = PropertiesLoaderUtils.loadProperties(new UrlResource(url));
String factoryClassNames = properties.getProperty(factoryClassName); // 只會(huì)過(guò)濾出key為factoryClassNames的值
result.addAll(Arrays.asList(StringUtils.commaDelimitedListToStringArray(factoryClassNames)));
}
return result;
}
catch (IOException ex) {
throw new IllegalArgumentException("Unable to load [" + factoryClass.getName() +
"] factories from location [" + FACTORIES_RESOURCE_LOCATION + "]", ex);
}
}
getCandidateConfigurations方法中的getSpringFactoriesLoaderFactoryClass方法返回的是EnableAutoConfiguration.class，所以會(huì)過(guò)濾出key為org.springframework.boot.autoconfigure.EnableAutoConfiguration的值企软。
下面這段配置代碼就是autoconfigure這個(gè)jar包里的spring.factories文件的一部分內(nèi)容(有個(gè)key為org.springframework.boot.autoconfigure.EnableAutoConfiguration庐扫，所以會(huì)得到這些AutoConfiguration)：
# Initializers
org.springframework.context.ApplicationContextInitializer=\
org.springframework.boot.autoconfigure.logging.AutoConfigurationReportLoggingInitializer
# Application Listeners
org.springframework.context.ApplicationListener=\
org.springframework.boot.autoconfigure.BackgroundPreinitializer
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.MessageSourceAutoConfiguration,\
當(dāng)然了，這些AutoConfiguration不是所有都會(huì)加載的澜倦，會(huì)根據(jù)AutoConfiguration上的@ConditionalOnClass等條件判斷是否加載聚蝶。
上面這個(gè)例子說(shuō)的讀取properties文件的時(shí)候只會(huì)過(guò)濾出key為org.springframework.boot.autoconfigure.EnableAutoConfiguration的值杰妓。
SpringBoot內(nèi)部還有一些其他的key用于過(guò)濾得到需要加載的類：
org.springframework.test.context.TestExecutionListener
org.springframework.beans.BeanInfoFactory
org.springframework.context.ApplicationContextInitializer
org.springframework.context.ApplicationListener
org.springframework.boot.SpringApplicationRunListener
org.springframework.boot.env.EnvironmentPostProcessor
org.springframework.boot.env.PropertySourceLoader
