SpringBoot自动配置原理

传统的Spring项目，需要我们对每个引入的组件进行手动配置。

这需要开发者对组件有深入的了解，否则很容易遗漏某些细节。对于业务开发人员/公司来说，他们只需要知道如何使用组件即可，不需要过多了解底层配置原理。如果有多个项目，则需要将配置进行多次拷贝，会增大无意义的工作量。

实际上，每个第三方组件的配置都是相对固定的，只有其中一些参数可能需要根据运行环境进行修改。例如spring-mvc有它自己的一套配置，spring-mybatis也有它自己的一套配置。我们可以将这些第三方组件的基础配置抽取出来，通过配置文件动态修改其中的运行参数。后续需要重复使用时，只需要将相同的基础依赖，可以大大减小重复开发的工作量。

另一方面，组件开发者肯定要比我们这些使用者更加熟悉底层细节。因此，最稳妥的方法是由组件开发者去抽象对应组件的基础配置。我们使用者只需要熟悉组件暴露的配置文件即可。这些由组件开发者抽象出的基础配置，在Spring Boot中就是starter。

Spring Boot就是为了解决上述问题而开发出来的。它提供自动配置的SPI机制，制定了从starter读取配置的规则。第三方组件根据规则编写基础配置信息。后续引入依赖时，我们只要开启EnableAutoConfiguration注解，Spring Boot会根据SPI规则读取配置。

上图Spring Boot自动配置SPI机制的相关类图，主要可以分为3个模块：

ConfigurationClassPostProcessor：基于@Configuration的BeanFactoryPostProcessor。
AutoConfigurationImportSelector：注册指定目录文件中的配置类。
Registrar：注册指定路径下的类。

Spring Boot自动配置的SPI机制原理基于ConfigurationClassPostProcessor，它是一个BeanFactoryPostProcessor，会在读取依赖配置后，对配置类BeanDefinition进行处理。自动配置机制使用了其中的@Import功能。

@Import注解可以注册指定依赖配置：

ImportSelector：根据选择规则注册。
ImportBeanDefinitionRegistrar：注册额外依赖配置。
其他：作为配置类注册。

通过org.springframework.boot.autoconfigure.AutoConfigurationPackages.Registrar和org.springframework.boot.autoconfigure.AutoConfigurationImportSelector，自动配置SPI机制会自动注册以下依赖：

标注@EnableAutoConfiguration注解的配置类所在包下的所有注解依赖。
注册META-INF/spring.factories中键为org.springframework.boot.autoconfigure.EnableAutoConfiguration的类。
注册META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports中的所有类。

对于starter来说，它只需要定义要相关配置，然后在META-INF/spring.factories或META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports中指定配置类就可以了。

1 @EnableAutoConfiguration详解

@EnableAutoConfiguration可以开启Spring Boot的自动注册功能，由于它基于ConfigurationClassPostProcessor，所以需要同时添加@Configuration注解：

@Configuration
@EnableAutoConfiguration
public class AppConfig {
}

@EnableAutoConfiguration核心源码如下，它会使用AutoConfigurationImportSelector，注册META-INF/spring.factories和META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports中的类。：

@AutoConfigurationPackage  
@Import(AutoConfigurationImportSelector.class)  
public @interface EnableAutoConfiguration {  
   // environment变量是否可以覆盖starter中的配置变量
   String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";  
   // 指定排除的类
   Class<?>[] exclude() default {};  
   // 指定排除的类名
   String[] excludeName() default {};  
}

元注解@AutoConfigurationPackage的核心源码如下，默认会扫描标注该注解的类所在的包路径：

@Import(AutoConfigurationPackages.Registrar.class)  
public @interface AutoConfigurationPackage {  
   // 指定扫描包路径
   String[] basePackages() default {};  
   // 指定类，会扫描该类所在包路径
   Class<?>[] basePackageClasses() default {};  
}

需要注意的是，我们通常不会直接使用@EnableAutoConfiguration，而是使用集成自动配置功能的@SpringBootApplication，它与自动配置相关的核心源码如下：

@SpringBootConfiguration  // 集成@Configuration功能
@EnableAutoConfiguration  
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),  
      @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })  
public @interface SpringBootApplication {  
   // 指定自动配置的排除类
   @AliasFor(annotation = EnableAutoConfiguration.class)  
   Class<?>[] exclude() default {};  
   // 指定自动配置的排除类名
   @AliasFor(annotation = EnableAutoConfiguration.class)  
   String[] excludeName() default {};  
}

2 自动注册SPI机制原理

2.1 @Import功能

@Import是ConfigurationClassPostProcessor针对@Configuration配置类提供的增强功能，具体原理可以查看相关文章（@Configuration的基本使用和工作原理），这里主要介绍@Import的相关原理。

ConfigurationClassParser#processImports()定义了具体导入流程：

