Spring Boot 2.x 启动全过程源码分析(上)入口类剖析
转载自 Spring Boot 2.x 启动全过程源码分析(上)入口类剖析
Spring Boot 的应用教程我们已经分享过很多了,今天来通过源码来分析下它的启动过程,探究下 Spring Boot 为什么这么简便的奥秘。
本篇基于 Spring Boot 2.0.3 版本进行分析,阅读本文需要有一些 Java 和 Spring 框架基础,如果还不知道 Spring Boot 是什么,建议先看下我们的 Spring Boot 教程。
Spring Boot 的入口类
@SpringBootApplication
public class SpringBootBestPracticeApplication {public static void main(String[] args) {SpringApplication.run(SpringBootBestPracticeApplication.class, args);}
}
做过 Spring Boot 项目的都知道,上面是 Spring Boot 最简单通用的入口类。入口类的要求是最顶层包下面第一个含有 main 方法的类,使用注解 @SpringBootApplication
来启用 Spring Boot 特性,使用 SpringApplication.run
方法来启动 Spring Boot 项目。
来看一下这个类的 run
方法调用关系源码:
public static ConfigurableApplicationContext run(Class<?> primarySource,String... args) {return run(new Class<?>[] { primarySource }, args);
}public static ConfigurableApplicationContext run(Class<?>[] primarySources,String[] args) {return new SpringApplication(primarySources).run(args);
}
第一个参数 primarySource
:加载的主要资源类
第二个参数 args
:传递给应用的应用参数
先用主要资源类来实例化一个 SpringApplication
对象,再调用这个对象的 run
方法,所以我们分两步来分析这个启动源码。
SpringApplication 的实例化过程
接着上面的 SpringApplication
构造方法进入以下源码:
public SpringApplication(Class<?>... primarySources) {this(null, primarySources);
}public SpringApplication(ResourceLoader resourceLoader, Class<?>... primarySources) {// 1、资源初始化资源加载器为 nullthis.resourceLoader = resourceLoader;// 2、断言主要加载资源类不能为 null,否则报错Assert.notNull(primarySources, "PrimarySources must not be null");// 3、初始化主要加载资源类集合并去重this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));// 4、推断当前 WEB 应用类型this.webApplicationType = deduceWebApplicationType();// 5、设置应用上线文初始化器setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class)); // 6、设置监听器 setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));// 7、推断主入口应用类this.mainApplicationClass = deduceMainApplicationClass();}
可知这个构造器类的初始化包括以下 7 个过程。
1、资源初始化资源加载器为 null
this.resourceLoader = resourceLoader;
2、断言主要加载资源类不能为 null,否则报错
Assert.notNull(primarySources, "PrimarySources must not be null");
3、初始化主要加载资源类集合并去重
this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));
4、推断当前 WEB 应用类型
this.webApplicationType = deduceWebApplicationType();
来看下 deduceWebApplicationType
方法和相关的源码:
private WebApplicationType deduceWebApplicationType() {if (ClassUtils.isPresent(REACTIVE_WEB_ENVIRONMENT_CLASS, null)&& !ClassUtils.isPresent(MVC_WEB_ENVIRONMENT_CLASS, null)) {return WebApplicationType.REACTIVE;}for (String className : WEB_ENVIRONMENT_CLASSES) {if (!ClassUtils.isPresent(className, null)) {return WebApplicationType.NONE;}}return WebApplicationType.SERVLET;
}private static final String REACTIVE_WEB_ENVIRONMENT_CLASS = "org.springframework."+ "web.reactive.DispatcherHandler";private static final String MVC_WEB_ENVIRONMENT_CLASS = "org.springframework."+ "web.servlet.DispatcherServlet";private static final String[] WEB_ENVIRONMENT_CLASSES = { "javax.servlet.Servlet","org.springframework.web.context.ConfigurableWebApplicationContext" }; public enum WebApplicationType {/*** 非 WEB 项目*/NONE,/*** SERVLET WEB 项目*/SERVLET,/*** 响应式 WEB 项目*/REACTIVE}
这个就是根据类路径下是否有对应项目类型的类推断出不同的应用类型。
5、设置应用上线文初始化器
setInitializers((Collection) getSpringFactoriesInstances(
ApplicationContextInitializer.class));
ApplicationContextInitializer
的作用是什么?源码如下。
public interface ApplicationContextInitializer<C extends ConfigurableApplicationContext> {/*** Initialize the given application context.* @param applicationContext the application to configure*/void initialize(C applicationContext);}
用来初始化指定的 Spring 应用上下文,如注册属性资源、激活 Profiles 等。
来看下 setInitializers
方法源码,其实就是初始化一个 ApplicationContextInitializer
应用上下文初始化器实例的集合。
public void setInitializers(Collection<? extends ApplicationContextInitializer<?>> initializers) {this.initializers = new ArrayList<>();this.initializers.addAll(initializers);}
再来看下这个初始化 getSpringFactoriesInstances
方法和相关的源码:
private <T> Collection<T> getSpringFactoriesInstances(Class<T> type) {return getSpringFactoriesInstances(type, new Class<?>[] {});
}private <T> Collection<T> getSpringFactoriesInstances(Class<T> type,Class<?>[] parameterTypes, Object... args) {ClassLoader classLoader = Thread.currentThread().getContextClassLoader();// Use names and ensure unique to protect against duplicatesSet<String> names = new LinkedHashSet<>(SpringFactoriesLoader.loadFactoryNames(type, classLoader));List<T> instances = createSpringFactoriesInstances(type, parameterTypes,classLoader, args, names);AnnotationAwareOrderComparator.sort(instances);return instances;
}
设置应用上下文初始化器可分为以下 5 个步骤。
5.1)获取当前线程上下文类加载器
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
5.2)获取 ApplicationContextInitializer
的实例名称集合并去重
Set<String> names = new LinkedHashSet<>( SpringFactoriesLoader.loadFactoryNames(type, classLoader));
loadFactoryNames
方法相关的源码如下:
public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {String factoryClassName = factoryClass.getName();return loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());}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);if (result != null) {return result;}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);}}
根据类路径下的 META-INF/spring.factories
文件解析并获取 ApplicationContextInitializer
接口的所有配置的类路径名称。
spring-boot-autoconfigure-2.0.3.RELEASE.jar!/META-INF/spring.factories
的初始化器相关配置内容如下:
# Initializers
org.springframework.context.ApplicationContextInitializer=\
org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,\
org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener
5.3)根据以上类路径创建初始化器实例列表
List<T> instances = createSpringFactoriesInstances(type, parameterTypes,classLoader, args, names);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;
}
5.4)初始化器实例列表排序
AnnotationAwareOrderComparator.sort(instances);
5.5)返回初始化器实例列表
return instances;
6、设置监听器
setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
ApplicationListener
的作用是什么?源码如下。
@FunctionalInterfacepublic interface ApplicationListener<E extends ApplicationEvent> extends EventListener {/*** Handle an application event.* @param event the event to respond to*/void onApplicationEvent(E event);}
看源码,这个接口继承了 JDK 的 java.util.EventListener
接口,实现了观察者模式,它一般用来定义感兴趣的事件类型,事件类型限定于 ApplicationEvent 的子类,这同样继承了 JDK 的 java.util.EventObject
接口。
设置监听器和设置初始化器调用的方法是一样的,只是传入的类型不一样,设置监听器的接口类型为: getSpringFactoriesInstances
,对应的 spring-boot-autoconfigure-2.0.3.RELEASE.jar!/META-INF/spring.factories
文件配置内容请见下方。
# Application Listeners
org.springframework.context.ApplicationListener=\
org.springframework.boot.autoconfigure.BackgroundPreinitializer
可以看出目前只有一个 BackgroundPreinitializer
监听器。
7、推断主入口应用类
this.mainApplicationClass = deduceMainApplicationClass();
private Class<?> deduceMainApplicationClass() {try {StackTraceElement[] stackTrace = new RuntimeException().getStackTrace();for (StackTraceElement stackTraceElement : stackTrace) {if ("main".equals(stackTraceElement.getMethodName())) {return Class.forName(stackTraceElement.getClassName());}}}catch (ClassNotFoundException ex) {// Swallow and continue}return null;
}
这个推断入口应用类的方式有点特别,通过构造一个运行时异常,再遍历异常栈中的方法名,获取方法名为 main 的栈帧,从来得到入口类的名字再返回该类。
总结
源码分析内容有点多,也很麻烦,本章暂时分析到 SpringApplication
构造方法的初始化流程,下章再继续分析其 run
方法,作者很快写完过两天就发布,扫码关注下面的公众号 "Java技术栈" 即可获取推送更新。
Spring Boot 2.x 启动全过程源码分析(上)入口类剖析相关推荐
- Spring Boot 2.x 启动全过程源码分析(全)
上篇<Spring Boot 2.x 启动全过程源码分析(一)入口类剖析>我们分析了 Spring Boot 入口类 SpringApplication 的源码,并知道了其构造原理,这篇我 ...
- Spring Boot Dubbo 应用启停源码分析
作者:张乎兴 来源:Dubbo官方博客 背景介绍 Dubbo Spring Boot 工程致力于简化 Dubbo RPC 框架在Spring Boot应用场景的开发.同时也整合了 Spring Boo ...
- 【Android 插件化】VirtualApp 源码分析 ( 启动应用源码分析 | HomePresenterImpl 启动应用方法 | VirtualCore 启动插件应用最终方法 )
文章目录 一.启动应用源码分析 1.HomeActivity 启动应用点击方法 2.HomePresenterImpl 启动应用方法 3.VirtualCore 启动插件应用最终方法 一.启动应用源码 ...
- linux显示启动logo源码分析以及修改显示logo
1.linux显示启动logo整个流程分析 (1)logo图片在内核源码中是以ppm格式的文件保存,在编译内核时会把ppm格式的文件自动转换成.c文件,在c文件中会构造一个struct linux_l ...
- storm启动supervisor源码分析-supervisor.clj
storm启动supervisor源码分析-supervisor.clj supervisor是storm集群重要组成部分,supervisor主要负责管理各个"工作节点".sup ...
- storm启动nimbus源码分析-nimbus.clj
storm启动nimbus源码分析-nimbus.clj nimbus是storm集群的"控制器",是storm集群的重要组成部分.我们可以通用执行bin/storm nimbus ...
- 3supervisor启动worker源码分析-worker.clj
supervisor启动worker源码分析-worker.clj supervisor通过调用sync-processes函数来启动worker,关于sync-processes函数的详细分析请参见 ...
- supervisor启动worker源码分析-worker.clj
supervisor通过调用sync-processes函数来启动worker,关于sync-processes函数的详细分析请参见"storm启动supervisor源码分析-superv ...
- Linux驱动修炼之道-SPI驱动框架源码分析(上)
Linux驱动修炼之道-SPI驱动框架源码分析(上) SPI协议是一种同步的串行数据连接标准,由摩托罗拉公司命名,可工作于全双工模式.相关通讯设备可工作于m/s模式.主设备发起数据帧,允许多个从设 ...
最新文章
- 深入分析Java的序列化与反序列化
- Dickey-Fuller检验+迪基-福勒检验
- Swift_错误处理
- js-带操作的赋值表达式
- Linux CentOS6.7设置为固定静态IP的方法
- 组合表头_单双斜线表头——520,想单就单,想双就双
- Swift:如何判断一个对象是否是某个类(或其子类)的实例
- 非计算机专业教学改革,非计算机专业算法分析与设计教学改革论文
- Quickr for Portal相关网址
- Exp3 免杀原理与实践 20164314
- C++_弱引用 强引用_weak_ptr/share_ptr
- iOS开发日记29-UIAlertController
- maven:Java heap space内存不足错误的解决方法
- html grid插件,grid.html
- 手机里多个PDF合并成一个PDF的免费方法
- python输入逗号分隔_Python实现按逗号分隔列表的方法
- 生物医学文献知识图创建的关系提取
- vs行尾不一致,是否将行尾标准化的问题
- Keras中predict()方法和predict_classes()方法和evaluate()方法
- 监控系统zabbix相关
热门文章
- Java银行开户,取钱,存钱,查询余额,退出。。。。。
- 组件库实战 | 教你如何设计Web世界中的表单验证
- [设计模式]代理模式
- 用java做一个模拟彩票程序_JAVA模拟----- 彩票机子-----抽奖过程的实例化
- elasticSearch -- (文档,类型,索引)
- IP地址与MAC地址的区别
- Codeforces Round #732 (Div. 2) C. AquaMoon and Strange Sort 思维
- Manthan, Codefest 19 (open for everyone, rated, Div. 1 + Div. 2) F. Bits And Pieces sosdp预处理超集
- 2019 秦皇岛 I - Invoker Gym - 102361I dp
- 【九省联考2018】秘密袭击【树形dp】【生成函数】【线段树合并】【多项式插值】