新聞中心
這篇文章給大家介紹SpringBoot自動(dòng)化配置的注解以及開關(guān)原理是怎樣的,內(nèi)容非常詳細(xì),感興趣的小伙伴們可以參考借鑒,希望對(duì)大家能有所幫助。
創(chuàng)新互聯(lián)專注為客戶提供全方位的互聯(lián)網(wǎng)綜合服務(wù),包含不限于網(wǎng)站制作、網(wǎng)站建設(shè)、西峰網(wǎng)絡(luò)推廣、重慶小程序開發(fā)公司、西峰網(wǎng)絡(luò)營(yíng)銷、西峰企業(yè)策劃、西峰品牌公關(guān)、搜索引擎seo、人物專訪、企業(yè)宣傳片、企業(yè)代運(yùn)營(yíng)等,從售前售中售后,我們都將竭誠(chéng)為您服務(wù),您的肯定,是我們最大的嘉獎(jiǎng);創(chuàng)新互聯(lián)為所有大學(xué)生創(chuàng)業(yè)者提供西峰建站搭建服務(wù),24小時(shí)服務(wù)熱線:028-86922220,官方網(wǎng)址:www.cdcxhl.com
FreeMarkerAutoConfiguration,這個(gè)自動(dòng)化配置類需要classloader中的一些類需要存在并且在其他的一些配置類之后進(jìn)行加載。
SpringBoot的自動(dòng)化配置原理
http://fangjian0423.github.io/2016/06/12/springboot-autoconfig-analysis/
但是還存在一些自動(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
configurations = getCandidateConfigurations(metadata, attributes);
configurations = removeDuplicates(configurations); // 刪除重復(fù)的配置
Set
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
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
loadFactoryNames(Class> factoryClass, ClassLoader classLoader) { String factoryClassName = factoryClass.getName();
try {
Enumeration
urls = (classLoader != null ? classLoader.getResources(FACTORIES_RESOURCE_LOCATION) : ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
List
result = new ArrayList (); 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
關(guān)于SpringBoot自動(dòng)化配置的注解以及開關(guān)原理是怎樣的就分享到這里了,希望以上內(nèi)容可以對(duì)大家有一定的幫助,可以學(xué)到更多知識(shí)。如果覺得文章不錯(cuò),可以把它分享出去讓更多的人看到。
名稱欄目:SpringBoot自動(dòng)化配置的注解以及開關(guān)原理是怎樣的
本文來(lái)源:http://ef60e0e.cn/article/poogco.html