2.SpringBoot框架启动流程之Spi机制

在 Java 应用中，类路径（Classpath） 包括：

• 编译后的 .class 文件目录（如 target/classes）。
• 所有依赖 JAR 包的根目录。

其中，前者是类ClassPathScanningCandidateComponentProvider主动扫描注解ComponentScan指定的路径，后者是类DeferredImportSelector按需加载。注解ComponentScan指定的路径通常是应用目录，当然也可以指定第三方jar包下的目录。

DeferredImportSelector加载的类主要包括：

• @Import 注解导入的外部类。当然包括应用中显式导入、第三方jar包中显式导入的候选类。
• 定义文件：org.springframework.boot.autoconfigure.AutoConfiguration.imports，并且该文件位于路径META-INF/spring/...之下。当然包括应用路径src/main/resources/META-INF/spring下指定、第三方jar中指定。

当前文章分析的核心是：解析启动类@Import时获取得到的 AutoConfigurationImportSelector。

DeferredImportSelector：A variation of {@link ImportSelector} that runs after all {@code @Configuration} beans have been processed. This type of selector can be particularly useful when the selected imports are {@code @Conditional}。

1、DeferredImportSelectorHandler

private class DeferredImportSelectorHandler {

	@Nullable
	private List<DeferredImportSelectorHolder> deferredImportSelectors = new ArrayList<>();

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

	public void process() {
		List<DeferredImportSelectorHolder> deferredImports = this.deferredImportSelectors;
		this.deferredImportSelectors = null;
		try {
			if (deferredImports != null) {
				DeferredImportSelectorGroupingHandler handler = new DeferredImportSelectorGroupingHandler();
				deferredImports.sort(DEFERRED_IMPORT_COMPARATOR);
				deferredImports.forEach(handler::register);
				handler.processGroupImports();
			}
		}
		finally {
			this.deferredImportSelectors = new ArrayList<>();
		}
	}
}

deferredImportSelectors集合中元素： 是解析启动类的@Import获取到ImportSelector类型的AutoConfigurationImportSelector时通过DeferredImportSelectorHandler#handle方法得到的。

2、DeferredImportSelectorGroupingHandler 

private class DeferredImportSelectorGroupingHandler {

	private final Map<Object, DeferredImportSelectorGrouping> groupings = new LinkedHashMap<>();

	private final Map<AnnotationMetadata, ConfigurationClass> configurationClasses = new HashMap<>();

	public void register(DeferredImportSelectorHolder deferredImport) {
		Class<? extends Group> group = deferredImport.getImportSelector().getImportGroup();
		DeferredImportSelectorGrouping grouping = this.groupings.computeIfAbsent(
				(group != null ? group : deferredImport),
				key -> new DeferredImportSelectorGrouping(createGroup(group)));
		grouping.add(deferredImport);
		this.configurationClasses.put(deferredImport.getConfigurationClass().getMetadata(),
				deferredImport.getConfigurationClass());
	}

	public void processGroupImports() {
		for (DeferredImportSelectorGrouping grouping : this.groupings.values()) {
			Predicate<String> exclusionFilter = grouping.getCandidateFilter();
			grouping.getImports().forEach(entry -> {
				ConfigurationClass configurationClass = this.configurationClasses.get(entry.getMetadata());
				processImports(configurationClass, asSourceClass(configurationClass, exclusionFilter),
							Collections.singleton(asSourceClass(entry.getImportClassName(), exclusionFilter)),
							exclusionFilter, false);
			});
		}
	}

	private Group createGroup(@Nullable Class<? extends Group> type) {
		Class<? extends Group> effectiveType = (type != null ? type : DefaultDeferredImportSelectorGroup.class);
		return ParserStrategyUtils.instantiateClass(effectiveType, Group.class,
				ConfigurationClassParser.this.environment,
				ConfigurationClassParser.this.resourceLoader,
				ConfigurationClassParser.this.registry);
	}
}

grouping.getImports():获取自动装配的类。
entry：遍历每个自动装配的类

3、DeferredImportSelectorGrouping

private static class DeferredImportSelectorGrouping {

	private final DeferredImportSelector.Group group;

	private final List<DeferredImportSelectorHolder> deferredImports = new ArrayList<>();

	DeferredImportSelectorGrouping(Group group) {
		this.group = group;
	}

