spring boot 源码分析(一) 配置文件加载

一、前言

之前写过几篇关于spring boot 的使用相关的文章。我们用一项技术，不能只停留到表面，要深究其源码是如何实现，这样我们才能在关键时刻游刃有余。所以从本章开始，将会写一些关于springboot springcloud的源码解读文章，希望对大家有所帮助。

二、从一个简单的启动主类，开始分析

//启动主类两要素

//1.@springBootApplication 注解。

//2.SpringAppication.run(主类名称,参数);

@SpringBootApplication
public class StudyApplication {
    @Bean
    @LoadBalanced
    RestTemplate restTemplate(){
        return new RestTemplate();
    }
    public static void main(String[] args) {
        SpringApplication.run(StudyApplication.class, args);
    }

}

首先从 SpringApplication.run方法，入手。

    //使用默认配置运行应用,
    //primarySource : 启动的主类
    //args:用户自定义的参数
	public static ConfigurableApplicationContext run(Class<?> primarySource,
			String... args) {
		return run(new Class<?>[] { primarySource }, args);
	}

    //使用默认的和用户指定的配置进行加载应用
    //primarySource : 启动的主类
    //args:用户自定义的参数
	public static ConfigurableApplicationContext run(Class<?>[] primarySources,
			String[] args) {
		return new SpringApplication(primarySources).run(args);
	}

    //从指定的主要的来源进行创建SpringApplication实例
	public SpringApplication(Class<?>... primarySources) {
		this(null, primarySources);
	}

//另一个构造，与上面构造方法类似
//primarySource : 启动的主类
//resourceLoader:用到的resourceLoader，此时我们这个应用 默认是null
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 = deduceWebApplicationType();//web应用类型
		setInitializers((Collection) getSpringFactoriesInstances(
				ApplicationContextInitializer.class));//往applicationContext配置一些配置项
		setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));//设置应用程序监听器
		this.mainApplicationClass = deduceMainApplicationClass();
	}

下面我们看一下getSpringFactoriesInstances(ApplicationContextInitializer.class) 这个方法

private <T> Collection<T> getSpringFactoriesInstances(Class<T> type) {
		return getSpringFactoriesInstances(type, new Class<?>[] {});
}

这个方法没什么特殊，他内部调用了一下重载的其他的getSpringFactoriesInstances方法，我们继续深入研究

private <T> Collection<T> getSpringFactoriesInstances(Class<T> type,
			Class<?>[] parameterTypes, Object... args) {
		ClassLoader classLoader = Thread.currentThread().getContextClassLoader();//获取当前ClassLoader
		// 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;
}

我们可以从上面代码看出，这个方法主要是用来创建并获取实例用的，那么他是怎么获取实例的呢，实例名称从哪里来，肯定有个配置的地方吧。看看SpringFactoriesLoader.loadFactoryNames，从方法名可以看出，他是进行获取工厂名称的，我们继续深挖，看看他是如何实现的

//用指定的classLoader加载 "META-INF/spring.factories"配置，得到工厂实例类名称列表
public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {
		String factoryClassName = factoryClass.getName();
		return loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());
}

我们可以从上面代码看出，loadFactoryNames他内部又调用了一下他的重载方法，我们继续往下深挖

public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
//加载工厂实例类名列表
private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
		MultiValueMap<String, String> result = cache.get(classLoader);//MultiValueMap 是Spring自己实现的一个Map，这里用来获取cache中的工厂实例类名列表。这个MultiValueMap非常有意思，他的内部继承了extends Map<K, List<V>>
		if (result != null) {
			return result;
		}
        //这里他会加载Spring Boot 下所有的META-INF/spring.factories下的工厂实例名称。
		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()) {
					List<String> factoryClassNames = Arrays.asList(
							StringUtils.commaDelimitedListToStringArray((String) entry.getValue()));
					result.addAll((String) entry.getKey(), factoryClassNames);
				}
			}
			cache.put(classLoader, result);
			return result;
		}
		catch (IOException ex) {
			throw new IllegalArgumentException("Unable to load factories from location [" +
					FACTORIES_RESOURCE_LOCATION + "]", ex);
		}
	}

2018-05-28 23:30夜晚小结，未完待续。。

spring boot 源码分析(一) 配置文件加载

猜你喜欢