【Spring】深入解析 EnableAutoConfiguration 注解：Spring Boot 自动配置的核心

前言

在 Spring Boot 中，@EnableAutoConfiguration 注解扮演着重要的角色，它是实现自动配置功能的关键。本文将深入探讨 @EnableAutoConfiguration 注解的作用、原理和使用方法，帮助大家更好地理解 Spring Boot 的自动配置机制。

一、@EnableAutoConfiguration 注解的作用

@EnableAutoConfiguration 注解用于启用 Spring Boot 的自动配置功能。它告诉 Spring Boot 应用程序自动配置应用程序所需的 Bean，从而减少了开发者的工作量，使得应用程序可以更快速地搭建和运行。

二、@EnableAutoConfiguration 注解的原理

2.1 @EnableAutoConfiguration 注解

@Target(ElementType.TYPE) // 注解应用目标为类
@Retention(RetentionPolicy.RUNTIME) // 注解保留到运行时
@Documented // 注解包含在 javadoc 中
@Inherited // 子类可以继承该注解
@AutoConfigurationPackage // 标记自动配置的包，用于扫描起始包
@Import(AutoConfigurationImportSelector.class) // 导入自动配置导入选择器类
public @interface EnableAutoConfiguration {

    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration"; // 环境属性，用于手动开启或关闭自动配置

    Class<?>[] exclude() default {}; // 排除特定的自动配置类，使其不会被应用

    String[] excludeName() default {}; // 排除特定名称的自动配置类，使其不会被应用
}

上面是 @EnableAutoConfiguration 注解的源码，注解只是一个标记并没有实际的功能。但是我们发现该注解之上使用了 @Import 注解导入了一个 AutoConfigurationImportSelector 类。其实，@EnableAutoConfiguration 的核心作用是为了导入 AutoConfigurationImportSelector 类。因为开启自动配置的原理在 AutoConfigurationImportSelector 里面。

2.2 AutoConfigurationImportSelector

AutoConfigurationImportSelector 是一个 ImportSelector。在 Spring 中会默认调用 ImportSelector 的 selectImports 方法。

/**
 * 根据给定的注解元数据选择要导入的自动配置类。
 * 如果自动配置未启用，则返回一个空数组。
 * 首先检查是否启用了自动配置，如果没有，则直接返回一个空数组。
 * 然后获取自动配置条目，该条目包含了选择的自动配置类列表。
 * 最后，将自动配置类列表转换为字符串数组并返回。
 */
public String[] selectImports(AnnotationMetadata annotationMetadata) {
    if (!isEnabled(annotationMetadata)) {
        // 如果自动配置未启用，则返回一个空数组
        return NO_IMPORTS;
    }
    
    // 获取自动配置条目，该条目包含了选择的自动配置类列表
    AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
    // 将自动配置类列表转换为字符串数组并返回
    return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}

在上述 selectImports 方法的源码中，我们可以知道：AutoConfigurationImportSelector 的真正核心逻辑在 getAutoConfigurationEntry 方法中。

/**
 * 根据给定的注解元数据选择自动配置条目。
 * 如果自动配置未启用，则返回一个空的 AutoConfigurationEntry 对象。
 * 首先检查是否启用了自动配置，如果没有，则直接返回一个空的 AutoConfigurationEntry 对象。
 */
protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
    if (!isEnabled(annotationMetadata)) {
        // 如果自动配置未启用，则返回一个空的 AutoConfigurationEntry 对象
        return EMPTY_ENTRY;
    }

    // 获取 @EnableAutoConfiguration 注解的属性
    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);
    // 创建并返回一个 AutoConfigurationEntry 对象，包含选择的自动配置类列表和排除的自动配置类列表
    return new AutoConfigurationEntry(configurations, exclusions);
}

在 getAutoConfigurationEntry 方法中，会执行具体哪些 Bean 应该被加载到 Spring 容器的逻辑，从而完成了自动配置。在源码中，我们发现获取候选自动配置类列表是通过 getCandidateConfigurations 方法。