private void processImports(ConfigurationClass configClass, SourceClass currentSourceClass,  
      Collection<SourceClass> importCandidates, Predicate<String> exclusionFilter,  
      boolean checkForCircularImports) {  
  
   if (importCandidates.isEmpty()) {  
      return;  
   }  
  
   if (checkForCircularImports && isChainedImportOnStack(configClass)) {  
      this.problemReporter.error(new CircularImportProblem(configClass, this.importStack));  
   }  
   else {  
      this.importStack.push(configClass);  
      try {  
         for (SourceClass candidate : importCandidates) {  
            // ImportSelector导入流程
            if (candidate.isAssignable(ImportSelector.class)) {  
               // Candidate class is an ImportSelector -> delegate to it to determine imports  
               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);  
               }  
            }  
            // ImportBeanDefinitionRegistrar导入流程
            else if (candidate.isAssignable(ImportBeanDefinitionRegistrar.class)) {  
               // Candidate class is an ImportBeanDefinitionRegistrar ->  
               // delegate to it to register additional bean definitions               
               Class<?> candidateClass = candidate.loadClass();  
               ImportBeanDefinitionRegistrar registrar =  
                     ParserStrategyUtils.instantiateClass(candidateClass, ImportBeanDefinitionRegistrar.class,  
                           this.environment, this.resourceLoader, this.registry);  
               configClass.addImportBeanDefinitionRegistrar(registrar, currentSourceClass.getMetadata());  
            }  
            // 配置类导入流程
            else {  
               // Candidate class not an ImportSelector or ImportBeanDefinitionRegistrar ->  
               // process it as an @Configuration class               
               this.importStack.registerImport(  
                     currentSourceClass.getMetadata(), candidate.getMetadata().getClassName());  
               processConfigurationClass(candidate.asConfigClass(configClass), exclusionFilter);  
            }  
         }  
      }  
      catch (BeanDefinitionStoreException ex) {  
         throw ex;  
      }  
      catch (Throwable ex) {  
         throw new BeanDefinitionStoreException(  
               "Failed to process import candidates for configuration class [" +  
               configClass.getMetadata().getClassName() + "]", ex);  
      }  
      finally {  
         this.importStack.pop();  
      }  
   }  
}

2.1.1 DeferredImportSelector

对于DeferredImportSelector，导入入口位于ConfigurationClassParser.DeferredImportSelectorHandler#handle()：

public void handle(ConfigurationClass configClass, DeferredImportSelector importSelector) {  
   DeferredImportSelectorHolder holder = new DeferredImportSelectorHolder(configClass, importSelector);  
   if (this.deferredImportSelectors == null) {  
      DeferredImportSelectorGroupingHandler handler = new DeferredImportSelectorGroupingHandler();  
      handler.register(holder);  
      // 实际导入逻辑
      handler.processGroupImports();  
   }  
   else {  
      this.deferredImportSelectors.add(holder);  
   }  
}

它会从DeferredImportSelector实现类中获取需要导入的类，然后继续按照按ImportSelector、ImportBeanDefinitionRegistrar和配置类递归进行导入。ConfigurationClassParser.DeferredImportSelectorGroupingHandler#processGroupImports()：

public void processGroupImports() {  
   for (DeferredImportSelectorGrouping grouping : this.groupings.values()) {  
      Predicate<String> exclusionFilter = grouping.getCandidateFilter();  
      // 获取分组导入的类，递归进行导入（按ImportSelector、ImportBeanDefinitionRegistrar和配置类）
      grouping.getImports().forEach(entry -> {  
         ConfigurationClass configurationClass = this.configurationClasses.get(entry.getMetadata());  
         try {  
            processImports(configurationClass, asSourceClass(configurationClass, exclusionFilter),  
                  Collections.singleton(asSourceClass(entry.getImportClassName(), exclusionFilter)),  
                  exclusionFilter, false);  
         }  
         catch (BeanDefinitionStoreException ex) {  
            throw ex;  
         }  
         catch (Throwable ex) {  
            throw new BeanDefinitionStoreException(  
                  "Failed to process import candidates for configuration class [" +  
                        configurationClass.getMetadata().getClassName() + "]", ex);  
         }  
      });  
   }  
}

ConfigurationClassParser.DeferredImportSelectorGrouping#getImports()中会对每个分组进行处理，然后再获取配置类：

public Iterable<Group.Entry> getImports() {  
   for (DeferredImportSelectorHolder deferredImport : this.deferredImports) {  
      // 执行分组规则
      this.group.process(deferredImport.getConfigurationClass().getMetadata(),  
            deferredImport.getImportSelector());  
   }  
   // 获取分组的导入配置
   return this.group.selectImports();  
}

2.1.2 ImportBeanDefinitionRegistrar

对于ImportBeanDefinitionRegistrar，它会调用实现类的ImportBeanDefinitionRegistrar#registerBeanDefinitions()方法进行注册：

default void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {  
}

2.2 AutoConfigurationImportSelector

2.2.1 执行导入规则

在导入配置时，会先执行导入规则，从META-INF/spring.factories和META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports中读取需要注册的类。

具体入口位于AutoConfigurationImportSelector.AutoConfigurationGroup#process()方法：

