看看SpringBoot的自动装配原理

mtc8n24

于 2024-09-01 16:02:29 发布

阅读量1k

点赞数 22

分类专栏：白话八股文文章标签： spring boot 后端 java

本文链接：https://blog.csdn.net/weixin_42035397/article/details/141782569

版权

白话八股文专栏收录该内容

8 篇文章 0 订阅

订阅专栏

SpringBoot的自动装配原理

明天面试浅浅复习一下八股文

面试官：说一下springboot的自动装配

像以前开发的时候，配置文件需要用xml和java配置类进行显式配置，一整就整一大堆的配置文件

then 什么是自动装配？

Spring boot 定义了一套自己的规范，在Spring Boot启动的时候会扫描有什么外部的jar包的META-INF/spring.factories，然后加载里面的配置文件到Spring里面，像那些自己写的starter就只需要按照Spring boot定的规则定义文件就行了。

简单理解就是自动装配就是通过一些注解和一些简单的配置就可以在Spring boot中使用第三方的某些功能。

如何实现自动装配？

自动装配的核心就是@SpringBootApplication

打开这个类look look，这个版本是3.x的SpringBoot

更新太快了，刚刚才开始摸两下java11，3.x的spirng就需要java17只吃了，卷烂了卷烂了

SpringBootApplication.java

@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) }) // 这个玩意就是扫包的，扫描那些有标注@Component的包，通过定义不扫什么包，比如这个excludeFilters玩意就是用来定义不扫什么包的
public @interface SpringBootApplication

@SpringBootConfiguration

Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration // 注明这个也是个配置类
@Indexed // 作为元注解声明注解，可以减少应用启动的速度，下面稍微展开一下
public @interface SpringBootConfiguration {
    @AliasFor(
        annotation = Configuration.class
    )
    boolean proxyBeanMethods() default true;
}

@Indexed：当Spring Boot需要扫描的类太多的时候，@ComponentScan就是这个类需要扫描的类太多的时候，应用启动的时间就会变长。这个注解的用处就是用来解决这个问题的，再项目进行编译打包的时候，会自动生成被@Indexed注释的类的解析结果的文件META-INF/spring.components，当Spring开始进行上下文扫描的的时候，会直接读取被@Indexed处理的文件而不需要进行扫描，这样就可以减少应用的启动时间。

@EnableAutoConfiguration：实现自动装配的核心注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage // 将main包下面的包注册到容器中
@Import(AutoConfigurationImportSelector.class) // 加载需要自动装配的类
public @interface EnableAutoConfiguration {

	/**
	 * Environment property that can be used to override when auto-configuration is
	 * enabled.
	 */
	String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

	/**
	 * Exclude specific auto-configuration classes such that they will never be applied.
	 * @return the classes to exclude
	 */
	Class<?>[] exclude() default {};

	/**
	 * Exclude specific auto-configuration class names such that they will never be
	 * applied.
	 * @return the class names to exclude
	 * @since 1.3.0
	 */
	String[] excludeName() default {};

}

还需要继续深入看看这个AutoConfigurationImportSelector.class

// 继承体系
public class AutoConfigurationImportSelector implements DeferredImportSelector, BeanClassLoaderAware,
		ResourceLoaderAware, BeanFactoryAware, EnvironmentAware, Ordered 

// DeferredImportSelector 这个玩意继承了一个叫 ImportSelector的接口
public interface DeferredImportSelector extends ImportSelector 

// 然后我们现在回到AutoConfigurationImportSelector这个类中，有点混乱了写的
public String[] selectImports(AnnotationMetadata annotationMetadata) {
		// 判断自动装配是否打开，简单的理解为上面的EnableAutoConfiguration注解
        if (!this.isEnabled(annotationMetadata)) {
            return NO_IMPORTS;
        } else {
        	// 然后获取需要装配的bean，这个this.getAutoConfigurationEntry是主要负责加载自动配置类的，主要就是获取所有的自动装配的类，然后从上面也有提过的`META-INF/spring.factories`来加载配置类
            AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(annotationMetadata);
            return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
        }
    }

这个方法主要是读取所有符合Spring Boot加载条件的的类名，然后把这些类加载到IoC容器中。

文字总结一下，这个大致的流程

先在AutoConfigurationImportSelector判断自动装配开关是否打开（spring.boot.enableautoconfiguration=true）
然后去获取用于EnableAutoConfiguration注解中的 exclude 和 excludeName。这个exclude都是在AnnoctionAttribuite的两个key
然后再去加载META-INF/spring.factories，XXXAutoConfiguration的作用就是按需加载组件。（在idea的项目文件树中，有一个目录叫做External Libraries，打开里面的目录可以看到会有一个spring.factories的文件的，里面会有一些配置的信息）
在这些文件里面会有很多个配置文件，他们并不会全部一次加载，加载的时候会有一个筛选的方法，这个注解叫@ConditionalOnClass（以后再看看这个东西怎么个回事，懒惰了不看了）

以前有个面试官问过我，如何实现一个starter？顺手也总结一下

首先要创建一个工程，取个名字 test-spring-boot-starter
然后这个工程要是一个maven的工程，或者说是gradle也行，引入关于Spring Boot的相关依赖

pom文件的伪代码

<dependencies>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter</artifactId>
		<version>${挑选适合你的版本}</version>
	</dependency>
</dependencies>

然后这个时候，创建一个xxxxAutoConfiguration
紧接着需要再这个工程下面，创建一个上面提了很多次的spring.factories，需要有这个玩意才能扫到你。（哦还需要一个META-INF做目录）
然后就可以测试一下了，随便创建一个新的工程，然后在你的pom文件里加入一个引入一个starter

<dependencies>
	<dependency>
		<groupId>org.mtc.test</groupId>
		<artifactId>test-spring-boot-starter</artifactId>
		<version>${你maven创建的时候自己设置的版本}</version>
	</dependency>
</dependencies>