ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

Spring EnableAutoConfigurationImportSelector 详解

2019-02-27 11:53:35  阅读:447  来源: 互联网

标签:候选 Spring 配置 annotationMetadata 详解 autoConfigurationMetadata 过滤器 EnableAutoConfi


EnableAutoConfigurationImportSelector ,从 spring boot 1.5 以后,EnableAutoConfigurationImportSelector已经不再被建议使用,而是推荐使用 AutoConfigurationImportSelector。

源头:
@SpringBootApplication
—> @EnableAutoConfiguration
—> @Import(EnableAutoConfigurationImportSelector.class)

什么时候被执行的呢?

Springboot应用启动过程中使用ConfigurationClassParser分析配置类时,如果发现注解中存在@Import(ImportSelector)的情况,就会创建一个相应的ImportSelector对象, 并调用其方法 public String[] selectImports(AnnotationMetadata annotationMetadata)。

下面看看 EnableAutoConfigurationImportSelector的 selectImports 方法:

	// selectImports 的具体执行逻辑
	@Override
	public String[] selectImports(AnnotationMetadata annotationMetadata) {
		if (!isEnabled(annotationMetadata)) {
			return NO_IMPORTS;
		}
		try {
			// 从配置文件中加载 AutoConfigurationMetadata
			AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
					.loadMetadata(this.beanClassLoader);
			AnnotationAttributes attributes = getAttributes(annotationMetadata);
			// 获取所有候选配置类EnableAutoConfiguration
			// 使用了内部工具使用SpringFactoriesLoader,查找classpath上所有jar包中的
			// META-INF\spring.factories,找出其中key为
			// org.springframework.boot.autoconfigure.EnableAutoConfiguration 
			// 的属性定义的工厂类名称。
			// 虽然参数有annotationMetadata,attributes,但在 AutoConfigurationImportSelector 的
			// 实现 getCandidateConfigurations()中,这两个参数并未使用
			List<String> configurations = getCandidateConfigurations(annotationMetadata,
					attributes);
			// 去重					
			configurations = removeDuplicates(configurations);
			
			// 排序 : 先按字典序,再按order属性,再考虑注解  @AutoConfigureBefore @AutoConfigureAfter
			configurations = sort(configurations, autoConfigurationMetadata);

			// 应用 exclusion 属性
			Set<String> exclusions = getExclusions(annotationMetadata, attributes);
			checkExcludedClasses(configurations, exclusions);
			configurations.removeAll(exclusions);
			// 应用过滤器AutoConfigurationImportFilter,
			// 对于 spring boot autoconfigure,定义了一个需要被应用的过滤器 :
			// org.springframework.boot.autoconfigure.condition.OnClassCondition,
			// 此过滤器检查候选配置类上的注解@ConditionalOnClass,如果要求的类在classpath
			// 中不存在,则这个候选配置类会被排除掉
			configurations = filter(configurations, autoConfigurationMetadata);
			// 现在已经找到所有需要被应用的候选配置类
			// 广播事件 AutoConfigurationImportEvent
			fireAutoConfigurationImportEvents(configurations, exclusions);
			return configurations.toArray(new String[configurations.size()]);
		}
		catch (IOException ex) {
			throw new IllegalStateException(ex);
		}
	}


	/**
	  * 根据autoConfigurationMetadata信息对候选配置类configurations进行过滤
	  **/
	private List<String> filter(List<String> configurations,
			AutoConfigurationMetadata autoConfigurationMetadata) {
		long startTime = System.nanoTime();
		String[] candidates = configurations.toArray(new String[configurations.size()]);
		// 记录候选配置类是否需要被排除,skip为true表示需要被排除,全部初始化为false,不需要被排除
		boolean[] skip = new boolean[candidates.length];
		// 记录候选配置类中是否有任何一个候选配置类被忽略,初始化为false
		boolean skipped = false;
		// 获取AutoConfigurationImportFilter并逐个应用过滤
		for (AutoConfigurationImportFilter filter : getAutoConfigurationImportFilters()) {
			// 对过滤器注入其需要Aware的信息
			invokeAwareMethods(filter);
			// 使用此过滤器检查候选配置类跟autoConfigurationMetadata的匹配情况
			boolean[] match = filter.match(candidates, autoConfigurationMetadata);
			for (int i = 0; i < match.length; i++) {
				if (!match[i]) {
				// 如果有某个候选配置类不符合当前过滤器,将其标记为需要被排除,
				// 并且将 skipped设置为true,表示发现了某个候选配置类需要被排除
					skip[i] = true;
					skipped = true;
				}
			}
		}
		if (!skipped) {
		// 如果所有的候选配置类都不需要被排除,则直接返回外部参数提供的候选配置类集合
			return configurations;
		}
		// 逻辑走到这里因为skipped为true,表明上面的的过滤器应用逻辑中发现了某些候选配置类
		// 需要被排除,这里排除那些需要被排除的候选配置类,将那些不需要被排除的候选配置类组成
		// 一个新的集合返回给调用者
		List<String> result = new ArrayList<String>(candidates.length);
		for (int i = 0; i < candidates.length; i++) {
			if (!skip[i]) {
				result.add(candidates[i]);
			}
		}
		if (logger.isTraceEnabled()) {
			int numberFiltered = configurations.size() - result.size();
			logger.trace("Filtered " + numberFiltered + " auto configuration class in "
					+ TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startTime)
					+ " ms");
		}
		return new ArrayList<String>(result);
	}	
	/**
	  * 使用内部工具 SpringFactoriesLoader,查找classpath上所有jar包中的
	  * META-INF\spring.factories,找出其中key为
	  * org.springframework.boot.autoconfigure.AutoConfigurationImportFilter 
	  * 的属性定义的过滤器类并实例化。
	  * AutoConfigurationImportFilter过滤器可以被注册到 spring.factories用于对自动配置类
	  * 做一些限制,在这些自动配置类的字节码被读取之前做快速排除处理。
	  * spring boot autoconfigure 缺省注册了一个 AutoConfigurationImportFilter :
	  * org.springframework.boot.autoconfigure.condition.OnClassCondition
	**/
	protected List<AutoConfigurationImportFilter> getAutoConfigurationImportFilters() {
		return SpringFactoriesLoader.loadFactories(AutoConfigurationImportFilter.class,
				this.beanClassLoader);
	}	

标签:候选,Spring,配置,annotationMetadata,详解,autoConfigurationMetadata,过滤器,EnableAutoConfi
来源: https://blog.csdn.net/m0_37039331/article/details/87969816

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有