深入理解 Spring Boot 自动配置原理

最新推荐文章于 2024-09-27 17:44:56 发布

Passion不晚

最新推荐文章于 2024-09-27 17:44:56 发布

阅读量635

点赞数 21

分类专栏： Java 文章标签： spring boot 后端 java

本文链接：https://blog.csdn.net/m0_61118741/article/details/142500735

版权

Java 专栏收录该内容

13 篇文章 1 订阅

订阅专栏

深入理解 Spring Boot 自动配置原理

引言

Spring Boot 的流行很大程度上要归功于其“自动配置”功能，它使得开发者能够快速启动并开发复杂的 Spring 应用，而不需要手动配置大量的 XML 或 Java 配置文件。在这篇博客中，我们将深入探索 Spring Boot 自动配置的工作原理，了解它如何根据项目的依赖和环境做出智能的配置选择，并附上详细的代码示例和分析，帮助你真正理解 Spring Boot 是如何让配置变得如此简单。

1. 什么是 Spring Boot 自动配置？

在传统的 Spring 框架中，开发者需要编写大量的配置代码来启动应用，比如定义 Bean、配置数据库连接池、JPA 配置等。而 Spring Boot 则通过自动配置来减少这些繁琐的工作。所谓自动配置，就是根据项目依赖和环境信息，自动为你创建和配置相关的 Spring Bean 和服务。

Spring Boot 使用了 @EnableAutoConfiguration 注解来实现这一功能，它会根据类路径中的依赖，自动配置应用所需的 Bean。

2. 自动配置的核心：`@EnableAutoConfiguration`

@EnableAutoConfiguration 是 Spring Boot 自动配置的核心注解，它的作用是让 Spring Boot 自动配置框架查找项目中的依赖，推断应用需要的配置并为其创建相应的 Bean。

它通常与 @SpringBootApplication 一起使用，后者实际上是一个组合注解，包含了 @Configuration、@EnableAutoConfiguration 和 @ComponentScan：

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

2.1 `@SpringBootApplication` 细节

这个注解相当于以下三个注解的组合：

@Configuration: 标识该类为配置类，相当于一个 XML 配置文件。
@EnableAutoConfiguration: 开启自动配置。
@ComponentScan: 自动扫描当前包下的所有 Spring 组件。

3. Spring Boot 如何实现自动配置？

Spring Boot 的自动配置是通过查找类路径中的依赖并根据这些依赖提供合适的配置。例如，如果类路径中存在 H2 数据库的依赖，Spring Boot 会自动配置一个内存数据库；如果存在 MySQL 依赖，它会自动配置 MySQL 连接。

3.1 `spring.factories` 文件

Spring Boot 的自动配置机制依赖于 spring.factories 文件。这个文件位于 META-INF 目录下，Spring Boot 会扫描该文件并加载其中定义的自动配置类。

让我们看一下 spring-boot-autoconfigure.jar 中的 spring.factories 文件部分内容：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration

这个文件将自动配置类与 @EnableAutoConfiguration 关联起来。Spring Boot 启动时，会通过这个文件加载所有自动配置类。

3.2 `AutoConfiguration` 类示例

下面是 DataSourceAutoConfiguration 类的简化版本，它会根据类路径中是否存在数据源相关的依赖自动配置数据源：

@Configuration
@ConditionalOnClass(DataSource.class)
@EnableConfigurationProperties(DataSourceProperties.class)
@Import({DataSourcePoolMetadataProvidersConfiguration.class})
public class DataSourceAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean
    public DataSource dataSource(DataSourceProperties properties) {
        return properties.initializeDataSourceBuilder().build();
    }
}

解读：

@ConditionalOnClass(DataSource.class): 只有当类路径下存在 javax.sql.DataSource 类时，才会加载这个配置。
@ConditionalOnMissingBean: 如果当前上下文中没有定义 DataSource Bean，则该方法定义的数据源 Bean 会被加载。
@EnableConfigurationProperties: 将 DataSourceProperties 配置类与应用属性绑定。

4. 自动配置的触发条件

自动配置不会无条件地加载。Spring Boot 通过条件注解来控制配置的加载。这些注解包括但不限于：

@ConditionalOnClass: 类路径中存在某个类时加载配置。
@ConditionalOnMissingBean: 如果没有定义某个 Bean 时加载配置。
@ConditionalOnProperty: 某个配置属性的值为 true 时加载配置。

示例：@ConditionalOnProperty 的用法

@Configuration
@ConditionalOnProperty(name = "example.feature.enabled", havingValue = "true")
public class ExampleFeatureAutoConfiguration {

    @Bean
    public ExampleService exampleService() {
        return new ExampleService();
    }
}

在上面的例子中，ExampleService 只有在配置文件中存在 example.feature.enabled=true 时才会被加载。

5. 如何自定义和排除自动配置？

5.1 自定义自动配置

如果你想自定义某个自动配置组件，可以通过定义相同类型的 Bean 来覆盖默认配置。例如，如果你想自定义数据源配置，可以在你的应用中添加以下代码：

@Bean
public DataSource customDataSource() {
    return new HikariDataSource(); // 使用自定义的数据源实现
}

Spring Boot 会自动使用你定义的 Bean，而不会再加载默认的自动配置。

5.2 排除自动配置

在某些情况下，你可能不需要某个自动配置。可以通过 @SpringBootApplication 的 exclude 参数排除某个自动配置类：

@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

6. 实战示例：创建自定义的自动配置

现在，我们通过创建一个简单的自动配置类来实践自动配置的原理。我们将创建一个简单的 HelloService，并通过自动配置使其根据配置文件中的属性来控制是否启用该服务。

6.1 创建服务类

public class HelloService {
    public void sayHello() {
        System.out.println("Hello from HelloService!");
    }
}

6.2 创建自动配置类

@Configuration
@ConditionalOnClass(HelloService.class)
@ConditionalOnProperty(name = "hello.service.enabled", havingValue = "true", matchIfMissing = true)
public class HelloServiceAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean
    public HelloService helloService() {
        return new HelloService();
    }
}

解释：

@ConditionalOnClass(HelloService.class): 只有在类路径中存在 HelloService 时才加载配置。
@ConditionalOnProperty(name = "hello.service.enabled", havingValue = "true", matchIfMissing = true): 只有当配置文件中 hello.service.enabled=true 时，才会启用自动配置。

6.3 配置文件

在 application.properties 中添加：

hello.service.enabled=true

现在运行应用时，HelloService 会被自动配置并调用其方法：

@SpringBootApplication
public class DemoApplication implements CommandLineRunner {

    @Autowired
    private HelloService helloService;

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Override
    public void run(String... args) throws Exception {
        helloService.sayHello(); // 输出: Hello from HelloService!
    }
}