系列文章目录
Spring Boot自动配置原理
前言
一直在使用Spring Boot特别好奇的是为什么Spring Boot比Spring在项目构建和开发过程中要方便很多,无需编写大量的配置,Spring Boot自动给你配置好了。往往是集成项目依赖之后一键使用。于是小编我就学习和研究了一下Spring Boot的自动配置。
一、Spring Boot自动配置原理剖析
主程序入口示例:
@SpringBootApplication public class SampleWebJspApplication extends SpringBootServletInitializer { public static void main(String[] args) { SpringApplication.run(SampleWebJspApplication.class, args); } }
我们可以发现在Spring Boot项目的启动类上有一个@SpringBootApplication,而这个注解与Spring Boot的自动装配有关系。我进入这个注解可以发现:
通过上面的图片我们可以看出,@SpringBootApplication又是主要由@SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan这三个注解组成。
@SpringBootConfiguration表示这是一个 Spring Boot 应用程序的配置类。
@ComponentScan用于配置 Spring 的组件扫描。它会告诉 Spring 在指定的包下扫描组件,并将它们注册为 Spring 的 Bean。
重点是这个@EnableAutoConfiguration注解:
而**@EnableAutoConfiguration**的含义就是开启自动配置。该注解启用了 Spring Boot 的自动配置机制,它告诉 Spring Boot 根据项目的依赖和类路径中的配置来自动配置应用程序。
我们再进入到@EnableAutoConfiguration注解中,我们可以看到:
我上面图片中我们可以看出,@EnableAutoConfiguration主要由@AutoConfigurationPackage、@Import这两个注解组成。
@AutoConfigurationPackage被应用在 Spring Boot 主配置类上时,它会扫描该主配置类所在的包及其子包,并将其作为自动配置的起始位置。之前的@SpringBootConfiguration标注了主配置类。最终作用在了SampleWebJspApplication类上,也就是启动类上。
其中最为关键的是**@Import这个注解,@Import 的参数会指定一系列自动配置类的类名,这些类会被导入到 Spring Boot 应用的上下文中。细节上是:
其导入的AutoConfigurationImportSelector类的selectImports()**方法中最终通过
**SpringFactoriesLoader.loadFactoryNames()**方法从类路径下的META-INF/spring.factories中获取key键为EnableAutoConfiguration类的全类名对应的value值,value值是一个xxxAutoConfiguration的全类名的列表。
如图:
拿到这些自动配置类的全类名的列表之后,然后会将其加载到Spring容器中,当然判断我们项目中引入了那些启动器
例如引入了spring-boot-starter-web那么就会将org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration
org.springframework.boot.autoconfigure.web.embedded.EmbeddedServletContainerAutoConfiguration
org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration
等等…加载到Spring容器中。
补充什么是启动器:启动器也叫起步依赖,起步依赖是一组预定义的依赖项,他们封装了对特定功能集所需的所有依赖和配置,让开发者能够更快得集成常见功能,而无需手动添加每一个依赖。
起步依赖的命名遵循一定的规则,通常以spring-boot-starter为前缀,后面跟着起步依赖的类型或用途。
如:
spring-boot-starter-web:用于开发web应用程序的起步依赖,包含了Web相关的依赖和配置,如Tomact、Spring Web MVC等
spring-boot-starter-data-jpa:用于与JPA集成的起步依赖,包含了JPA、Hibernate等依赖。
二、自动配置生效
每一个XxxxAutoConfiguration自动配置类,在某些条件下才会生效。这些条件在Spring Boot中以注解的形式体现。
这些条件注解主要位于org.springframework.boot.autoconfigure.condition 包下。
常见的条件注解有:
@ConditionalOnClass:
当类路径中存在指定的类时,自动配置类才会生效
@ConditionalOnMissingClass:
当类路径中不存在指定的类时,自动配置类才会生效。
@ConditionalOnBean:
当 Spring 容器中存在指定的 Bean 时,自动配置类才会生效。
@ConditionalOnMissingBean:
当 Spring 容器中不存在指定的 Bean 时,自动配置类才会生效。
@ConditionalOnProperty:
当指定的配置属性存在且为指定的值时,自动配置类才会生效。
@ConditionalOnWebApplication:
当应用是一个 Web 应用程序时,自动配置类才会生效。
@ConditionalOnNotWebApplication:
当应用不是一个 Web 应用程序时,自动配置类才会生效。
这些条件注解可以很灵活地根据不同的条件来决定是否启用自动配置类,从而实现按需加载配置,避免了配置的冗余和不必要的加载。
补充:对于具体的Spring Boot启动流程,可以浏览下面的文章:Spring Boot——Spring Boot启动原理
三、总结:
在 Spring Boot 应用程序启动过程中会通过@EnableAutoConfiguration 注解找到 META-INF/spring.factories 配置文件中的所有自动配置类,并将它们加载到应用程序上下文中,以实现自动配置的功能。
**通过这一次对Spring Boot自动配置的探究让我清晰了为什么Spring Boot能引入启动依赖(starter)之后不需要手动配置了。**对于Spring Boot的了解也更近了一步。