深入了解Java SpringBoot自動(dòng)裝配原理
在使用springboot時(shí)，很多配置我們都沒(méi)有做，都是springboot在幫我們完成，這很大一部分歸功于springboot自動(dòng)裝配，那springboot的自動(dòng)裝配的原理是怎么實(shí)現(xiàn)的呢？
自動(dòng)裝配原理
springboot 版本：2.4.3
SpringBootApplication
springboot啟動(dòng)類(lèi)必須要加@SpringBootApplication注解，那這個(gè)注解是什么意思呢？
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
拋開(kāi)元數(shù)據(jù)注解來(lái)說(shuō)，SpringBootApplication注解主要由@SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan組成。這三個(gè)又有不同的作用如下：
- @SpringBootConfiguration:被@Configuration標(biāo)記，表示這是個(gè)springboot配置，支持JavaConfig的方式來(lái)進(jìn)行配置。
- @EnableAutoConfiguration：表示開(kāi)啟自動(dòng)裝配(重點(diǎn)介紹)
- @ComponentScan：掃描注解，掃描basePackages包下的bean并將他們注入到IOC容器中，比如：@Service、@Controller、@Component等注解。
EnableAutoConfiguration
真正開(kāi)啟自動(dòng)配置的還是@EnableAutoConfiguration注解，來(lái)看下EnableAutoConfiguration注解源碼：
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
@EnableAutoConfiguration 又是由@AutoConfigurationPackage和@Import注解組成。
- @AutoConfigurationPackage是一個(gè)復(fù)合注解的，它在內(nèi)部使用@Import(AutoConfigurationPackages.Registrar.class)注解，Registrar是AutoConfigurationPackages的一個(gè)內(nèi)部類(lèi)，它的作用就是注冊(cè)一個(gè)springboot啟動(dòng)類(lèi)所在的包名，這個(gè)包名可以供列如JPA的使用。
- AutoConfigurationImportSelector通過(guò)selectImports方法將配置類(lèi)導(dǎo)入，從而完成bean的裝配
AutoConfigurationImportSelector
AutoConfigurationImportSelector實(shí)現(xiàn)了DeferredImportSelector接口，DeferredImportSelector是ImportSelector的變種，它是一個(gè)延遲選擇器。實(shí)現(xiàn)了DeferredImportSelector接口的子類(lèi)如果重新了getImportGroup方法并返回DeferredImportSelector內(nèi)部接口Group的子類(lèi)，DeferredImportSelector接口的子類(lèi)的子類(lèi)將不會(huì)調(diào)用selectImports而是調(diào)用Group的selectImports方法。
接下來(lái)看看AutoConfigurationImportSelector重寫(xiě)了getImportGroup方法并返回一個(gè)內(nèi)部類(lèi)AutoConfigurationGroup，AutoConfigurationGroup#selectImports方法只是對(duì)配置數(shù)組進(jìn)行排序篩選，真正處理自動(dòng)配置的流程的是process方法。
process方法源碼如下：
@Override
public void process(AnnotationMetadata annotationMetadata, DeferredImportSelector deferredImportSelector) {
Assert.state(deferredImportSelector instanceof AutoConfigurationImportSelector,
() -> String.format("Only %s implementations are supported, got %s",
AutoConfigurationImportSelector.class.getSimpleName(),
deferredImportSelector.getClass().getName()));
AutoConfigurationEntry autoConfigurationEntry = ((AutoConfigurationImportSelector) deferredImportSelector)
.getAutoConfigurationEntry(annotationMetadata);
this.autoConfigurationEntries.add(autoConfigurationEntry);
for (String importClassName : autoConfigurationEntry.getConfigurations()) {
this.entries.putIfAbsent(importClassName, annotationMetadata);
}
}process方法就是對(duì)AutoConfigurationGroup一些屬性的填充，起作用的還是AutoConfigurationImportSelector.getAutoConfigurationEntry方法。
getAutoConfigurationEntry方法中經(jīng)過(guò)各種判斷過(guò)濾、去重等操作，最后返回AutoConfigurationEntry對(duì)象。源碼如下
protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
if (!isEnabled(annotationMetadata)) {
return EMPTY_ENTRY;
}
//獲取EnableAutoConfiguration注解的exclude和excludeName屬性
AnnotationAttributes attributes = getAttributes(annotationMetadata);
//獲取所有配置類(lèi)
List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
//去除重復(fù)配置類(lèi)
configurations = removeDuplicates(configurations);
Set<String> exclusions = getExclusions(annotationMetadata, attributes);
checkExcludedClasses(configurations, exclusions);
//移除 exclude的配置類(lèi)
configurations.removeAll(exclusions);
configurations = getConfigurationClassFilter().filter(configurations);
fireAutoConfigurationImportEvents(configurations, exclusions);
return new AutoConfigurationEntry(configurations, exclusions);
}
getAutoConfigurationEntry 篩選的自動(dòng)配置類(lèi)：
getAutoConfigurationEntry方法中要重點(diǎn)分析的是getCandidateConfigurations方法。getCandidateConfigurations的作用是獲取所有自動(dòng)裝配的配置類(lèi)的全限定名。
來(lái)看下getCandidateConfigurations方法源碼：
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
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;
}
protected Class<?> getSpringFactoriesLoaderFactoryClass() {
return EnableAutoConfiguration.class;
}
這里面用到了SpringFactoriesLoader是spring提供的一種加載配置的方式，它會(huì)將類(lèi)從配置文件中讀取到，然后利用反射將bean加載到IOC容器中。
SpringFactoriesLoader.loadFactoryNames中會(huì)加載META-INF/spring.factories自動(dòng)配置類(lèi)。這些配置類(lèi)在spring.factories文件中是以key=value的形式存儲(chǔ)的，來(lái)看下部分自動(dòng)配置類(lèi)：
# 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.batch.BatchAutoConfiguration,\ org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\ org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\ org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,\ org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\ org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\ org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\ org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\ org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,\ org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\ org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveDataAutoConfiguration,\
來(lái)看下SpringFactoriesLoader.loadFactoryNames源碼：
public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
ClassLoader classLoaderToUse = classLoader;
if (classLoaderToUse == null) {
classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();
}
String factoryTypeName = factoryType.getName();
return loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());
}
private static Map<String, List<String>> loadSpringFactories(ClassLoader classLoader) {
Map<String, List<String>> result = cache.get(classLoader);
if (result != null) {
return result;
}
result = new HashMap<>();
try {
Enumeration<URL> urls = classLoader.getResources(FACTORIES_RESOURCE_LOCATION);
while (urls.hasMoreElements()) {
URL url = urls.nextElement();
UrlResource resource = new UrlResource(url);
Properties properties = PropertiesLoaderUtils.loadProperties(resource);
for (Map.Entry<?, ?> entry : properties.entrySet()) {
String factoryTypeName = ((String) entry.getKey()).trim();
String[] factoryImplementationNames =
StringUtils.commaDelimitedListToStringArray((String) entry.getValue());
for (String factoryImplementationName : factoryImplementationNames) {
result.computeIfAbsent(factoryTypeName, key -> new ArrayList<>())
.add(factoryImplementationName.trim());
}
}
}
// Replace all lists with unmodifiable lists containing unique elements
result.replaceAll((factoryType, implementations) -> implementations.stream().distinct()
.collect(Collectors.collectingAndThen(Collectors.toList(), Collections::unmodifiableList)));
cache.put(classLoader, result);
}
catch (IOException ex) {
throw new IllegalArgumentException("Unable to load factories from location [" +
FACTORIES_RESOURCE_LOCATION + "]", ex);
}
return result;
}
loadFactoryNames方法只是傳遞一個(gè)org.springframework.boot.autoconfigure.EnableAutoConfiguration作為key，然后取到對(duì)應(yīng)的自動(dòng)配置類(lèi)列表。
最終調(diào)用的是loadSpringFactories方法，loadSpringFactories會(huì)從jar包中找到spring.factories文件然后將其中的自動(dòng)配置類(lèi)存到一個(gè)map中，從下圖可以看到map中存在很多bean，loadFactoryNames方法在加載自動(dòng)配置類(lèi)時(shí)只取了一個(gè)key。弱水三千，只取一瓢。
loadSpringFactories返回結(jié)果：
自動(dòng)裝配流程圖大致如下：
總結(jié)
EnableAutoConfiguration注解開(kāi)啟自動(dòng)裝配，其上的標(biāo)記的@Import(AutoConfigurationImportSelector.class)注解中導(dǎo)入配置類(lèi)
AutoConfigurationImportSelector實(shí)現(xiàn)DeferredImportSelector接口，并重寫(xiě)了getImportGroup方法并返回AutoConfigurationImportSelector.AutoConfigurationGroup，AutoConfigurationImportSelector.AutoConfigurationGroup.process開(kāi)始處理自動(dòng)配置流程。
AutoConfigurationImportSelector.getCandidateConfigurations獲取所有配置類(lèi)getAutoConfigurationEntry方法篩選，去重、移除不符合條件的自動(dòng)配置類(lèi)。
SpringFactoriesLoader.loadSpringFactories從jar包中找到所有META-INF/spring.factories文件并讀取自動(dòng)配置類(lèi)，存放到map中， loadFactoryNames方法通過(guò)全限定名org.springframework.boot.autoconfigure.EnableAutoConfiguration找到自動(dòng)配置類(lèi)。
最后經(jīng)過(guò)層層篩選，去重、移除不符合條件的bean，由ConfigurationClassPostProcessor#processConfigBeanDefinitions注冊(cè)所有的自動(dòng)配置類(lèi)。
到此這篇關(guān)于深入了解Java SpringBoot自動(dòng)裝配原理的文章就介紹到這了,更多相關(guān)SpringBoot自動(dòng)裝配內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了關(guān)于文件合并與修改md5值的問(wèn)題,使用本博客的方法，不僅僅可以修改md5值，還可以達(dá)到隱藏文件的目的,需要的朋友可以參考下2023-04-04
這篇文章主要介紹了springcloud feign傳輸List的坑及解決方案，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-03-03
這篇文章主要為大家詳細(xì)介紹了Java實(shí)現(xiàn)人機(jī)猜拳小游戲，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2019-11-11
Spring中的ClassPathXmlApplicationContext源碼詳解
這篇文章主要介紹了Spring中的ClassPathXmlApplicationContext源碼詳解,ApplicationContext的主要實(shí)現(xiàn)類(lèi)是ClassPathXmlApplicationContext和FileSystemXmlApplicationContext,前者默認(rèn)從類(lèi)路徑加載配置文件,后者默認(rèn)從文件系統(tǒng)中裝載配置文件,需要的朋友可以參考下2023-12-12
這篇文章主要介紹了解決IDEA顯示非法字符 \ufeff 的問(wèn)題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-11-11
springboot3.x版本集成log4j遇到Logging?system?failed?to?initial
使用Springboot?3.x集成Log4j時(shí)可能會(huì)遇到版本沖突的問(wèn)題,這通?？梢酝ㄟ^(guò)檢查Maven依賴(lài)樹(shù)來(lái)識(shí)別,一旦發(fā)現(xiàn)沖突,將Log4j的版本統(tǒng)一更新到最新的兼容版本,例如2.21.1,即可解決問(wèn)題,此方法有效解決了日志打印錯(cuò)誤,是處理類(lèi)似問(wèn)題的一個(gè)實(shí)用參考2024-09-09
這篇文章主要介紹了Java經(jīng)典設(shè)計(jì)模式之觀察者模式,簡(jiǎn)單分析了觀察者模式的概念、原理并結(jié)合實(shí)例形式給出了java觀察者模式的具體用法與相關(guān)注意事項(xiàng),需要的朋友可以參考下2021-09-09
Java Annotation(Java 注解)的實(shí)現(xiàn)代碼
本篇文章介紹了，Java Annotation(Java 注解)的實(shí)現(xiàn)代碼。需要的朋友參考下2013-05-05
淺談java線程中生產(chǎn)者與消費(fèi)者的問(wèn)題
下面小編就為大家?guī)?lái)一篇淺談java線程中生產(chǎn)者與消費(fèi)者的問(wèn)題。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2016-07-07
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)驗(yàn)證碼小程序，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2018-04-04