SpringBoot自動(dòng)配置源碼深入刨析講解
自動(dòng)配置底層源碼分析
本次springboot源碼來(lái)自2.6.6版本。
@EnableAutoConfiguration源碼解析
在springboot中,當(dāng)我們引入某個(gè)依賴(lài),就可以直接使用依賴(lài)?yán)锩娴念?lèi)進(jìn)行自動(dòng)注入,不需要像ssm框架那樣在xml文件中配置各種bean,然后進(jìn)行關(guān)聯(lián)。像這樣我們稱(chēng)之為自動(dòng)配置。那么自動(dòng)配置到底配了什么?
SpringBoot中的自動(dòng)配置,更多的是配置各種Bean,同時(shí)對(duì)于端口號(hào)這些配置,一些特定屬性SpringBoot也是會(huì)提供一種默認(rèn)值的,也相當(dāng)于一種自動(dòng)配置。
那SpringBoot是如何自動(dòng)的幫助我們來(lái)配置這些Bean的呢?并且如果某些Bean程序員自己也配置了,那SpringBoot是如何進(jìn)行選擇的呢?
在springboot啟動(dòng)類(lèi)中有@SpringBootApplication注解,該注解包含了@EnableAutoConfiguration
而@EnableAutoConfiguration的作用就是導(dǎo)入AutoConfigurationImportSelector.class這個(gè)類(lèi)。在spring中的配置類(lèi)源碼分析中,分析過(guò)@Import導(dǎo)入的類(lèi)會(huì)當(dāng)成配置類(lèi)來(lái)解析,并且如果這個(gè)配置類(lèi)是實(shí)現(xiàn)了DeferredImportSelector接口,就會(huì)調(diào)用selectImports方法。這部分屬于spring源碼的知識(shí)不在贅述。
有上述類(lèi)關(guān)系圖中可以看出,會(huì)調(diào)用AutoConfigurationImportSelector的selectImports方法
@Override public String[] selectImports(AnnotationMetadata annotationMetadata) { // 會(huì)在所有@Configuration都解析完了之后才執(zhí)行 if (!isEnabled(annotationMetadata)) { return NO_IMPORTS; } // 獲取自動(dòng)配置類(lèi)(spring.factories中所導(dǎo)入的) AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata); return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations()); }
而selectImports的核心代碼在于getAutoConfigurationEntry(annotationMetadata)。接下來(lái)一步步分析這個(gè)方法
protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) { if (!isEnabled(annotationMetadata)) { return EMPTY_ENTRY; } // 獲取@EnableAutoConfiguration的屬性 AnnotationAttributes attributes = getAttributes(annotationMetadata); // 獲取spring.factories中所有的AutoConfiguration List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes); // 去重(也就是按類(lèi)名去重) configurations = removeDuplicates(configurations); // 獲取需要排除的AutoConfiguration,可以通過(guò)@EnableAutoConfiguration注解的exclude屬性,或者spring.autoconfigure.exclude來(lái)配置 Set<String> exclusions = getExclusions(annotationMetadata, attributes); // 排除 checkExcludedClasses(configurations, exclusions); configurations.removeAll(exclusions); // 獲取spring.factories中的AutoConfigurationImportFilter對(duì)AutoConfiguration進(jìn)行過(guò)濾 // 默認(rèn)會(huì)拿到OnBeanCondition、OnClassCondition、OnWebApplicationCondition // 這三個(gè)會(huì)去判斷上面的AutoConfiguration是否符合它們自身所要求的條件,不符合的會(huì)過(guò)濾掉,表示不會(huì)進(jìn)行解析了 // 會(huì)利用spring-autoconfigure-metadata.properties中的配置來(lái)進(jìn)行過(guò)濾 // spring-autoconfigure-metadata.properties文件中的內(nèi)容是利用Java中的AbstractProcessor技術(shù)在編譯時(shí)生成出來(lái)的 configurations = getConfigurationClassFilter().filter(configurations); // configurations表示合格的,exclusions表示被排除的,把它們記錄在ConditionEvaluationReportAutoConfigurationImportListener中 fireAutoConfigurationImportEvents(configurations, exclusions); // 最后返回的AutoConfiguration都是符合條件的 return new AutoConfigurationEntry(configurations, exclusions); }
首先執(zhí)行 AnnotationAttributes attributes = getAttributes(annotationMetadata);拿到@EnableAutoConfiguration的屬性封裝成AnnotationAttributes 。List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes)
加載自動(dòng)配置類(lèi)。看看源碼是怎么獲取的
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) { //核心方法 傳入EnableAutoConfiguration類(lèi)和類(lèi)加載器 List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader()); Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you " + "are using a custom packaging, make sure that file is correct."); return configurations; } //返回EnableAutoConfiguration protected Class<?> getSpringFactoriesLoaderFactoryClass() { return EnableAutoConfiguration.class; } public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) { ClassLoader classLoaderToUse = classLoader; if (classLoaderToUse == null) { //獲取類(lèi)加載器 classLoaderToUse = SpringFactoriesLoader.class.getClassLoader(); } //這個(gè)name就是EnableAutoConfiguration String factoryTypeName = factoryType.getName(); //這部分代碼具體的去加載自動(dòng)配置類(lèi) return loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList()); }
loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());這部分代碼如下圖,
通過(guò)類(lèi)加載去加載資源,其中紅色部分的靜態(tài)變量就是 public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
。也就是說(shuō)類(lèi)加載器去META-INF/spring.factories里面的資源
而.getOrDefault(factoryTypeName, Collections.emptyList());
這部分就是根據(jù)factoryTypeName也就是EnableAutoConfiguration。獲取EnableAutoConfiguration的值封裝成List<String>
到此就獲取到了所有自動(dòng)配置類(lèi)。那么List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
這個(gè)方法就結(jié)束了。接著執(zhí)行configurations = removeDuplicates(configurations);
這部分主要用去重
protected final <T> List<T> removeDuplicates(List<T> list) { return new ArrayList<>(new LinkedHashSet<>(list)); }
接著執(zhí)行Set<String> exclusions = getExclusions(annotationMetadata, attributes);
這個(gè)方法主要是把需要排除的配置類(lèi)的類(lèi)名放入到集合當(dāng)中。
protected Set<String> getExclusions(AnnotationMetadata metadata, AnnotationAttributes attributes) { Set<String> excluded = new LinkedHashSet<>(); //獲取EnableAutoConfiguration注解的exclude屬性的值 添加到排除集合當(dāng)中 excluded.addAll(asList(attributes, "exclude")); //獲取EnableAutoConfiguration注解的excludeName屬性的值 添加到排除集合當(dāng)中 excluded.addAll(Arrays.asList(attributes.getStringArray("excludeName"))); //從配置文件中獲取spring.autoconfigure.exclude 的值 添加到排除集合中 excluded.addAll(getExcludeAutoConfigurationsProperty()); return excluded; }
往下執(zhí)行checkExcludedClasses(configurations, exclusions);
和configurations.removeAll(exclusions);
從之前獲取到的自動(dòng)配置類(lèi)的類(lèi)名中排除掉那些需要被排除了類(lèi)名。
接著執(zhí)行configurations = getConfigurationClassFilter().filter(configurations);
。將排除后的自動(dòng)配置類(lèi)的名稱(chēng)作為入?yún)ⅲ@部分代碼是提前判斷一些條件進(jìn)行過(guò)濾掉不需要加載的自動(dòng)配置類(lèi)
private ConfigurationClassFilter getConfigurationClassFilter() { if (this.configurationClassFilter == null) { //獲取自動(dòng)配置類(lèi)的過(guò)濾器 List<AutoConfigurationImportFilter> filters = getAutoConfigurationImportFilters(); for (AutoConfigurationImportFilter filter : filters) { invokeAwareMethods(filter); } //將所有過(guò)濾器封裝成 ConfigurationClassFilter this.configurationClassFilter = new ConfigurationClassFilter(this.beanClassLoader, filters); } return this.configurationClassFilter; } protected List<AutoConfigurationImportFilter> getAutoConfigurationImportFilters() { //底層從 META-INF/spring.factories中加載 AutoConfigurationImportFilter的值 return SpringFactoriesLoader.loadFactories(AutoConfigurationImportFilter.class, this.beanClassLoader); }
上面獲取到的過(guò)濾器就是這部分
獲取到所有過(guò)濾器后通過(guò)filter(configurations);
進(jìn)行過(guò)濾
List<String> filter(List<String> configurations) { long startTime = System.nanoTime(); //把自動(dòng)配置類(lèi)的名稱(chēng)封裝成數(shù)組 String[] candidates = StringUtils.toStringArray(configurations); boolean skipped = false; // 逐個(gè)利用AutoConfigurationImportFilter來(lái)判斷所有的自動(dòng)配置類(lèi)的條件是否匹配,匹配結(jié)果存在match數(shù)組中 // 先利用OnBeanCondition進(jìn)行過(guò)濾 // 再利用OnClassCondition進(jìn)行過(guò)濾 // 再利用OnWebApplicationCondition進(jìn)行過(guò)濾 for (AutoConfigurationImportFilter filter : this.filters) { //把過(guò)濾的結(jié)果 放入到boolean的數(shù)組中 boolean[] match = filter.match(candidates, this.autoConfigurationMetadata); for (int i = 0; i < match.length; i++) { if (!match[i]) { //如果匹配失敗 排除掉該自動(dòng)配置類(lèi) candidates[i] = null; skipped = true; } } } // 全部都匹配 if (!skipped) { return configurations; } // 把匹配的記錄在result集合中,最后返回 List<String> result = new ArrayList<>(candidates.length); for (String candidate : candidates) { if (candidate != null) { result.add(candidate); } } if (logger.isTraceEnabled()) { int numberFiltered = configurations.size() - result.size(); logger.trace("Filtered " + numberFiltered + " auto configuration class in " + TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startTime) + " ms"); } return result; } }
過(guò)濾完成后執(zhí)行fireAutoConfigurationImportEvents(configurations, exclusions);
這部分不重要 ,可以看成就是記錄一個(gè)日志,哪些成功的哪些被排除的。
最后執(zhí)行return new AutoConfigurationEntry(configurations, exclusions);
這部分代碼把 可以加載的自動(dòng)配置類(lèi) 放入到一個(gè)集合,把排除的放入到另一個(gè)集合
AutoConfigurationEntry(Collection<String> configurations, Collection<String> exclusions) { this.configurations = new ArrayList<>(configurations); this.exclusions = new HashSet<>(exclusions); } public List<String> getConfigurations() { return this.configurations; } public Set<String> getExclusions() { return this.exclusions; }
到此所有需要加載的自動(dòng)配置類(lèi)都找到了。然后再回到一開(kāi)始的selectImports
方法這個(gè)方法最后返回StringUtils.toStringArray(autoConfigurationEntry.getConfigurations())
。返回所有符合自動(dòng)配置類(lèi)的全類(lèi)名。根據(jù)@Import功能會(huì)繼續(xù)將selectImports
返回的類(lèi)名,當(dāng)成配置類(lèi)去加載。那么每個(gè)自動(dòng)配置類(lèi)就會(huì)加載到springboot當(dāng)中。
到此springboot自動(dòng)配置功能就結(jié)束了。至于加載自動(dòng)配置類(lèi)加載過(guò)程中,根據(jù)條件注解去匹配是否能夠加載,下一篇在分析。
總結(jié)
springboot啟動(dòng)類(lèi)中存在@SpringBootApplication,而@SpringBootApplication中包含@EnableAutoConfiguration。@EnableAutoConfiguration中通過(guò)@Import引入AutoConfigurationImportSelector。
spring啟動(dòng)的時(shí)候調(diào)用AutoConfigurationImportSelector的selectImports。該方法獲取到所有可以加載的自動(dòng)配置類(lèi)(此時(shí)還未加載)
獲取過(guò)程如下:
- 獲取@EnableAutoConfiguration的屬性的值封裝成AnnotationAttributes
- 獲取spring.factories中key為EnableAutoConfiguration的值作為自動(dòng)配置類(lèi)的名稱(chēng)
- 將獲取到的所有的自動(dòng)配置類(lèi)的名稱(chēng)進(jìn)行去重
- 獲取程序員配置的需要排除的自動(dòng)配置類(lèi),從上一步找到的所有自動(dòng)配置類(lèi)中排除掉
- 獲取spring.factories中key為AutoConfigurationImportFilter的值作為過(guò)濾器封裝成ConfigurationClassFilter
- 通過(guò)ConfigurationClassFilter初次過(guò)濾不滿足條件的自動(dòng)配置類(lèi)
- 把排除的自動(dòng)配置類(lèi)和最終可加載的自動(dòng)配置類(lèi)進(jìn)行日志記錄
- 把排除的自動(dòng)配置類(lèi)和最終可加載的自動(dòng)配置類(lèi)分別放入到集合當(dāng)中,封裝成AutoConfigurationEntry返回
最后selectImports從AutoConfigurationEntry拿出可加載的自動(dòng)配置類(lèi)的名稱(chēng)返回。這樣springboot就會(huì)去加載那些配置類(lèi)
到此這篇關(guān)于SpringBoot自動(dòng)配置源碼深入刨析講解的文章就介紹到這了,更多相關(guān)SpringBoot自動(dòng)配置內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Springboot jar包遠(yuǎn)程調(diào)試詳解
這篇文章主要為大家詳細(xì)介紹了Springboot jar包遠(yuǎn)程調(diào)試,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2019-09-09Java開(kāi)發(fā)SSM框架微信支付的實(shí)現(xiàn)
這篇文章主要介紹了Java開(kāi)發(fā)SSM框架微信支付的實(shí)現(xiàn),小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2018-10-10Java BufferedWriter BufferedReader 源碼分析
本文是關(guān)于Java BufferedWriter ,BufferedReader 簡(jiǎn)介、分析源碼 對(duì)Java IO 流深入了解,希望看到的同學(xué)對(duì)你有所幫助2016-07-07java并發(fā)容器CopyOnWriteArrayList實(shí)現(xiàn)原理及源碼分析
這篇文章主要為大家詳細(xì)介紹了java并發(fā)容器CopyOnWriteArrayList實(shí)現(xiàn)原理及源碼,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-05-05Springboot如何通過(guò)yml配置文件為靜態(tài)成員變量賦值
這篇文章主要介紹了Springboot如何通過(guò)yml配置文件為靜態(tài)成員變量賦值,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-10-10SpringCloud超詳細(xì)講解Feign聲明式服務(wù)調(diào)用
Feign可以把Rest的請(qǐng)求進(jìn)行隱藏,偽裝成類(lèi)似Spring?MVC的Controller一樣。不用再自己拼接url,拼接參數(shù)等等操作,一切都交給Feign去做2022-06-06