拿 @SpringBootApplication 注解开刀，让你更懂什么是自动配置

刘水镜 2023-03-28 原文

上一篇我们从 run() 方法切入，分析了 Spring 容器的启动流程。今天我们拿 @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 {
  ......
}

可以看到，@SpringBootApplication 是一个组合注解。除了最上面的几个元注解以以外，还有三个 Spring 的注解：

@SpringBootConfiguration，表示被注解的元素为一个 Spring Boot 配置类
@EnableAutoConfiguration，负责开启自动配置的注解
@ComponentScan，用于配置扫描的包路径

自动配置原理

关键点

我们重点关注 @EnableAutoConfiguration，我们继续深入源码：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
  ......
}

@Import 注解和AutoConfigurationImportSelector 类是我们需要特别关注的。先剧透一下结论：自动配置的工作就是在 AutoConfigurationImportSelector 类中完成的。通过 getAutoConfigurationEntry 方法得到一个需要自动配置的列表：

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;
}
protected Class<?> getSpringFactoriesLoaderFactoryClass() {
    return EnableAutoConfiguration.class;
}

getCandidateConfigurations 方法会获取到 Spring 预设的自动配置列表，一共有一百多项（具体的数量不同版本可能会有差别），这个列表的名单就放在 spring-boot-autoconfigure-x.x.x.RELEASE.jar 包中的 /META-INF/spring.factories 文件中。如果我们指定了需要关闭的自动配置项，那么会通过 configurations.removeAll(exclusions) 将其从列表中移除。最后通过 filter 方法过滤掉不需要自动配置的项，最终会得到一个包含所有需要自动配置项的列表。

层层深入

获取预设自动配置列表

AutoConfigurationImportSelector 类（在 getCandidateConfigurations() 方法中）通过调用 SpringFactoriesLoader 的 loadFactoryNames() 方法来读取 spring.factories 文件中的 key（org.springframework.boot.autoconfigure.EnableAutoConfiguration）来加载 Spring 预设的自动配置列表。

读取 spring.factories 文件的源码示例：

public final class SpringFactoriesLoader {
    // spring.factories 文件路径
    public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
    ......
         
    public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
    ClassLoader classLoaderToUse = classLoader;
    if (classLoaderToUse == null) {
      classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();
    }
    String factoryTypeName = factoryType.getName();
        // 调用真正读取 spring.factories 文件的方法
    return loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());
  }
  private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
    ......
    try {
            // 读取 spring.factories 文件
      Enumeration<URL> urls = classLoader.getResources(FACTORIES_RESOURCE_LOCATION);
      ......
    }
    ......
  }
    ......
}

处理 @Import

分析完AutoConfigurationImportSelector 类，下面来分析 @Import 注解。正是因为这个注解，ImportSelector 才能处理自动配置的逻辑。@Import 的处理逻辑是由 ConfigurationClassParser 类完成的，入口是 doProcessConfigurationClass() 方法：