	public void add(DeferredImportSelectorHolder deferredImport) {
		this.deferredImports.add(deferredImport);
	}
	
	public Iterable<Group.Entry> getImports() {
		for (DeferredImportSelectorHolder deferredImport : this.deferredImports) {
			this.group.process(deferredImport.getConfigurationClass().getMetadata(),
					deferredImport.getImportSelector());
		}
		return this.group.selectImports();
	}

	public Predicate<String> getCandidateFilter() {
		Predicate<String> mergedFilter = DEFAULT_EXCLUSION_FILTER;
		for (DeferredImportSelectorHolder deferredImport : this.deferredImports) {
			Predicate<String> selectorFilter = deferredImport.getImportSelector().getExclusionFilter();
			if (selectorFilter != null) {
				mergedFilter = mergedFilter.or(selectorFilter);
			}
		}
		return mergedFilter;
	}
}

group.process：调用AutoConfigurationImportSelector的静态内部类AutoConfigurationGroup的方法AutoConfigurationGroup#process获取Spring.factories中涉及的类信息。

this.group.selectImports()：对候选的自动装配类进行排序。首先按照全限定性名，其次再根据@AutoConfigureOrder、最后@AutoConfigureBefore @AutoConfigureAfter依次控制集合中候选类的顺序。

4、AutoConfigurationImportSelector

public class AutoConfigurationImportSelector implements DeferredImportSelector{
	
	protected AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata,AnnotationMetadata annotationMetadata) {
		AnnotationAttributes attributes = getAttributes(annotationMetadata);

		// 通过spi机制加载spring.factories文件下的目标类
		List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);//#1
		configurations = removeDuplicates(configurations);
		Set<String> exclusions = getExclusions(annotationMetadata, attributes);
		checkExcludedClasses(configurations, exclusions);
		configurations.removeAll(exclusions);

		configurations = filter(configurations, autoConfigurationMetadata);
		fireAutoConfigurationImportEvents(configurations, exclusions);
		return new AutoConfigurationEntry(configurations, exclusions);
	}

	...

	private static class AutoConfigurationGroup implements DeferredImportSelector.Group{

		@Override
		public void process(AnnotationMetadata annotationMetadata, DeferredImportSelector deferredImportSelector) {

			AutoConfigurationEntry autoConfigurationEntry = ((AutoConfigurationImportSelector) deferredImportSelector)
					.getAutoConfigurationEntry(getAutoConfigurationMetadata(), annotationMetadata);

			this.autoConfigurationEntries.add(autoConfigurationEntry);

			for (String importClassName : autoConfigurationEntry.getConfigurations()) {
				this.entries.putIfAbsent(importClassName, annotationMetadata);
			}
		}

		@Override
		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);
			// 对自动装配的候选类排序处理：根据order字段属性排序、根据注解@AutoConfigureAfter、@AutoConfigureBefore
			return sortAutoConfigurations(processedConfigurations, getAutoConfigurationMetadata()).stream()
					.map((importClassName) -> new Entry(this.entries.get(importClassName), importClassName))
					.collect(Collectors.toList());
		}

		private List<String> sortAutoConfigurations(Set<String> configurations,
				AutoConfigurationMetadata autoConfigurationMetadata) {
			return new AutoConfigurationSorter(getMetadataReaderFactory(), autoConfigurationMetadata)
                    //首先根据字母排序、其次根据Order排序、最后根据注解@AutoConfigureAfter、@AutoConfigureBefore 重新对候选类排序，改变其在集合中的顺序，从而影响候选类实例化顺序
					.getInPriorityOrder(configurations);
		}

	}
}

步骤1：通过spi机制加载spring.factories文件下的目标类。

步骤2：在spring.factories文件中获取 AutoConfigurationImportFilter类型的过滤类。如下所示：

org.springframework.boot.autoconfigure.AutoConfigurationImportFilter=\
org.springframework.boot.autoconfigure.condition.OnBeanCondition,\
org.springframework.boot.autoconfigure.condition.OnClassCondition,\
org.springframework.boot.autoconfigure.condition.OnWebApplicationCondition

步骤3：遍历所有候选类。利用AutoConfigurationImportFilter三种不同类型判断候选类是否满足当前条件。

5.spring.factories的历史

Spring Boot 2.4+版本之后spring.factories已经被.imports 文件取代：