深入理解SpringBoot自动配置原理：从源码到实战-优快云博客

本文链接：https://blog.youkuaiyun.com/ashyyyy/article/details/149660998

🎓博主介绍：Java、Python、js全栈开发 “多面手”，精通多种编程语言和技术，痴迷于人工智能领域。秉持着对技术的热爱与执着，持续探索创新，愿在此分享交流和学习，与大家共进步。
📖DeepSeek-行业融合之万象视界(附实战案例详解100+)
📖全栈开发环境搭建运行攻略：多语言一站式指南(环境搭建+运行+调试+发布+保姆级详解)
👉感兴趣的可以先收藏起来，希望帮助更多的人

深入理解SpringBoot自动配置原理：从源码到实战

一、Spring Boot 自动配置概述

1.1 Spring Boot 简介

Spring Boot 是由 Pivotal 团队提供的全新框架，其设计目的是用来简化新 Spring 应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。通过 Spring Boot，我们可以快速创建独立的、生产级别的基于 Spring 的应用程序。

1.2 自动配置的作用

自动配置是 Spring Boot 的核心特性之一，它能够根据项目中添加的依赖自动配置 Spring 应用程序。例如，当我们在项目中添加了 Spring Data JPA 和 H2 数据库的依赖时，Spring Boot 会自动配置 JPA 和 H2 数据库，使得我们无需手动编写大量的配置代码，大大提高了开发效率。

二、Spring Boot 自动配置的源码分析

2.1 @SpringBootApplication 注解

@SpringBootApplication 是一个组合注解，它主要包含了 @SpringBootConfiguration、@EnableAutoConfiguration 和 @ComponentScan 三个注解。以下是 @SpringBootApplication 的源码：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
    // 省略属性定义
}

其中，@EnableAutoConfiguration 注解是开启自动配置的关键。

2.2 @EnableAutoConfiguration 注解

@EnableAutoConfiguration 注解的作用是启用 Spring Boot 的自动配置机制。它通过 @Import 注解导入了 AutoConfigurationImportSelector 类。以下是 @EnableAutoConfiguration 的源码：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
    // 省略属性定义
}

2.3 AutoConfigurationImportSelector 类

AutoConfigurationImportSelector 类负责加载所有的自动配置类。它会从 META-INF/spring.factories 文件中读取所有的自动配置类。以下是 AutoConfigurationImportSelector 类的关键方法：

@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
    if (!isEnabled(annotationMetadata)) {
        return NO_IMPORTS;
    }
    AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
    return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}

protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
    if (!isEnabled(annotationMetadata)) {
        return EMPTY_ENTRY;
    }
    AnnotationAttributes attributes = getAttributes(annotationMetadata);
    List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
    configurations = removeDuplicates(configurations);
    Set<String> exclusions = getExclusions(annotationMetadata, attributes);
    checkExcludedClasses(configurations, exclusions);
    configurations.removeAll(exclusions);
    configurations = getConfigurationClassFilter().filter(configurations);
    fireAutoConfigurationImportEvents(configurations, exclusions);
    return new AutoConfigurationEntry(configurations, exclusions);
}

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
    List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
            getBeanClassLoader());
    Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you "
            + "are using a custom packaging, make sure that file is correct.");
    return configurations;
}

2.4 META - INF/spring.factories 文件

META - INF/spring.factories 文件是 Spring Boot 自动配置的核心配置文件，它定义了所有的自动配置类。例如，Spring Boot 的 spring-boot-autoconfigure 模块中的 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,\
# 省略其他配置类

三、自动配置的条件注解

3.1 @Conditional 注解

@Conditional 注解是 Spring 4 引入的条件注解，它可以根据特定的条件来决定是否加载某个 Bean。@Conditional 注解需要传入一个 Condition 接口的实现类，当该实现类的 matches 方法返回 true 时，对应的 Bean 才会被加载。以下是一个简单的示例：

@Configuration
public class MyConfiguration {

    @Bean
    @Conditional(MyCondition.class)
    public MyBean myBean() {
        return new MyBean();
    }
}

class MyCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // 自定义条件判断逻辑
        return true;
    }
}

3.2 Spring Boot 常用的条件注解

Spring Boot 提供了一系列常用的条件注解，例如：

@ConditionalOnClass：当类路径下存在指定的类时，条件成立。
@ConditionalOnMissingClass：当类路径下不存在指定的类时，条件成立。
@ConditionalOnBean：当容器中存在指定的 Bean 时，条件成立。
@ConditionalOnMissingBean：当容器中不存在指定的 Bean 时，条件成立。
@ConditionalOnProperty：当配置文件中存在指定的属性，并且属性值符合要求时，条件成立。

以下是一个使用 @ConditionalOnProperty 注解的示例：

@Configuration
public class MyConfig {

    @Bean
    @ConditionalOnProperty(name = "my.property", havingValue = "true")
    public MyService myService() {
        return new MyService();
    }
}

四、Spring Boot 自动配置实战

4.1 创建一个 Spring Boot 项目

我们可以使用 Spring Initializr（https://start.spring.io/）来创建一个简单的 Spring Boot 项目。选择以下依赖：

Spring Web
Spring Data JPA
H2 Database

4.2 分析自动配置的效果

在创建好项目后，我们可以看到项目中并没有手动配置 JPA 和 H2 数据库，但程序可以正常运行。这是因为 Spring Boot 根据我们添加的依赖自动配置了 JPA 和 H2 数据库。以下是一个简单的控制器示例：

@RestController
@RequestMapping("/users")
public class UserController {

    @Autowired
    private UserRepository userRepository;

    @GetMapping
    public List<User> getUsers() {
        return userRepository.findAll();
    }
}

@Entity
class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;

    // 省略 getter 和 setter 方法
}

@Repository
interface UserRepository extends JpaRepository<User, Long> {
}

4.3 自定义自动配置

我们可以自定义一个自动配置类，来实现特定的功能。以下是一个简单的自定义自动配置示例：

@Configuration
@ConditionalOnClass(MyService.class)
@EnableConfigurationProperties(MyProperties.class)
public class MyAutoConfiguration {

    @Autowired
    private MyProperties properties;

    @Bean
    @ConditionalOnMissingBean
    public MyService myService() {
        return new MyService(properties.getMessage());
    }
}

@ConfigurationProperties(prefix = "my")
public class MyProperties {
    private String message = "Default message";

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

public class MyService {
    private String message;

    public MyService(String message) {
        this.message = message;
    }

    public String getMessage() {
        return message;
    }
}

同时，我们需要在 META - INF/spring.factories 文件中添加自定义的自动配置类：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.MyAutoConfiguration

五、总结

通过对 Spring Boot 自动配置原理的深入分析和实战演练，我们了解了 Spring Boot 自动配置的核心机制。自动配置通过 @SpringBootApplication、@EnableAutoConfiguration 等注解，结合 META - INF/spring.factories 文件和条件注解，实现了根据项目依赖自动配置 Spring 应用程序的功能。同时，我们也学会了如何自定义自动配置类，以满足特定的需求。