class ConfigurationClassParser {
    ......
    protected final SourceClass doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass)
      throws IOException {
    ......
    // 处理 @PropertySource 注解
    for (AnnotationAttributes propertySource : AnnotationConfigUtils.attributesForRepeatable(
        sourceClass.getMetadata(), PropertySources.class,
        org.springframework.context.annotation.PropertySource.class)) {
      ......
    }
    // 处理 @ComponentScan 注解
    Set<AnnotationAttributes> componentScans = AnnotationConfigUtils.attributesForRepeatable(
        sourceClass.getMetadata(), ComponentScans.class, ComponentScan.class);
    if (!componentScans.isEmpty() &&
        !this.conditionEvaluator.shouldSkip(sourceClass.getMetadata(), ConfigurationPhase.REGISTER_BEAN)) {
      for (AnnotationAttributes componentScan : componentScans) {
        Set<BeanDefinitionHolder> scannedBeanDefinitions =
            this.componentScanParser.parse(componentScan, sourceClass.getMetadata().getClassName());
        ......
      }
    }
    // 处理 @Import 注解
    processImports(configClass, sourceClass, getImports(sourceClass), filter, true);
    // 处理 @ImportResource 注解
    AnnotationAttributes importResource =
        AnnotationConfigUtils.attributesFor(sourceClass.getMetadata(), ImportResource.class);
    if (importResource != null) {
      String[] resources = importResource.getStringArray("locations");
      Class<? extends BeanDefinitionReader> readerClass = importResource.getClass("reader");
      for (String resource : resources) {
        String resolvedResource = this.environment.resolveRequiredPlaceholders(resource);
        configClass.addImportedResource(resolvedResource, readerClass);
      }
    }
    ......
  }    
    ......       
  private void processImports(ConfigurationClass configClass, SourceClass currentSourceClass,
      Collection<SourceClass> importCandidates, Predicate<String> exclusionFilter,
      boolean checkForCircularImports) {
    ......
    if (checkForCircularImports && isChainedImportOnStack(configClass)) {
      ......
    }
    else {
      this.importStack.push(configClass);
      try {
        for (SourceClass candidate : importCandidates) {
                    // 处理 ImportSelector
          if (candidate.isAssignable(ImportSelector.class)) {
            Class<?> candidateClass = candidate.loadClass();
            ImportSelector selector = ParserStrategyUtils.instantiateClass(candidateClass, ImportSelector.class,
                this.environment, this.resourceLoader, this.registry);
            Predicate<String> selectorFilter = selector.getExclusionFilter();
            if (selectorFilter != null) {
              exclusionFilter = exclusionFilter.or(selectorFilter);
            }
            if (selector instanceof DeferredImportSelector) {
              this.deferredImportSelectorHandler.handle(configClass, (DeferredImportSelector) selector);
            }
            else {
              String[] importClassNames = selector.selectImports(currentSourceClass.getMetadata());
              Collection<SourceClass> importSourceClasses = asSourceClasses(importClassNames, exclusionFilter);
                            // 递归调用
              processImports(configClass, currentSourceClass, importSourceClasses, exclusionFilter, false);
            }
          }
          else if (candidate.isAssignable(ImportBeanDefinitionRegistrar.class)) {
            ......
          }
          else {
            this.importStack.registerImport(
                currentSourceClass.getMetadata(), candidate.getMetadata().getClassName());
            processConfigurationClass(candidate.asConfigClass(configClass), exclusionFilter);
          }
        }
      }
      ......
    }
  }    
}

doProcessConfigurationClass() 方法调用 processImports() 方法来处理 @Import 注解。processImports() 方法中又分情况对 @Import 注解中的值执行了不同的处理逻辑。当值为 ImportSelector.class 及其子接口/实现类（AutoConfigurationImportSelector 是 ImportSelector 的实现类）时，还会通过递归再次调用自己。

这段逻辑相对比较复杂，不仅有自我递归，还有多个方法间的“串联递归”。上面代码中，进入最后一个 else 下面的 processConfigurationClass() 方法，你会看到它里面还有对doProcessConfigurationClass() 方法的调用，这样就形成了一个调用环：doProcessConfigurationClass() -> processImports() -> processConfigurationClass() -> doProcessConfigurationClass() 。

调用链

下面是我整理的一份从 Spring 容器启动一直到自动配置功能完成的方法调用链，可以在看源码或者 Debug 的时候作为参考：

1. SpringApplication
   1. run()
   2. refreshContext()
   3. refresh()
2. AbstractApplicationContext
   1. refresh()
   2. invokeBeanFactoryPostProcessors()
3. PostProcessorRegistrationDelegate
   1. invokeBeanFactoryPostProcessors()
4. ConfigurationClassPostProcessor
   1. postProcessBeanDefinitionRegistry()
   2. processConfigBeanDefinitions()
5. ConfigurationClassParser
   1. parse()
6. ConfigurationClassParser.DeferredImportSelectorHandler
   1. process()
7. ConfigurationClassParser.DeferredImportSelectorGroupingHandler
   1. processGroupImports()
8. ConfigurationClassParser.DeferredImportSelectorGrouping
   1. getImports()
9. AutoConfigurationImportSelector.AutoConfigurationGroup
   1. process()
10. AutoConfigurationImportSelector
    1. getAutoConfigurationEntry()

第一层级为类，其中还有几个是内部类，用“.”和主类隔开了，第二层级为该类下的方法。从上到下按顺序依次调用。

大致的调用关系就是这样，可以当做一个参考，不能保证完全严谨正确，需要注意不同版本可能有些许的出入，如果发现上述顺序有误，欢迎与我交流。

注意

