SpringBoot-自动配置-源码解析

• @AutoConfigurationPackage :自动配置包

@Import(AutoConfigurationPackages.Registrar.class) //通过主程序的所在的包名进行批量注册

public @interface AutoConfigurationPackage {

String[] basePackages() default {};

Class<?>[] basePackageClasses() default {};

}

我们发现，这个注解通过@Import(AutoConfigurationPackages.Registrar.class)给IoC容器中导入了一个组件AutoConfigurationPackages.Registrar

我们点进去发现，这是由连个方法组成的类，如下所示

static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {

@Override

public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {

register(registry, new PackageImports(metadata).getPackageNames().toArray(new String[0]));

}

@Override

public Set determineImports(AnnotationMetadata metadata) {

return Collections.singleton(new PackageImports(metadata));

}

}

我们将断点打到此处，然后进行Debug进行分析。

我们发现，这个方法给容器中导入了一系列的组件

通过Debug发现，metadata参数代表的是最原始的那个SpringBootApplication启动类

通过代码我们看到，它new了一个PackageImports对象，将启动类传进去，然后调用了getPackageNames()方法得到了一个包名，debug发现，返回的包名就是我们自己项目中的包名cn.shaoxiongdu,然后我们发现它将这个包名封装到了String数组中作为参数，调用了register方法。

所以register这个方法就是通过包名，进行组件的批量注册，也就是主程序类所在的包。所以这就是为什么默认的包扫描规则是主程序类所在的包。

所以注解EnableAutoConfiguration的第一部分，AutoConfigurationPackage的作用就是通过主程序的所在的包名进行批量注册，我们接下来看第二个注解。

• @Import(AutoConfigurationImportSelector.class)

我们发现，这是一个类，点进去，发现了主要的方法如下

@Override

public String[] selectImports(AnnotationMetadata annotationMetadata) {

if (!isEnabled(annotationMetadata)) {

return NO_IMPORTS;

}

AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);

return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());

}

通过方法名称发现这个方法返回了我们需要给容器中注册的bean名称的数组。那么我们的重点就在这里。

AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata); //我们需要给容器中注册的bean名称的数组

点进去这个方法，我们继续分析这个方法。

protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {

if (!isEnabled(annotationMetadata)) {

return EMPTY_ENTRY;

}

AnnotationAttributes attributes = getAttributes(annotationMetadata);

List configurations = getCandidateConfigurations(annotationMetadata, attributes); // 获取所有的需要注册的候选组件

configurations = removeDuplicates(configurations); // 移除重复的组件

Set exclusions = getExclusions(annotationMetadata, attributes);

checkExcludedClasses(configurations, exclusions);

configurations.removeAll(exclusions);

configurations = getConfigurationClassFilter().filter(configurations);

fireAutoConfigurationImportEvents(configurations, exclusions);

return new AutoConfigurationEntry(configurations, exclusions);

}

通过Debug我们发现，执行到了第7行的时候configurations这个List中已经有了一百多个bean的名称，之后的操作就是对List集合进行一些常规处理并返回。

所以我们只需要分析第6行这个方法getCandidateConfigurations(annotationMetadata, attributes);

是它返回了我们需要给容器中默认注册的bean的名称的字符数组。

我们重新Debug，进入方法

protected List getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {

List 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;

}

通过分析，我们发现主要的流程在2行，通过工厂模式加载需要注册的容器集合。

继续Debug进去此方法

public static List loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {

ClassLoader classLoaderToUse = classLoader;

if (classLoader == null) {

classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();

}

String factoryTypeName = factoryType.getName();

return (List)loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList()); //返回需要注册的组件集合

}

重点在最后一行，通过loadSpringFactories方法返回了对应的集合。

继续Debug进去此方法

private static Map<String, List> loadSpringFactories(ClassLoader classLoader) {

Map<String, List> result = (Map)cache.get(classLoader);

if (result != null) {

return result;

} else {

HashMap result = new HashMap();

try {

Enumeration urls = classLoader.getResources(“META-INF/spring.factories”);

while(urls.hasMoreElements()) {

URL url = (URL)urls.nextElement();

UrlResource resource = new UrlResource(url);

Properties properties = PropertiesLoaderUtils.loadProperties(resource);

Iterator var6 = properties.entrySet().iterator();

while(var6.hasNext()) {

Entry<?, ?> entry = (Entry)var6.next();

String factoryTypeName = ((String)entry.getKey()).trim();

String[] factoryImplementationNames = StringUtils.commaDelimitedListToStringArray((String)entry.getValue());

String[] var10 = factoryImplementationNames;

int var11 = factoryImplementationNames.length;

for(int var12 = 0; var12 < var11; ++var12) {

String factoryImplementationName = var10[var12];

((List)result.computeIfAbsent(factoryTypeName, (key) -> {

return new ArrayList();

})).add(factoryImplementationName.trim());

}

}

}

result.replaceAll((factoryType, implementations) -> {

return (List)implementations.stream().distinct().collect(Collectors.collectingAndThen(Collectors.toList(), Collections::unmodifiableList));

});

cache.put(classLoader, result);

return result;

} catch (IOException var14) {

throw new IllegalArgumentException(“Unable to load factories from location [META-INF/spring.factories]”, var14);

}

}

}

这个方法，就是返回了需要注册的组件集合。我们分析此方法即可。

首先，debug发现，代码来到了第6行，创建了一个HashMap。然后在try里边，我们发现它加载了一个资源文件META-INF/spring.factories，并且是循环的扫描所有依赖中的此文件。通过查看，我们发现，大部分的依赖都有这个文件，少部分的没有。

我们打开spring-boot-autoconfiguration依赖，打开他的spring.factories文件

有一个key为org.springframework.boot.autoconfigure.EnableAutoConfiguration的项

值都叫XXXConfiguration。一个XXXConfiguration对应一个依赖的自动配置类

也就是说，在spring-boot-autoconfiguration依赖的spring.factories文件里面写死了spring-boot一启动就要给容器中加载的所有配置类，而我们运行下面的主方法

public static void main(String[] args) {

//返回IoC容器

ConfigurableApplicationContext run = SpringApplication.run(Springboot01HelloApplication.class, args);

int beanDefinitionCount = run.getBeanDefinitionCount();

System.out.println("beanDefinitionCount = " + beanDefinitionCount);

}

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

最后

分布式技术专题+面试解析+相关的手写和学习的笔记pdf

还有更多Java笔记分享如下：

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！**

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

最后

分布式技术专题+面试解析+相关的手写和学习的笔记pdf

还有更多Java笔记分享如下：

[外链图片转存中…(img-82Sy1p9p-1713309975890)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！