SpringBoot自動化配置的注解開關原理
發(fā)表于?2016-11-13?|?分類于?springboot?|?0 Comments?|?閱讀次數
在之前我們分析SpringBoot的自動化配置原理的時候，分析了freemarker的自動化配置類FreeMarkerAutoConfiguration，這個自動化配置類需要classloader中的一些類需要存在并且在其他的一些配置類之后進行加載。
但是還存在一些自動化配置類，它們需要在使用一些注解開關的情況下才會生效。比如spring-boot-starter-batch里的@EnableBatchProcessing注解、@EnableCaching等。
在分析這些開關的原理之前，我們來看一個需求：
定義一個Annotation，讓使用了這個Annotaion的應用程序自動化地注入一些類或者做一些底層的事情。
我們會使用Spring提供的@Import注解配合一個配置類來完成。
我們以一個最簡單的例子來完成這個需求：定義一個注解EnableContentService，使用了這個注解的程序會自動注入ContentService這個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");
? ? }
}
然后在應用程序的入口加上@EnableContentService注解。
這樣的話，ContentService就被注入進來了。 SpringBoot也就是用這個完成的。只不過它用了更加高級點的ImportSelector。
用了ImportSelector之后，我們可以在Annotation上添加一些屬性，然后根據屬性的不同加載不同的bean。
我們在@EnableContentService注解添加屬性policy，同時Import一個Selector。
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(ContentImportSelector.class)
public @interface EnableContentService {
? ? String policy() default "simple";
}
這個ContentImportSelector根據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的話，應用程序會自動加載CoreContentService，否則會加載SimpleContentService。
SpringBoot里的ImportSelector是通過SpringBoot提供的@EnableAutoConfiguration這個注解里完成的。
這個@EnableAutoConfiguration注解可以顯式地調用，否則它會在@SpringBootApplication注解中隱式地被調用。
@EnableAutoConfiguration注解中使用了EnableAutoConfigurationImportSelector作為ImportSelector。下面這段代碼就是EnableAutoConfigurationImportSelector中進行選擇的具體代碼：
@Override
public String[] selectImports(AnnotationMetadata metadata) {
? ? try {
? ? ? ? AnnotationAttributes attributes = getAttributes(metadata);
? ? ? ? List<String> configurations = getCandidateConfigurations(metadata,
? ? ? ? ? ? ? ? attributes);
? ? ? ? configurations = removeDuplicates(configurations); // 刪除重復的配置
? ? ? ? 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);
? ? }
}
其中getCandidateConfigurations方法將獲取配置類：
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
? ? ? ? AnnotationAttributes attributes) {
? ? return SpringFactoriesLoader.loadFactoryNames(
? ? ? ? ? ? getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());
}
SpringFactoriesLoader.loadFactoryNames方法會根據FACTORIES_RESOURCE_LOCATION這個靜態(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); // 只會過濾出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，所以會過濾出key為org.springframework.boot.autoconfigure.EnableAutoConfiguration的值。
下面這段配置代碼就是autoconfigure這個jar包里的spring.factories文件的一部分內容(有個key為org.springframework.boot.autoconfigure.EnableAutoConfiguration，所以會得到這些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,\
當然了，這些AutoConfiguration不是所有都會加載的，會根據AutoConfiguration上的@ConditionalOnClass等條件判斷是否加載。
上面這個例子說的讀取properties文件的時候只會過濾出key為org.springframework.boot.autoconfigure.EnableAutoConfiguration的值。
SpringBoot內部還有一些其他的key用于過濾得到需要加載的類：
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
ps：轉發(fā)?https://fangjian0423.github.io/2016/11/13/springboot-enable-annotation/
