Springboot自动装配的实现原理

前言

相信使用过spring的小伙伴都有过被xml配置支配过的恐惧。每次需要导入新的bean或者第三方依赖时都需要对xml进行繁琐的配置。而在SpringBoot项目中却没有这样的烦恼，我们只需要在pom.xml中导入对应的jar包就能直接对组件进行注入。其原因是SpringBoot已经通过自动配置功能帮助我们将所需要的对象自动引入ioc了。下面我们来对Springboot的自动装配进行探究。

@SpringBootApplication

我们从主启动类开始探究，每一个Springboot应用的启动类上面都有一个@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注解内部组合了三个特别的注解。
@SpringBootConfiguration //标记该类为主启动类
@EnableAutoConfiguration //开启自动配置
@ComponentScan // 包扫描
由于篇幅关系我们直接进入有关自动配置的@EnableAutoConfiguration注解。@EnableAutoConfiguration注解内部也组合了@AutoConfigurationPackage和
@Import(AutoConfigurationImportSelector.class)注解。其中@AutoConfigurationPackage内部也是通过@Import向ioc容器注册一个BasePackages对象，这个bean有一个参数，该参数就是使用了@AutoConfigurationPackage注解的类的包路径。而@Import(AutoConfigurationImportSelector.class)毫无疑问也是向ioc中注册AutoConfigurationImportSelector类。这个类承担着扫描自动配置类的关键作用。我们先看这个类的依赖关系

AutoConfigurationImportSelector实现了各种Aware回调接口以及DeferredImportSelect接口。也就是说在这个类中可以拿到Spring容器以及一些环境信息。而在Springboot启动时会调用ConfigurationClassParser内部类DeferredImportSelectorGrouping的getImports方法。

	private static class DeferredImportSelectorGrouping {

		private final DeferredImportSelector.Group group;

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

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

		public Group getGroup() {
			return this.group;
		}

		public void add(DeferredImportSelectorHolder deferredImport) {
			this.deferredImports.add(deferredImport);
		}

		/**
		 * Return the imports defined by the group.
		 * @return each import with its associated configuration class
		 */
		public Iterable<Group.Entry> getImports() {
			for (DeferredImportSelectorHolder deferredImport : this.deferredImports) {
			    // 关键方法，就是在process方法中进行配置类的扫描和加载
				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;
		}
	}

进入刚才@Import导入的AutoConfigurationImportSelector的process方法。

		@Override
		public void process(AnnotationMetadata annotationMetadata, DeferredImportSelector deferredImportSelector) {
			Assert.state(deferredImportSelector instanceof AutoConfigurationImportSelector,
					() -> String.format("Only %s implementations are supported, got %s",
							AutoConfigurationImportSelector.class.getSimpleName(),
							deferredImportSelector.getClass().getName()));
			AutoConfigurationEntry autoConfigurationEntry = ((AutoConfigurationImportSelector) deferredImportSelector)
			        // 获取所有符合条件自动配置类的路径并封装到AutoConfigurationEntry 对象中。
					.getAutoConfigurationEntry(getAutoConfigurationMetadata(), annotationMetadata);
			this.autoConfigurationEntries.add(autoConfigurationEntry);
			for (String importClassName : autoConfigurationEntry.getConfigurations()) {
				this.entries.putIfAbsent(importClassName, annotationMetadata);
			}
		}

AutoConfigurationEntry 对象内部实际上就是维护了两个集合，一个是符合条件的自动配置类的路径以及排除了的自动配置类。在getAutoConfigurationEntry中则进行扫描以及条件过滤和去重。

	protected AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata,
			AnnotationMetadata annotationMetadata) {
		if (!isEnabled(annotationMetadata)) {
			return EMPTY_ENTRY;
		}
		AnnotationAttributes attributes = getAttributes(annotationMetadata);
		// 获取所有符合条件自动配置类的路径
		List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
		// 删除重复的配置类
		configurations = removeDuplicates(configurations);
		// Set去重
		Set<String> exclusions = getExclusions(annotationMetadata, attributes);
		checkExcludedClasses(configurations, exclusions);
		// 删除排除了的类
		configurations.removeAll(exclusions);
		// 过滤，根据自动配置类的@Condidation决定是否生效
		configurations = filter(configurations, autoConfigurationMetadata);
		fireAutoConfigurationImportEvents(configurations, exclusions);
		return new AutoConfigurationEntry(configurations, exclusions);
	}

查看getCandidateConfigurations执行结果，有125个结果。

查看过滤后的列表，只有24个结果。

接下来进入getCandidateConfigurations查看Springboot是如何获取到这些自动配置类的路径的。

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

	public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
	    // factoryTypeName 实际上就是
		String factoryTypeName = factoryType.getName();
		// 扫描导入的各个jar包中的META-INF的spring.factries文件，扫描对应的类路径
		return loadSpringFactories(classLoader).getOrDefault(factoryTypeName, Collections.emptyList());
	}

其实不仅仅是自动配置类，这个factoryTypeName 是spring.factries中的各个key。结构是这样的，比如要导入数据源的自动配置

到这里Springboot的自动配置已经扫描完毕，但实际上对这些自动配置类注册到bean还需要做另外的处理。