Likanug // lab
返回文章列表

文章

技术分享

Spring Boot的自动配置原理

我们来深入剖析一下 Spring Boot 自动配置的原理。这是 Spring Boot 最核心、也最吸引人的特性之一。

#开发#Web#Java#Spring#SpringBoot
目录
  1. Spring Boot 自动配置的本质
  2. 自动配置的核心机制
  3. Auto Configure
  4. ... 还有很多其他自动配置类
  5. 自动配置的流程概览
  6. 自动配置的例子：数据库连接
  7. 优先级与用户自定义配置
  8. 总结

Spring Boot 自动配置的本质#

Spring Boot 的自动配置本质上是根据项目 classpath 中存在的类、Spring 配置中定义的 Bean，以及其他条件，自动为应用程序配置 Spring 组件（Beans）。它将 Spring 框架和第三方库的复杂配置简化为“开箱即用”的体验。 想象一下，你以前需要写几十行 XML 或 Java 代码来配置一个数据库连接池、一个 JPA EntityManagerFactory 或一个 Tomcat 服务器。现在，你只需要在 pom.xml 中引入一个 spring-boot-starter-data-jpa，Spring Boot 就能帮你完成大部分工作。

自动配置的核心机制#

Spring Boot 自动配置主要依赖以下几个核心机制：

  1. @SpringBootApplication** 注解:**
    • 这是 Spring Boot 应用程序的入口点。它是一个复合注解，包含了以下三个关键注解：
      • @SpringBootConfiguration: 标记这是一个 Spring Boot 配置类，本质上是 @Configuration 的一个特殊化。
      • @EnableAutoConfiguration: 这是自动配置的核心驱动器！ 它告诉 Spring Boot 开启自动配置功能。
      • @ComponentScan: 开启 Spring 组件扫描，扫描当前包及其子包下的 @Component, @Service, @Controller, @Repository 等注解，将它们注册为 Spring Bean。
  2. @EnableAutoConfiguration** 注解:**
    • 这个注解内部使用 @Import(AutoConfigurationImportSelector.class) 来导入一个特殊的 ImportSelector。
    • AutoConfigurationImportSelector 的作用是在 Spring 容器启动时，收集所有符合条件的自动配置类。
  3. spring.factories** 文件:**
    • AutoConfigurationImportSelector 如何知道有哪些自动配置类呢？它通过扫描 classpath 下所有 JAR 包中的 META-INF/spring.factories 文件。
    • 在这些文件中，你会找到类似这样的配置：

Auto Configure#

org.springframework.boot.autoconfigure.EnableAutoConfiguration=
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\