如果你在网上搜索 Spring Boot 自动配置，你会发现很多文章的入手点是AutoConfigurationImportSelector.selectImports()。那么他的文章是基于 Spring Boot 2.1.0 之前的版本。

之所以有这样的结论是因为在 2.1.0 之后的版本中ConfigurationClassParser.processImports() 的代码如下：

if (selector instanceof DeferredImportSelector) {
    this.deferredImportSelectorHandler.handle(configClass, (DeferredImportSelector) selector);
}
else {
    String[] importClassNames = selector.selectImports(currentSourceClass.getMetadata());
    ......
}

而AutoConfigurationImportSelector 就是 DeferredImportSelector 的实现类，所以根本不会走 else 中的逻辑。

按需配置

Spring Boot 的自动配置再一次践行了约定优于配置的原则。它的自动配置并不是一股脑的将所有预设列表全部加载进来，而是非常智能的“按需配置”。能做到这一点要归功于 @Conditional 注解和 Condition 接口。它们使得各种配置只有在符合一定的条件时才会被加载。

在讲自动配置原理的时候，我们了解到
AutoConfigurationImportSelector.getAutoConfigurationEntry() 方法中 configurations = getConfigurationClassFilter().filter(configurations) 就是用来过滤那些不符合条件配置的。

我们以DataSourceAutoConfiguration 为例来具体分析一下，先来看一下源码：

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass({ DataSource.class, EmbeddedDatabaseType.class })
@ConditionalOnMissingBean(type = "io.r2dbc.spi.ConnectionFactory")
@EnableConfigurationProperties(DataSourceProperties.class)
@Import({ DataSourcePoolMetadataProvidersConfiguration.class,
    DataSourceInitializationConfiguration.InitializationSpecificCredentialsDataSourceInitializationConfiguration.class,
    DataSourceInitializationConfiguration.SharedCredentialsDataSourceInitializationConfiguration.class })
public class DataSourceAutoConfiguration {
    ......
}

DataSourceAutoConfiguration 通过 @ConditionalOnClass({ DataSource.class, EmbeddedDatabaseType.class }) 告诉 Spring，只有当 classpath 下存在 DataSource.class 或 EmbeddedDatabaseType.class 时，DataSourceAutoConfiguration 才会被加载。

@ConditionalOnClass 是 @Conditional 的衍生注解，由 @Conditional 和 OnClassCondition 类组成，源码如下：

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnClassCondition.class)
public @interface ConditionalOnClass {
  ......
}

内置条件注解

OnClassCondition 是一个实现了 Condition 接口的类，@ConditionalOnClass 表示 classpath 里有指定的类时加载配置。它是 @Conditional 众多衍生注解中的一个，Spring Boot 提供了一些基于 @Conditional 的衍生注解，见表 8-1：

注解	说明
@ConditionalOnBean	当容器里有指定 Bean 时
@ConditionalOnMissingBean	当容器里没有指定 Bean 时
@ConditionalOnClass	classpath 里有指定的类时
@ConditionalOnMissingClass	classpath 里没有指定的类时
@ConditionalOnExpression	给定的 Spring Expression Language（SpEL）表达式计算结果为 true 时
@ConditionalOnJava	JVM 的版本匹配特定值或者一个范围时
@ConditionalOnJndi	参数中给定的 JNDI 位置至少存在一个时（如果没有给参数，则要有 JNDI InitialContext）
@ConditionalOnProperty	指定的属性为指定的值时
@ConditionalOnResource	classpath 里有指定的资源时
@ConditionalOnWebApplication	当前应用是 Web 应用时
@ConditionalOnNotWebApplication	当前应用不是 Web 应用时

这些注解都是基于 @Conditional，可以覆盖到我们大多数的使用场景，如果以上情况不能满足你的需求，还可以通过自己实现 Condition 接口来完成自定义的需求。

SpringBootApplication 注解 span style color 开发架构 $Spring 容器自动配置

