SpringBoot的系统初始化器分析

文章依据自己的阅读以及慕课网跳跳虎老师讲解的相关内容整理，如有错误，望指正；

SpringBoot可以有三种方式定义初始化器，来为容器中增加自定义的对象，具体如下：

1、定义在spring.factories文件中，被SpringFactoriesLoader发现注册；

在resources下建立META-INF文件夹，新建spring.factories文件，添加自定义的初始化器：
org.springframework.context.ApplicationContextInitializer=com.mooc.sb2.initializer.InitializerOne

2、SpringApplication初始化完成后手动添加；

SpringApplication springApplication = new SpringApplication(SbApplication.class);
springApplication.addInitializers(new InitializerTwo());
springApplication.run(args)

3、定义成环境变量，被DelegatingApplicationContextInitializer所发现注册（优先级最高）

application.properties中增加一项配置：
context.initializer.classes=com.mooc.sb2.initializer.ThirdInitializer

下面从代码的角度，来看下这三种方式是如何加载的

对于第一种方法，可以跟进

SpringApplication.run(SpringBootApplication.class, args);

public static ConfigurableApplicationContext run(Class<?> primarySource, String... args) {
	return run(new Class<?>[] { primarySource }, args);
}

继续进入这个run方法：

public static ConfigurableApplicationContext run(Class<?>[] primarySources, String[] args) {
	return new SpringApplication(primarySources).run(args);
}

还有一个run方法，我们继续进入：

这个run方法代码比较长，这里我们关注的是这部分：

exceptionReporters = getSpringFactoriesInstances(SpringBootExceptionReporter.class,
					new Class[] { ConfigurableApplicationContext.class }, context);

我们进入这个getSpringFactoriesInstances方法，如下：

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

我们先看这个loadFactoryNames方法，它调用了loadSpringFactories方法来获取固定位置的配置信息：

loadSpringFactories的重点部分代码如下：

        try {
			Enumeration<URL> urls = (classLoader != null ?
					classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
					ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
			result = new LinkedMultiValueMap<>();
			while (urls.hasMoreElements()) {
				URL url = urls.nextElement();
				UrlResource resource = new UrlResource(url);
				Properties properties = PropertiesLoaderUtils.loadProperties(resource);
				for (Map.Entry<?, ?> entry : properties.entrySet()) {
					String factoryTypeName = ((String) entry.getKey()).trim();
					for (String factoryImplementationName : StringUtils.commaDelimitedListToStringArray((String) entry.getValue())) {
						result.add(factoryTypeName, factoryImplementationName.trim());
					}
				}
			}
			cache.put(classLoader, result);
			return result;
		}

我们可以发现一个常量的定义：FACTORIES_RESOURCE_LOCATION，而它的值，就是

"META-INF/spring.factories"

这里就解释了我们为什么要自己建一个配置文件在固定的目录下，这样springboot就成功读取到了自定义的初始化器，加载到了cache中；下面我们回到SpringApplication.java中，继续跟进getSpringFactoriesInstances方法。

在获取到了初始化器的全限定名后，我们继续看createSpringFactoriesInstances方法：

	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);会将实例按照@Order的注解顺序进行排序，在这里不进行详述；

第二种初始化器是通过手动添加

第三种是通过DelegatingApplicationContextInitializer的initialize方法来调用的，首先，我们先看这个方法的代码：

	@Override
	public void initialize(ConfigurableApplicationContext context) {
		ConfigurableEnvironment environment = context.getEnvironment();
		List<Class<?>> initializerClasses = getInitializerClasses(environment);
		if (!initializerClasses.isEmpty()) {
			applyInitializerClasses(context, initializerClasses);
		}
	}

其中，我们重点关注getInitializerClasses()方法

	private List<Class<?>> getInitializerClasses(ConfigurableEnvironment env) {
		String classNames = env.getProperty(PROPERTY_NAME);
		List<Class<?>> classes = new ArrayList<>();
		if (StringUtils.hasLength(classNames)) {
			for (String className : StringUtils.tokenizeToStringArray(classNames, ",")) {
				classes.add(getInitializerClass(className));
			}
		}
		return classes;
	}

这里的常量：

PROPERTY_NAME= "context.initializer.classes";

也就是我们配置文件的key，value值会被以‘，’为分界线进行分割，来获得每个所需的系统初始化器的全限定名，并通过BeanUtis工具来进行初始化；

另：为什么DelegatingApplicationContextInitializer加载的初始化器是优先于其他方式执行呢？这是因为SpringApplication的run方法中的prepareContext方法会调用applyInitializers方法，applyInitializers方法的for循环会调用getInitializers方法来加载所有的初始化器，而DelegatingApplicationContextInitializer的Order=0，因此优先级最高，会被最先加载；

，

lhf2112

发布了32 篇原创文章 · 获赞 1 · 访问量 2万+

私信关注

SpringBoot的系统初始化器分析

猜你喜欢