/**
 * 获取候选自动配置类列表。
 * 首先从 META-INF/spring.factories 文件中加载自动配置类。
 * 然后从 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 文件中加载自动配置类。
 * 最后返回合并后的自动配置类列表。
 */
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
    // 从 META-INF/spring.factories 文件中加载自动配置类
    List<String> configurations = new ArrayList<>(
            SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader()));
    // 从 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 文件中加载自动配置类
    ImportCandidates.load(AutoConfiguration.class, getBeanClassLoader()).forEach(configurations::add);
    // 确保至少有一个自动配置类被加载，否则抛出异常
    Assert.notEmpty(configurations,
            "No auto configuration classes found in META-INF/spring.factories nor in META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports. If you "
                    + "are using a custom packaging, make sure that file is correct.");
    // 返回合并后的自动配置类列表
    return configurations;
}

在 getCandidateConfigurations 方法中，我们可以知道：为什么当我们想要自定义 Spring 的自动配置功能时，需要在 META-INF/spring.factories 文件中声明。因为 Spring 默认就会去读取这个文件中的类并将这些类实例化注册成容器的 Bean。

三、使用 @EnableAutoConfiguration

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan
public class Application {

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

通常 @EnableAutoConfiguration 会与 @ComponentScan、@SpringBootConfiguration 两个注解配合使用，通过这三个注解来配置 Spring Boot 应用程序的主应用程序类：

1. @SpringBootConfiguration: 这个注解是 Spring Boot 提供的专门用于配置类的注解，功能与 @Configuration 相同。它告诉 Spring Boot 这是一个配置类，用于配置应用程序的上下文。
2. @EnableAutoConfiguration: 这个注解启用了 Spring Boot 的自动配置功能。
3. @ComponentScan: 这个注解用于指定 Spring 在扫描组件时的基础包路径。如果不指定，默认会扫描当前类所在包及其子包下的所有组件。

Spring 为了简化我们的开发工作，又将这三个注解进行了一层包装：

/**
 * {@code @SpringBootApplication} 是 Spring Boot 应用程序的入口注解，用于配置主应用程序类。
 * 这个注解实际上包含了 {@code @EnableAutoConfiguration}、{@code @ComponentScan} 和 {@code @SpringBootConfiguration} 这三个注解的功能。
 * 通过使用 {@code @SpringBootApplication} 注解，可以快速配置一个基本的 Spring Boot 应用程序，并且启用了自动配置功能。
 */
@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 {

    /**
     * {@code @EnableAutoConfiguration} 注解的 {@code exclude} 属性的别名。
     */
    @AliasFor(annotation = EnableAutoConfiguration.class)
    Class<?>[] exclude() default {};

    /**
     * {@code @EnableAutoConfiguration} 注解的 {@code excludeName} 属性的别名。
     */
    @AliasFor(annotation = EnableAutoConfiguration.class)
    String[] excludeName() default {};

    /**
     * {@code @ComponentScan} 注解的 {@code basePackages} 属性的别名。
     */
    @AliasFor(annotation = ComponentScan.class, attribute = "basePackages")
    String[] scanBasePackages() default {};

    /**
     * {@code @ComponentScan} 注解的 {@code basePackageClasses} 属性的别名。
     */
    @AliasFor(annotation = ComponentScan.class, attribute = "basePackageClasses")
    Class<?>[] scanBasePackageClasses() default {};

    /**
     * {@code @ComponentScan} 注解的 {@code nameGenerator} 属性的别名。
     */
    @AliasFor(annotation = ComponentScan.class, attribute = "nameGenerator")
    Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;

    /**
     * {@code @Configuration} 注解的 {@code proxyBeanMethods} 属性的别名。
     */
    @AliasFor(annotation = Configuration.class)
    boolean proxyBeanMethods() default true;
}

当我们使用 @SpringBootApplication 注解时，就同时引入了上面的三个注解，这也是我们最常用的写法。

@SpringBootApplication
public class Application {

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

四、小结

通过深入解析 @EnableAutoConfiguration 注解，我们了解了它在 Spring Boot 中的作用、原理和使用方法。合理地使用自动配置功能，可以大大提高开发效率，减少配置工作，是 Spring Boot 框架的重要特性之一。

推荐阅读

1. Spring 三级缓存
2. 深入了解 MyBatis 插件：定制化你的持久层框架
3. Zookeeper 注册中心：单机部署
4. 【JavaScript】探索 JavaScript 中的解构赋值
5. 深入理解 JavaScript 中的 Promise、async 和 await