... 还有很多其他自动配置类#

	```
- `spring.factories` 是一个约定俗成的文件，Spring Boot 会读取这个文件中 `org.springframework.boot.autoconfigure.EnableAutoConfiguration` 键对应的值，这些值就是所有可能的自动配置类的全限定名。

4. 条件注解 (@ConditionalOn...) : - 这是实现“按需配置”的关键。Spring Boot 的每一个自动配置类（或其中的 @Bean 方法）都使用了各种 @ConditionalOn... 注解，来决定是否应该应用该配置。 - 常见的条件注解有： - @ConditionalOnClass: 只有当 classpath 中存在指定的类时，才应用此配置。例如，如果 com.mysql.cj.jdbc.Driver 存在，则可能配置 MySQL 数据源。 - @ConditionalOnMissingClass: 当 classpath 中不存在指定的类时，才应用此配置。 - @ConditionalOnBean: 只有当 Spring 容器中已经存在指定的 Bean 时，才应用此配置。 - @ConditionalOnMissingBean: 只有当 Spring 容器中不存在指定的 Bean 时，才应用此配置。这是最重要的一个，它允许用户自定义配置来覆盖自动配置。 - @ConditionalOnProperty: 只有当指定的配置属性存在且值符合要求时，才应用此配置。例如，@ConditionalOnProperty(prefix = "spring.datasource", name = "url")。 - @ConditionalOnWebApplication: 只有当应用程序是 Web 应用时（例如，存在 Servlet 或 WebFlux 环境），才应用此配置。 - @ConditionalOnNotWebApplication: 当应用程序不是 Web 应用时。 - @ConditionalOnResource: 当 classpath 中存在指定资源时。 - @ConditionalOnJndi: 当 JNDI 环境中存在指定位置时。 - 这些条件注解确保了只有在真正需要时，才会加载和配置相应的 Bean，避免了不必要的资源消耗和潜在的冲突。

自动配置的流程概览#

  1. 启动应用: 当你运行 Spring Boot 的 main 方法时，SpringApplication.run() 会启动 Spring 应用程序上下文。
  2. 加载 ****@SpringBootApplication: 应用程序首先加载 @SpringBootApplication 注解所在的类。
  3. 启用 ****@EnableAutoConfiguration: SpringApplication 在启动过程中解析 EnableAutoConfiguration。
  4. 扫描 ****spring.factories: AutoConfigurationImportSelector 会在 classpath 下寻找所有 META-INF/spring.factories 文件，并读取 org.springframework.boot.autoconfigure.EnableAutoConfiguration 键下配置的所有自动配置类。
  5. 条件评估: 对于每个找到的自动配置类，Spring Boot 会对其（以及其内部的 @Bean 方法）上的所有 @ConditionalOn... 注解进行评估。
    • 例如，DataSourceAutoConfiguration 可能有 @ConditionalOnClass(DataSource.class)。
    • HibernateJpaAutoConfiguration 可能有 @ConditionalOnClass({ LocalContainerEntityManagerFactoryBean.class, EnableJpaRepositories.class })。
    • 某个 @Bean 方法可能带有 @ConditionalOnMissingBean，这意味着如果用户已经定义了相同类型的 Bean，那么自动配置的那个就不会生效。
  6. 注册 Bean: 只有当所有条件都满足时，该自动配置类及其定义的 Bean 才会加载到 Spring 容器中。
  7. 应用运行: 最终，一个配置完善的 Spring 应用程序上下文启动并运行。

自动配置的例子：数据库连接#

我们以数据库连接的自动配置为例：

  1. 你在 pom.xml 中引入了 spring-boot-starter-data-jpa 和 mysql-connector-java。
  2. spring-boot-starter-data-jpa 依赖了 spring-boot-starter-jdbc 和 hibernate-core 等。
  3. 当 Spring Boot 启动时，它会扫描 spring.factories。
  4. 它会找到 DataSourceAutoConfiguration。这个类可能带有 @ConditionalOnClass(DataSource.class) 和 @ConditionalOnMissingBean(DataSource.class)。因为 spring-boot-starter-jdbc 引入了 DataSource，所以 DataSourceAutoConfiguration 的类条件满足。如果你的代码中没有手动配置 DataSource Bean，那么 MissingBean 条件也满足。
  5. DataSourceAutoConfiguration 内部会根据 classpath 中存在的 JDBC 驱动（如 mysql-connector-java 提供了 MySQL 驱动类），以及 application.properties 中 spring.datasource.url 等属性，自动配置一个 DataSource Bean。
  6. 接着，HibernateJpaAutoConfiguration 也会被找到。它可能带有 @ConditionalOnClass({ LocalContainerEntityManagerFactoryBean.class, EnableJpaRepositories.class }) 和 @ConditionalOnBean(DataSource.class) 等条件。由于前面已经配置了 DataSource，这些条件也满足。
  7. HibernateJpaAutoConfiguration 会自动配置 LocalContainerEntityManagerFactoryBean、JpaTransactionManager 等与 JPA 相关的 Bean，使你能够直接使用 JpaRepository 进行数据访问。

优先级与用户自定义配置#

Spring Boot 自动配置的一个重要原则是**“用户自定义配置优先于自动配置”**。

  • 这主要通过 @ConditionalOnMissingBean 来实现。如果自动配置类发现 Spring 容器中已经存在了用户定义的同类型 Bean，那么它就不会再创建自己的 Bean。
  • 这意味着，如果你想覆盖 Spring Boot 的某个自动配置，你只需要在你的 @Configuration 类中声明一个相同类型的 Bean 即可。

总结#

Spring Boot 的自动配置通过**@EnableAutoConfiguration**** 结合 spring.factories 发现自动配置类**，并利用**@ConditionalOn...**** 注解进行条件判断**，从而实现“按需配置”。这种机制极大地简化了 Spring 应用的开发流程，减少了大量的样板代码，让开发者可以更专注于业务逻辑的实现，同时也保留了足够的灵活性，允许开发者在需要时覆盖默认配置。