写点什么

SpringBoot- 自动配置 - 源码解析,做了 5 年 Java

发布于: 2 小时前
  • [](



)@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<Object> determineImports(AnnotationMetadata metadata) {
return Collections.singleton(new PackageImports(metadata));
}

}
复制代码


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


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


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


![image-20210725205925975](https://static001.geekbang.org/infoq/ae/aee4825ad3274501a121807feaa747e2.png)


通过代码我们看到,它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<String> configurations = getCandidateConfigurations(annotationMetadata, attributes); // 获取所有的需要注册的候选组件
configurations = removeDuplicates(configurations); // 移除重复的组件
Set<String> 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集合进行一些常规处理并返回。


![image-20210725212042406](https://static001.geekbang.org/infoq/f2/f22409d6c8a5a5faa9dad391db0ccc48.png)


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


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


我们重新Debug,进入方法
复制代码



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;
}
复制代码


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


继续Debug进去此方法
复制代码



public static List<String> 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<String>> loadSpringFactories(ClassLoader classLoader) {
Map<String, List<String>> 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`,并且是循环的扫描所有依赖中的此文件。通过查看,我们发现,大部分的依赖都有这个文件,少部分的没有。


![image-20210725222133111](https://static001.geekbang.org/infoq/c6/c69f3127cf7524cc9cc2b05f94c93183.png)


我们打开`spring-boot-autoconfiguration`依赖,打开他的`spring.factories`文件
复制代码

完结

Redis 基于内存,常用作于缓存的一种技术,并且 Redis 存储的方式是以 key-value 的形式。Redis 是如今互联网技术架构中,使用最广泛的缓存,在工作中常常会使用到。Redis 也是中高级后端工程师技术面试中,面试官最喜欢问的问题之一,因此作为 Java 开发者,Redis 是我们必须要掌握的。


Redis 是 NoSQL 数据库领域的佼佼者,如果你需要了解 Redis 是如何实现高并发、海量数据存储的,那么这份腾讯专家手敲《Redis 源码日志笔记》将会是你的最佳选择。



CodeChina开源项目:【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频】

用户头像

VX:vip204888 领取资料 2021.07.29 加入

还未添加个人简介

评论

发布
暂无评论
SpringBoot-自动配置-源码解析,做了5年Java