有关拿 @SpringBootApplication 注解开刀，让你更懂什么是自动配置的更多相关文章

ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法？ - 2
类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc
ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2
很好奇，就使用rubyonrails自动化单元测试而言，你们正在做什么？您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您？git中的预提交Hook？只是手动调用？我完全理解测试，但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的，并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您？最佳答案不确定您到底想听什么，但是有几个级别的自动代码库控制:在处理某项功能时，您可以使用类似autotest的内容获得关于哪些有效，哪些无效的即时反馈。要确保您的提
ruby-on-rails - Rails - 子类化模型的设计模式是什么？ - 2
我有一个模型:classItem项目有一个属性“商店”基于存储的值，我希望Item对象对特定方法具有不同的行为。Rails中是否有针对此的通用设计模式？如果方法中没有大的if-else语句，这是如何干净利落地完成的？最佳答案通常通过Single-TableInheritance. 关于ruby-on-rails-Rails-子类化模型的设计模式是什么？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.co
ruby - 什么是填充的 Base64 编码字符串以及如何在 ruby 中生成它们？ - 2
我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%
ruby - 解析 RDFa、微数据等的最佳方式是什么，使用统一的模式/词汇(例如 schema.org)存储和显示信息 - 2
我主要使用Ruby来执行此操作，但到目前为止我的攻击计划如下:使用gemsrdf、rdf-rdfa和rdf-microdata或mida来解析给定任何URI的数据。我认为最好映射到像schema.org这样的统一模式，例如使用这个yaml文件，它试图描述数据词汇表和opengraph到schema.org之间的转换:#SchemaXtoschema.orgconversion#data-vocabularyDV:name:namestreet-address:streetAddressregion:addressRegionlocality:addressLocalityphoto:i
ruby - 为什么 4.1%2 使用 Ruby 返回 0.0999999999999996？但是 4.2%2==0.2 - 2
为什么4.1%2返回0.0999999999999996？但是4.2%2==0.2。最佳答案参见此处:WhatEveryProgrammerShouldKnowAboutFloating-PointArithmetic实数是无限的。计算机使用的位数有限(今天是32位、64位)。因此计算机进行的浮点运算不能代表所有的实数。0.1是这些数字之一。请注意，这不是与Ruby相关的问题，而是与所有编程语言相关的问题，因为它来自计算机表示实数的方式。关于ruby-为什么4.1%2使用Ruby返
ruby - ruby 中的 TOPLEVEL_BINDING 是什么？ - 2
它不等于主线程的binding，这个toplevel作用域是什么？此作用域与主线程中的binding有何不同？>ruby-e'putsTOPLEVEL_BINDING===binding'false 最佳答案事实是，TOPLEVEL_BINDING始终引用Binding的预定义全局实例，而Kernel#binding创建的新实例>Binding每次封装当前执行上下文。在顶层，它们都包含相同的绑定(bind)，但它们不是同一个对象，您无法使用==或===测试它们的绑定(bind)相等性。putsTOPLEVEL_BINDINGput
ruby-on-rails - 独立 ruby 脚本的配置文件 - 2
我有一个在Linux服务器上运行的ruby脚本。它不使用rails或任何东西。它基本上是一个命令行ruby脚本，可以像这样传递参数:./ruby_script.rbarg1arg2如何将参数抽象到配置文件(例如yaml文件或其他文件)中？您能否举例说明如何做到这一点？提前谢谢你。最佳答案首先，您可以运行一个写入YAML配置文件的独立脚本:require"yaml"File.write("path_to_yaml_file",[arg1,arg2].to_yaml)然后，在您的应用中阅读它:require"yaml"arg
ruby - Infinity 和 NaN 的类型是什么？ - 2
我可以得到Infinity和NaNn=9.0/0#=>Infinityn.class#=>Floatm=0/0.0#=>NaNm.class#=>Float但是当我想直接访问Infinity或NaN时:Infinity#=>uninitializedconstantInfinity(NameError)NaN#=>uninitializedconstantNaN(NameError)什么是Infinity和NaN？它们是对象、关键字还是其他东西？最佳答案您看到打印为Infinity和NaN的只是Float类的两个特殊实例的字符串
ruby-on-rails - 如果 Object::try 被发送到一个 nil 对象，为什么它会起作用？ - 2
如果您尝试在Ruby中的nil对象上调用方法，则会出现NoMethodError异常并显示消息:"undefinedmethod‘...’fornil:NilClass"然而，有一个tryRails中的方法，如果它被发送到一个nil对象，它只返回nil:require'rubygems'require'active_support/all'nil.try(:nonexisting_method)#noNoMethodErrorexceptionanymore那么try如何在内部工作以防止该异常？最佳答案像Ruby中的所有其他对象