public void process(AnnotationMetadata annotationMetadata, DeferredImportSelector deferredImportSelector) {  
   // 获取目录文件中的类
   AutoConfigurationEntry autoConfigurationEntry = ((AutoConfigurationImportSelector) deferredImportSelector)  
         .getAutoConfigurationEntry(annotationMetadata);  
   // 添加到缓存
   this.autoConfigurationEntries.add(autoConfigurationEntry);  
   for (String importClassName : autoConfigurationEntry.getConfigurations()) {  
      this.entries.putIfAbsent(importClassName, annotationMetadata);  
   }  
}

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);  
}

核心代码位于AutoConfigurationImportSelector#getCandidateConfigurations()方法，会使用SPI机制从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中键为org.springframework.boot.autoconfigure.EnableAutoConfiguration的类
   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);   
   return configurations;  
}

对于SpringFactoriesLoader#loadFactoryNames()，它会读取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();  
   return loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());  
}

对于ImportCandidates#load()，它会读取META-INF/spring/%s.imports中的所有值：

public static ImportCandidates load(Class<?> annotation, ClassLoader classLoader) {  
   Assert.notNull(annotation, "'annotation' must not be null");  
   ClassLoader classLoaderToUse = decideClassloader(classLoader);  
   String location = String.format(LOCATION, annotation.getName());  
   Enumeration<URL> urls = findUrlsInClasspath(classLoaderToUse, location);  
   List<String> importCandidates = new ArrayList<>();  
   while (urls.hasMoreElements()) {  
      URL url = urls.nextElement();  
      importCandidates.addAll(readCandidateConfigurations(url));  
   }  
   return new ImportCandidates(importCandidates);  
}

2.2.2 获取自动导入配置

通过AutoConfigurationImportSelector.AutoConfigurationGroup#selectImports()方法，可以获取处理后的自动导入配置：

public Iterable<Entry> selectImports() {  
   if (this.autoConfigurationEntries.isEmpty()) {  
      return Collections.emptyList();  
   }  
   // 过滤
   Set<String> allExclusions = this.autoConfigurationEntries.stream()  
         .map(AutoConfigurationEntry::getExclusions).flatMap(Collection::stream).collect(Collectors.toSet());  
   Set<String> processedConfigurations = this.autoConfigurationEntries.stream()  
         .map(AutoConfigurationEntry::getConfigurations).flatMap(Collection::stream)  
         .collect(Collectors.toCollection(LinkedHashSet::new));  
   processedConfigurations.removeAll(allExclusions);  
  
   // 排序并返回
   return sortAutoConfigurations(processedConfigurations, getAutoConfigurationMetadata()).stream()  
         .map((importClassName) -> new Entry(this.entries.get(importClassName), importClassName))  
         .collect(Collectors.toList());  
}

2.3 AutoConfigurationPackages.Registrar

AutoConfigurationPackages.Registrar是ImportBeanDefinitionRegistrar实现类，所以会通过AutoConfigurationPackages.Registrar#registerBeanDefinitions()方法注册：

public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {  
   register(registry, new PackageImports(metadata).getPackageNames().toArray(new String[0]));  
}

它会调用AutoConfigurationPackages#register()方法扫描指定包路径：

public static void register(BeanDefinitionRegistry registry, String... packageNames) {  
   if (registry.containsBeanDefinition(BEAN)) {  
      BasePackagesBeanDefinition beanDefinition = (BasePackagesBeanDefinition) registry.getBeanDefinition(BEAN);  
      beanDefinition.addBasePackages(packageNames);  
   }  
   else {  
      registry.registerBeanDefinition(BEAN, new BasePackagesBeanDefinition(packageNames));  
   }  
}

PackageImports会从@AutoConfigurationPackage的属性中获取包路径，如果没有指定注解属性，则会获取标注该注解的类所在的包路径：

PackageImports(AnnotationMetadata metadata) {  
   // 获取注解属性
   AnnotationAttributes attributes = AnnotationAttributes  
         .fromMap(metadata.getAnnotationAttributes(AutoConfigurationPackage.class.getName(), false));  
   // 获取注解中的包路径
   List<String> packageNames = new ArrayList<>(Arrays.asList(attributes.getStringArray("basePackages")));  
   for (Class<?> basePackageClass : attributes.getClassArray("basePackageClasses")) {  
      packageNames.add(basePackageClass.getPackage().getName());  
   }  
   // 没有指定包路径，获取标注类的包路径
   if (packageNames.isEmpty()) {  
      packageNames.add(ClassUtils.getPackageName(metadata.getClassName()));  
   }  
   this.packageNames = Collections.unmodifiableList(packageNames);  
}

3 总结

自动配置SPI功能是Spring Boot引入第三方组件的基础，也是它如此便利的根本原因。

在学习第三方组件时，可以首先看它的META-INF/spring.factories和META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件，这是它们的入口。

在创建自己的starter，也可以使用这个机制，既遵守官方标准，又方便使用。

自动配置基于SPI机制，是SPI的灵活应用（类似的还有JDBC的DriverManager）。我们在日常项目中也可以参照它实现逻辑，进行设计和开发。

posted @ 2023-02-09 14:52 Xianuii 阅读(1630) 评论(1) 编辑收藏举报

会员力量，点亮园子希望

刷新页面返回顶部

Loading

Xianhuii

最通俗易懂的技术文章！