栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Springboot自动装配的实现原理

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

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 deferredimports = new ArrayList<>();

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

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

		public void add(DeferredimportSelectorHolder deferredimport) {
			this.deferredimports.add(deferredimport);
		}

		
		public Iterable getimports() {
			for (DeferredimportSelectorHolder deferredimport : this.deferredimports) {
			    // 关键方法,就是在process方法中进行配置类的扫描和加载
				this.group.process(deferredimport.getConfigurationClass().getmetadata(),
						deferredimport.getimportSelector());
			}
			return this.group.selectimports();
		}

		public Predicate getCandidateFilter() {
			Predicate mergedFilter = DEFAULT_EXCLUSION_FILTER;
			for (DeferredimportSelectorHolder deferredimport : this.deferredimports) {
				Predicate 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 configurations = getCandidateConfigurations(annotationmetadata, attributes);
		// 删除重复的配置类
		configurations = removeDuplicates(configurations);
		// Set去重
		Set 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 getCandidateConfigurations(Annotationmetadata metadata, AnnotationAttributes attributes) {
	    // 加载自动配置类的路径
		List 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 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还需要做另外的处理。

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/781242.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号