SpringBoot自动装配原理解析——面试可以这样会回答

1. 前言

SpringBoot是目前软件中最主流的框架,无论是工作还是面试基本都有它的身影,SpringBoot主要解决了传统spring的重量级xml配置Bean,实现了自动装配;所以,我们也常在面试中被问到SpringBoot是如何实现自动装配。

本篇文章会从springboot源码进行自动装配的原理解析,并总结面试如何简洁的描述

2. 源码解析

我们以springboot 2.2.5.RELEASE版本进行解析

2.1 @SpringBootApplication源码解析

先看看springboot启动注解@SpringBootApplication

@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 {

	@AliasFor(annotation = EnableAutoConfiguration.class)
	Class<?>[] exclude() default {};

	@AliasFor(annotation = EnableAutoConfiguration.class)
	String[] excludeName() default {};

	@AliasFor(annotation = ComponentScan.class, attribute = "basePackages")
	String[] scanBasePackages() default {};

	@AliasFor(annotation = ComponentScan.class, attribute = "basePackageClasses")
	Class<?>[] scanBasePackageClasses() default {};

	@AliasFor(annotation = Configuration.class)
	boolean proxyBeanMethods() default true;

}

可以看出@SpringBootApplication是由三个注解组成的,@ComponentScan注解则是spring原生注解,其作用是扫描启动类所在的包以及子包所有Bean组件并注册到IOC容器中,两外两个我们再看看源码

@SpringBootConfiguration源码:
SpringBoot自动装配原理解析——面试可以这样会回答_第1张图片
@EnableAutoConfiguration源码:
SpringBoot自动装配原理解析——面试可以这样会回答_第2张图片
总结@SpringBootApplication注解由三个注解共同完成自动装配,各个注解作用如下

  • @SpringBootConfiguration: 标记启动类为一个spring配置类
  • @EnableAutoConfiguration: 实现自动装配的核心注解(重头戏)
  • @ComponentScan: 扫描启动类所在的包以及子包下所有标记为Bean的组件并注册到IOC容器中

2.2 @EnableAutoConfiguration源码解析

@EnableAutoConfiguration注解才是实现自动装配的核心注解,上面看了他的源码是通过@Import注解导入AutoConfigurationImportSelector类,我们来看看AutoConfigurationImportSelector源码:
SpringBoot自动装配原理解析——面试可以这样会回答_第3张图片SpringBoot自动装配原理解析——面试可以这样会回答_第4张图片
通过源码可知,AutoConfigurationImportSelector是ImportSelector的一个字类,@Import注解的一大用处就是导入一个ImportSelector类,通过selectImports方法返回所有需要被注册为bean的类全名的数组集合,具体可以参考我们的上一篇文章@Import注解的详解

我们再来看看AutoConfigurationImportSelector类的selectImports方法

@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
	// 判断自动装配开关是否打开
	if (!isEnabled(annotationMetadata)) {
		return NO_IMPORTS;
	}
	AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
			.loadMetadata(this.beanClassLoader);
	AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata,
			annotationMetadata);
	return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}

首先通过 isEnabled 方法判断自动装配开关是否打开,这里就不细讲了,我们从后面两步开始分析

2.2.1. AutoConfigurationMetadataLoader.loadMetadata() 方法源码分析:

loadMetadata() 方法源码:
SpringBoot自动装配原理解析——面试可以这样会回答_第5张图片

  • META-INF/spring-autoconfigure-metadata.properties文件内容属性:
    SpringBoot自动装配原理解析——面试可以这样会回答_第6张图片

  • PropertiesLoaderUtils的 loadProperties 方法源码:
    SpringBoot自动装配原理解析——面试可以这样会回答_第7张图片

  • 最后创建并返回的AutoConfigurationMetadata对象
    SpringBoot自动装配原理解析——面试可以这样会回答_第8张图片

综合上述可以得出 AutoConfigurationMetadataLoader.loadMetadata() 方法是用来读取spring-boot-autoconfigure依赖下的
spring-autoconfigure-metadata.properties配置文件内容并封装成一个 AutoConfigurationMetadata 对象

2.2.2 getAutoConfigurationEntry 方法源码分析(重点)

// getAutoConfigurationEntry 方法源码
protected AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata,
			AnnotationMetadata annotationMetadata) {
		// 再次判断自动装配开关是否打开
		if (!isEnabled(annotationMetadata)) {
			return EMPTY_ENTRY;
		}
		// 获取 @EnableAutoConfiguration注解的 exclude 和 excludeName 属性
		AnnotationAttributes attributes = getAttributes(annotationMetadata);
		// 获取该依赖下的 spring.factories配置文件的内容
		List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
		// 移除重复的数据
		configurations = removeDuplicates(configurations);
		// 获取spring.autoconfigure.exclude 配置文件的内容并与exclude 和 excludeName 属性合并到一个集合中
		Set<String> exclusions = getExclusions(annotationMetadata, attributes);
		// 检验configurations中需要排除的内容
		checkExcludedClasses(configurations, exclusions);
		// 移除configurations中需要排除的内容
		configurations.removeAll(exclusions);
		// 再次对configurations中的内容进行过滤
		configurations = filter(configurations, autoConfigurationMetadata);
		// 关闭spring监听器中的自动装配事件
		fireAutoConfigurationImportEvents(configurations, exclusions);
		return new AutoConfigurationEntry(configurations, exclusions);
	}

