@SpringBootApplication 核心注解及自动配置的原理

写bug的猿

已于 2024-11-20 14:27:19 修改

阅读量1k

点赞数 11

文章标签： java

于 2024-11-19 17:16:07 首次发布

本文链接：https://blog.csdn.net/weixin_43259242/article/details/143890483

版权

在Spring Boot框架中，@SpringBootApplication 注解是用于标识 Spring Boot 启动类的核心注解。它本质上是一个组合注解，集成了多个关键注解，负责初始化 Spring Boot 应用的上下文、自动配置及组件扫描。以下是对 @SpringBootApplication 及其组成注解的详细解释：

`@SpringBootApplication` 注解的构成

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan

每个注解的作用如下：

1. `@SpringBootConfiguration`

作用：这是 Spring Boot 提供的一个注解，它实际上是 @Configuration 注解的一个封装，代表该类是一个 Spring 配置类。
背景：Spring 中的 @Configuration 注解用来声明一个类是 Spring 配置类，其中通常会有 @Bean 定义，Spring 容器会加载该类并注册配置的 Bean。在 Spring Boot 中，@SpringBootConfiguration 继承自 @Configuration，并在其基础上为启动类提供了一些额外的处理。
```
@Configuration
public class AppConfig {
    @Bean
    public MyService myService() {
        return new MyService();
    }
}
```
对应的，@SpringBootConfiguration 也标记一个类为 Spring Boot 的配置类，允许 Spring Boot 自动进行配置，加载所需的 Bean。

内部实现：
- @SpringBootConfiguration 会启用 Spring 配置类的功能，让启动类作为配置类来处理。

2. `@ComponentScan`

作用：@ComponentScan 注解会启用 Spring 的组件扫描机制，自动扫描指定包及其子包下的组件（如 @Component、@Service、@Repository、@Controller 等），并将它们注册为 Spring 容器中的 Bean。
背景：@ComponentScan 注解用于配置类上，指定 Spring 应该扫描哪些包，以寻找 Spring 管理的 Bean。如果不指定包，它将会从标注该注解的类所在的包开始扫描。

常见配置：
- basePackages：指定包路径进行扫描。
- basePackageClasses：指定类名所在的包进行扫描。
```
@ComponentScan(basePackages = "com.example.services")
public class AppConfig {
}
```
如果 @ComponentScan 没有明确指定包路径，则默认会扫描启动类所在的包及其子包。

3. `@EnableAutoConfiguration`

作用：@EnableAutoConfiguration 是 Spring Boot 的核心注解之一，它告诉 Spring Boot 自动配置应用程序上下文。Spring Boot 会根据应用的依赖（例如 spring-boot-starter-web），自动为你配置相关的 Bean。
背景：Spring Boot 自动配置机制基于类路径下的条件判断以及依赖关系，它通过分析应用的类路径、配置文件以及已有的 Bean 来判断是否启用某些自动配置。这减少了开发者手动配置 Spring Bean 的工作量。
- 内部实现： @EnableAutoConfiguration 注解的实现方式是通过 @Import(AutoConfigurationImportSelector.class) 导入了一个选择器 AutoConfigurationImportSelector，该选择器负责根据 META-INF/spring.factories 文件中的配置，自动选择适合当前应用的配置类，并将其加载到 Spring 容器中。
关键步骤：
1. @Import(AutoConfigurationImportSelector.class)：使用 @Import 注解导入 AutoConfigurationImportSelector 类，该类会根据一定条件选择需要加载的自动配置类。
2. spring.factories 文件：Spring Boot 会在 META-INF/spring.factories 文件中查找自动配置类的名称，并根据条件加载相应的配置类。
配置类的加载：
- spring.factories 文件列出了与不同功能相关的自动配置类。例如，当应用中包含 spring-boot-starter-web 时，自动配置会提供嵌入式的 Tomcat 配置、Web 环境设置等。
```
# META-INF/spring.factories 中的部分内容
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration,\
  org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration
```
@EnableAutoConfiguration 参数：
- exclude：排除某些自动配置类。
- excludeName：按名称排除自动配置类。
例如，如果你不想使用默认的数据库配置，可以通过以下方式排除：
```
@EnableAutoConfiguration(exclude = DataSourceAutoConfiguration.class)
public class MyApplication {
}
```

自动配置机制的核心原理

Spring Boot 通过 @EnableAutoConfiguration 启用了自动配置。具体原理如下：

条件化配置：Spring Boot 根据项目中的依赖及类路径的配置来判断是否需要加载某些自动配置类。例如，如果项目中包含 spring-boot-starter-data-jpa 依赖，则会自动配置 JPA 相关的 Bean（如 EntityManagerFactory、DataSource 等）。
spring.factories 文件：该文件位于每个依赖的 JAR 包中的 META-INF/ 目录下，列出了所有自动配置类的入口。Spring Boot 在启动时会加载该文件，识别并执行合适的自动配置。
条件注解（@Conditional）：Spring Boot 的自动配置类会利用 @Conditional 注解结合 @ConditionalOnClass、@ConditionalOnMissingBean 等条件注解来判断当前环境是否适合执行该配置。

例如，以下是一个典型的自动配置类的示例：

@Configuration
@ConditionalOnClass(DataSource.class)
public class DataSourceAutoConfiguration {
    @Bean
    @ConditionalOnMissingBean(DataSource.class)
    public DataSource dataSource() {
        return new HikariDataSource();
    }
}