SpringBoot?spring.factories加載時機分析

更新時間：2023年03月13日 15:30:06 作者：石臻臻的雜貨鋪

這篇文章主要為大家介紹了SpringBoot?spring.factories加載時機分析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

spring.factories作用

這個類似于Java中的SPI功能,SpringBoot啟動的時候會讀取所有jar包下面的META-INF/spring.factories文件;

并且將文件中的接口/抽象類對應的實現(xiàn)類都對應起來,并在需要的時候可以實例化對應的實現(xiàn)類

下面我們來分析一下源碼看看spring.factories的使用場景

源碼解析

啟動SpringApplication,看看構(gòu)造方法

	public SpringApplication(ResourceLoader resourceLoader, Class<?>... primarySources) {
		this.resourceLoader = resourceLoader;
		Assert.notNull(primarySources, "PrimarySources must not be null");
		this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));
		this.webApplicationType = WebApplicationType.deduceFromClasspath();
		setInitializers((Collection) getSpringFactoriesInstances(
				ApplicationContextInitializer.class));
		setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
		this.mainApplicationClass = deduceMainApplicationClass();
	}

其中方法getSpringFactoriesInstances( ApplicationContextInitializer.class) 是用于獲取Spring中指定類實例用的;并且獲取的時候是根據(jù)讀取整個項目中文件路徑為META-INF/spring.factories 中的內(nèi)容實例化對應的實例類的;

例如這里的ApplicationContextInitializer 是一個接口,那么應該實例化哪些他的實現(xiàn)類呢？那就找META-INF/spring.factories文件 ; 那么我們在spring-boot:2.1.0jar包中找到了這個文件

讀取到需要實例化的實現(xiàn)類為

org.springframework.boot.context.ConfigurationWarningsApplicationContextInitializer,\
org.springframework.boot.context.ContextIdApplicationContextInitializer,\
org.springframework.boot.context.config.DelegatingApplicationContextInitializer,\
org.springframework.boot.web.context.ServerPortInfoApplicationContextInitializer

并且還在spring-boot-autoconfigure-2.1.0.RELEASE.jar中找到了這個文件

那么文件中的兩個實現(xiàn)類也會被實例化;加上上面4個總共有6個

org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,\
org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener

可以看到不僅僅只是把org.springframework.context.ApplicationContextInitializer 的實例類解析了出來;而是所有的都解析了出來并且保存下來了.下次其他的類需要被實例化的時候就可以直接從內(nèi)存里面拿了;

上面過程拿到了實例類之后,接下來就是實例化的過程了

	private <T> Collection<T> getSpringFactoriesInstances(Class<T> type,
			Class<?>[] parameterTypes, Object... args) {
		ClassLoader classLoader = getClassLoader();
		// Use names and ensure unique to protect against duplicates
		Set<String> names = new LinkedHashSet<>(
				SpringFactoriesLoader.loadFactoryNames(type, classLoader));
		List<T> instances = createSpringFactoriesInstances(type, parameterTypes,
				classLoader, args, names);
		AnnotationAwareOrderComparator.sort(instances);
		return instances;
	}

方法createSpringFactoriesInstances就是創(chuàng)建實例的過程;可以看到傳入了對應的接口類org.springframework.context.ApplicationContextInitializer ;接下來就會實例化上面找到了對應的實現(xiàn)類;

	private <T> List<T> createSpringFactoriesInstances(Class<T> type,
			Class<?>[] parameterTypes, ClassLoader classLoader, Object[] args,
			Set<String> names) {
		List<T> instances = new ArrayList<>(names.size());
		for (String name : names) {
			try {
				Class<?> instanceClass = ClassUtils.forName(name, classLoader);
				Assert.isAssignable(type, instanceClass);
				Constructor<?> constructor = instanceClass
						.getDeclaredConstructor(parameterTypes);
				T instance = (T) BeanUtils.instantiateClass(constructor, args);
				instances.add(instance);
			}
			catch (Throwable ex) {
				throw new IllegalArgumentException(
						"Cannot instantiate " + type + " : " + name, ex);
			}
		}
		return instances;
	}

實例化的過程如果,沒有什么特別需要講解的;

上面有個方法 AnnotationAwareOrderComparator.sort(instances);是用來排序所有實例的; 實現(xiàn)類需要實現(xiàn) 接口Ordered ; getOrder返回的值越小,優(yōu)先級更高