【SpringBoot3.x教程03】SpringBoot自动配置详解

时间：2024-03-07 20:18:25

前言：什么是自动配置

自动配置的原理
Spring Boot自动配置尝试根据添加到项目中的jar依赖、定义的bean以及各种属性设置来自动配置Spring应用。这是通过@EnableAutoConfiguration注解实现的，该注解通常是通过@SpringBootApplication注解间接应用的。Spring Boot会查看classpath上的内容，然后根据需要激活一系列自动配置的bean定义。

自动配置的工作方式
启动过程中的条件评估：自动配置是条件性的，意味着自动配置的应用依赖于特定条件。这些条件包括但不限于类路径上是否存在某个类、是否定义了某个bean、是否存在某个特定的环境属性等。Spring Boot利用@Conditional注解及其多个特定变体（如@ConditionalOnJava、@ConditionalOnBean、@ConditionalOnMissingBean、@ConditionalOnProperty等）来评估这些条件。

spring.factories文件：自动配置类是通过META-INF/spring.factories文件内的条目注册的。在这个文件中，可以通过org.springframework.boot.autoconfigure.EnableAutoConfiguration键指定配置类的全限定名。

如何覆盖自动配置
虽然自动配置提供了快速启动和运行应用的便利，但在某些情况下，开发者可能需要覆盖这些自动配置。Spring Boot提供了几种方法来实现这一点：

显式定义bean：如果你自己定义了一个bean，那么Spring Boot通常会退让，使用你的配置而不是自动配置的选项。
使用属性配置：许多自动配置类都提供了使用application.properties或application.yml文件设置属性来定制行为的能力。
排除自动配置类：可以在@SpringBootApplication注解中使用exclude属性来完全关闭特定的自动配置类。

本文重点：创建自定义自动配置

创建自定义的自动配置涉及到几个关键步骤：定义配置类、使用条件注解确保配置仅在合适的条件下生效、声明所需的bean，以及在META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中注册自定义自动配置。以下是一个详细且注释清晰的示例，展示如何创建和注册一个自定义的自动配置。

1. 定义一个服务接口和实现

首先，定义一个简单的服务接口及其实现，这个服务将通过自动配置在Spring应用上下文中注册。

// Service接口
public interface MyService {
    String serve();
}

// Service接口的实现
public class MyServiceImpl implements MyService {
    @Override
    public String serve() {
        return "My custom service";
    }
}

2. 创建自动配置类

自动配置类包含条件注解和@Bean方法，用于注册你的服务到Spring上下文。

package com.nextjava.autoconfig;

import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

// 使用@Configuration注解标记这是一个配置类
@Configuration
// 仅当指定的属性满足特定值时，该自动配置类才生效
@ConditionalOnProperty(name = "my.service.enabled", havingValue = "true", matchIfMissing = true)
public class MyAutoConfiguration {

    // @Bean注解告诉Spring这个方法将返回一个对象，该对象要注册到Spring应用上下文中
    // @ConditionalOnMissingBean注解确保仅在不存在MyService类型的bean时才创建新的bean
    @Bean
    @ConditionalOnMissingBean
    public MyService myService() {
        return new MyServiceImpl();
    }
}

注解解释：

  • @Configuration：标记一个类作为配置类，允许使用@Bean注解定义bean。
  • @ConditionalOnProperty：条件注解，用于判断指定的属性是否有特定的值。在这个例子中，只有当my.service.enabled属性为true时（或在该属性缺失时），配置才生效。
  • @Bean：标记一个方法，表示返回的对象应该被注册为一个bean在Spring应用上下文中。
  • @ConditionalOnMissingBean：条件注解，用于仅在上下文中缺少指定类型的bean时，才创建标记的bean。

3. 在org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中注册自动配置类

在resources/META-INF目录下创建或编辑org.springframework.boot.autoconfigure.AutoConfiguration.imports文件，并添加以下内容以注册自动配置类。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.nextjava.autoconfig.MyAutoConfiguration

4. 使用自定义自动配置

为了使用这个自动配置，确保：

  • 你的项目是一个Spring Boot项目；
  • my.service.enabled属性（在application.properties或application.yml中）被设置为true；当设置为false时，项目启动失败，可自行尝试
  • 你的自动配置jar包已经加入到项目的类路径中。

项目代码截图
在这里插入图片描述
在这里插入图片描述

结束语

本文中的自动配置极大地简化了应用的配置过程，使开发者能够快速启动和开发Spring应用。通过理解和利用自动配置的原理和机制，开发者可以更有效地使用Spring Boot，并根据需要定制和扩展自动配置。下一章节我们将开始学习如何开发一个starter，敬请期待

相关文章