首先依然通过 isEnabled 方法判断自动装配开关是否打开,这里就不细讲了,我们从后面开始分析

  • getAttributes方法就是获取 @EnableAutoConfiguration注解的 exclude 和 excludeName 属性,由于启动类默认并未设置这两个属性,这里就不再深入分析
    SpringBoot自动装配原理解析——面试可以这样会回答_第9张图片SpringBoot自动装配原理解析——面试可以这样会回答_第10张图片SpringBoot自动装配原理解析——面试可以这样会回答_第11张图片

  • getCandidateConfigurations方法源码分析(重点):
    SpringBoot自动装配原理解析——面试可以这样会回答_第12张图片
    1. SpringFactoriesLoader.loadFactoryNames方法源码:在这里插入图片描述SpringBoot自动装配原理解析——面试可以这样会回答_第13张图片

2. spring.factories配置文件
SpringBoot自动装配原理解析——面试可以这样会回答_第14张图片

3. getCandidateConfigurations方法最终返回的结果
SpringBoot自动装配原理解析——面试可以这样会回答_第15张图片

  • removeDuplicates(configurations): 字面上就可以看出是去除重复的元素

  • getExclusions源码分析:SpringBoot自动装配原理解析——面试可以这样会回答_第16张图片此操作就是将exclude和excludeName属性内容绑定到环境变量去中,由于这两个属性默认为空所以略过

  • checkExcludedClasses(configurations, exclusions): 方法名上可以知道该方法是检查configurations内容中哪些是需要排除的,由于exclusions默认为空,这里实际没做什么有效的操作,所以不再深入分许

  • configurations.removeAll(exclusions): 方法名上可以看出是移除需要排除的元素

  • filter(configurations, autoConfigurationMetadata) 方法源码分析(重点):
    SpringBoot自动装配原理解析——面试可以这样会回答_第17张图片
    SpringBoot自动装配原理解析——面试可以这样会回答_第18张图片

  • fireAutoConfigurationImportEvents(configurations, exclusions): 关闭spring监听器中的自动装配事件

  • new AutoConfigurationEntry(configurations, exclusions): 最终的返回的结果
    SpringBoot自动装配原理解析——面试可以这样会回答_第19张图片

综合上述 @EnableAutoConfiguration 注解通过@Import注解导入 ImportSelector 的子类 AutoConfigurationImportSelector 类,该类通过selectImports方法加载读取所有 spring-boot-autoconfigure 依赖下的 spring-autoconfigure-metadata.properties 配置文件和spring.factories 配置文件的内容,并根据 AutoConfigurationImportSelector 类下的 AutoConfigurationImportFilter过滤器的过滤规则和 spring-autoconfigure-metadata.properties 配置文件的内容过滤掉 spring.factories文件中需要被过滤掉的组件元素(当然这之前还有一步根据@EnableAutoConfiguration注解的 exclude 和 excludeName属性过滤 spring.factories 配置文件的内容,由于 @EnableAutoConfiguration注解的这两个属性默认为空,所以这步操作什么都没做),最终返回spring.factories文件中剩余组件的类全名数组,并由IOC容器注册为Bean

3. 总结

以上解析了springboot实现自动装配的源码,实际上我们在工作中基本用不到,只需了解即可,我们可能在面试中经常会被问到自动装配的原理,按照以上的解析,这里我们总结一下,面试可以这样简洁回答:
启动类的@SpringBootApplication注解由@SpringBootConfiguration,@EnableAutoConfiguration,@ComponentScan三个注解组成,三个注解共同完成自动装配;

  • @SpringBootConfiguration 注解标记启动类为配置类
  • @ComponentScan 注解实现启动时扫描启动类所在的包以及子包下所有标记为bean的类由IOC容器注册为bean
  • @EnableAutoConfiguration通过 @Import 注解导入 AutoConfigurationImportSelector类,然后通过AutoConfigurationImportSelector 类的 selectImports 方法去读取需要被自动装配的组件依赖下的spring.factories文件配置的组件的类全名,并按照一定的规则过滤掉不符合要求的组件的类全名,将剩余读取到的各个组件的类全名集合返回给IOC容器并将这些组件注册为bean

你可能感兴趣的:(javaEE,spring,java)