解密Springboot内嵌Tomcat

Springboot简介
相信大多数开发者对Springboot比较熟悉了,它能够快速地创建一个spring应用,能够完全摒弃XML的配置方式,并且内嵌了Tomcat、Jetty这样的Servlet容器,即无需再将应用打包成war部署。

在Springboot之前,部署一个应用如下


而现在,由于Springboot内嵌了Servlet容器,于是可以将应用打包成jar,直接运行一个jar包就能启动一个web服务。
Springboot是如何做到的呢?接下来进入今天的正题

Tomcat-embed
Springboot能够将Tomcat内嵌,是因为Tomcat提供了一套JavaAPI,能够通过Tomcat tomcat = new Tomcat()来创建一个Tomcat容器。
只需要引入Maven依赖

<dependency>
<groupId>org.apache.tomcat.embed</groupId>
<artifactId>tomcat-embed-core</artifactId>
<version>${tomcat.version}</version>
</dependency>

接下来我们通过Springboot源码来看看,spring是如何使用这套API与自身结合的

Springboot源码解读
首先,任意一个Springboot应用,都有一个main()函数作为应用的启动方法,里面调用了SpringApplication.run(MyApplication.class, args),我们就从这个run()开始,解密spring容器如何启动Tomcat。

这个run()的实现代码如下,这里去掉了一些与主线逻辑无关的代码

/**
* Run the Spring application, creating and refreshing a new
* {@linkApplicationContext}.
* @param args the application arguments (usually passed from a Java main method)
* @return a running {@link ApplicationContext}
*/
public ConfigurableApplicationContext run(String... args) {
ConfigurableApplicationContext context = null;
// 创建spring容器对象 ApplicationContext
context = createApplicationContext();
// 做一些初始化容器之前的预备操作
prepareContext(context, environment, listeners, applicationArguments, printedBanner);
// 启动spring容器核心方法,包括启动tomcat
refreshContext(context);
// 做一些容器启动之后的操作(当前这个方法是空的)
afterRefresh(context, applicationArguments);
return context;
}
看过Spring源码的同学应该清楚,启动spring容器的核心方法就是refresh(),而这里的方法名叫refreshContext(context),不过是springboot对refresh()的封装罢了,所以内部依然是调用的refresh(),于是我们来到这个核心方法内部

@Override
public void refresh() throws BeansException, IllegalStateException {
synchronized (this.startupShutdownMonitor) {
// 在容器启动之前做一些准备操作
prepareRefresh();

// 通知子类去刷新实例工厂
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();

// 初始化当前容器中的实例工厂
prepareBeanFactory(beanFactory);

try {

// 允许容器中的基类对实例工厂进行后置处理
postProcessBeanFactory(beanFactory);

// 调用实例工厂中的后置处理器
invokeBeanFactoryPostProcessors(beanFactory);

// 注册实例的后置处理器,在创建实例时进行拦截
registerBeanPostProcessors(beanFactory);

// 初始化消息资源
initMessageSource();

// 初始化容器中的事件处理器
initApplicationEventMulticaster();

// 初始化一些在特定容器中特殊的实例
onRefresh();

// 检查监听器的实例并注册它们
registerListeners();

// 实例化所有非懒加载的实例
finishBeanFactoryInitialization(beanFactory);

// 最后一步:发布一些响应事件
finishRefresh();
}
catch (BeansException ex) {
...
}
finally {
...
}
}
}

当这个方法调用完,spring容器就基本完成了初始化过程,tomcat当然也是在这个方法内部完成的创建

创建WebServer容器

Springboot内嵌的各种web容器实例,都是在onRefresh()中进行创建的。
查看方法实现可以发现这个方法是个空方法

protected void onRefresh() throws BeansException {
// For subclasses: do nothing by default.
}

但是其子类的都实现了这个方法,子类列表如下


因为Tomcat是一个Servlet容器,所以我们直接看ServletWebServerApplicationContext这个类中是如何实现的

进入这个类中,该方法的实现代码比较容易看懂,重点在createWebServer(),这里同样只保留了主要代码


@Override
protected void onRefresh() {
super.onRefresh();
createWebServer();
}

private void createWebServer() {
WebServer webServer = this.webServer;
ServletContext servletContext = getServletContext();
if (webServer == null && servletContext == null) {
// 通过工厂创建WebServer实例
ServletWebServerFactory factory = getWebServerFactory();
this.webServer = factory.getWebServer(getSelfInitializer());
}
}

前面1-5步都是在配置Tomcat,而完成Tomcat是在第6步getTomcatWebServer(tomcat)完成的,我们接着进去看看

getTomcatWebServer(tomcat)方法返回一个TomcatWebServer对象
TomcatWebServer对象是springboot对Tomcat对象的封装,内部存了tomcat实例的引用,这里执行的是TomcatWebServer的构造方法,

protected TomcatWebServer getTomcatWebServer(Tomcat tomcat) {
return new TomcatWebServer(tomcat, getPort() >= 0);
}

构造方法内部如下

public TomcatWebServer(Tomcat tomcat, boolean autoStart) {
Assert.notNull(tomcat, "Tomcat Server must not be null");
this.tomcat = tomcat;
this.autoStart = autoStart;
initialize();
}

我们主要来看initialize(),在这个方法内部会调用tomcat.start()

private void initialize() throws WebServerException {
synchronized (this.monitor) {
try {
// 给Engine命名
addInstanceIdToEngineName();
// 获取Host中的Context
Context context = findContext();
// 绑定Context的生命周期监听器
context.addLifecycleListener((event) -> {
if (context.equals(event.getSource()) && Lifecycle.START_EVENT.equals(event.getType())) {
removeServiceConnectors();
}
});
// 启动tomcat,触发初始化监听器
this.tomcat.start();
// 启动过程中子线程的异常从主线程抛出
rethrowDeferredStartupExceptions();
// 给当前Context绑定类加载器
ContextBindings.bindClassLoader(context, context.getNamingToken(), getClass().getClassLoader());
// tomcat的所有线程都是守护线程,这里启动一个阻塞的非守护线程来确保tomcat能及时停止
startDaemonAwaitThread();
}
catch (Exception ex) {
...
}
}
}

要注意的是这个方法启动的是tomcat工作需要的一些守护线程,并非是web服务;我们可以来看看start()的定义

/**
* Prepare for the beginning of active use of the public methods other than
* property getters/setters and life cycle methods of this component. This
* method should be called before any of the public methods other than
* property getters/setters and life cycle methods of this component are
* utilized. The following {@link LifecycleEvent}s will be fired in the
* following order:
* <ol>
* <li>BEFORE_START_EVENT: At the beginning of the method. It is as this
* point the state transitions to
* {@link LifecycleState#STARTING_PREP}.</li>
* <li>START_EVENT: During the method once it is safe to call start() for
* any child components. It is at this point that the
* state transitions to {@link LifecycleState#STARTING}
* and that the public methods other than property
* getters/setters and life cycle methods may be
* used.</li>
* <li>AFTER_START_EVENT: At the end of the method, immediately before it
* returns. It is at this point that the state
* transitions to {@link LifecycleState#STARTED}.
* </li>
* </ol>
*
* @exception LifecycleException if this component detects a fatal error
* that prevents this component from being used
*/
public void start() throws LifecycleException;

启动Web服务

真正完成springboot启动的方法,依然是由TomcatWebServer这个类完成的,这个类封装了控制整个web服务声明周期的方法,比如initialize(), start(), stop()等等,而这个start()显然就是web服务启动的方法了。

@Override
public void start() throws WebServerException {
synchronized (this.monitor) {
Connector connector = this.tomcat.getConnector();
if (connector != null && this.autoStart) {
performDeferredLoadOnStartup();
}
logger.info("Tomcat started on port(s): " + getPortsDescription(true) + " with context path '"
+ getContextPath() + "'");
}
}

看到这个方法里的这行log,大家应该很熟悉了,说明最终启动web容器的函数就是performDeferredLoadOnStartup()
performDeferredLoadOnStartup()方法内部逻辑如下

private void performDeferredLoadOnStartup() {
for (Container child : this.tomcat.getHost().findChildren()) {
if (child instanceof TomcatEmbeddedContext) {
((TomcatEmbeddedContext) child).deferredLoadOnStartup();
}
}
}

public void deferredLoadOnStartup() throws LifecycleException {
doWithThreadContextClassLoader(getLoader().getClassLoader(),
() -> getLoadOnStartupWrappers(findChildren()).forEach(this::load));
}


getLoadOnStartupWrappers()负责将Wrapper按照loadOnStartup的优先级进行重排序,这里的主要逻辑就是按照Wrapper的优先级,依次调用wrapper.load(),然后打印"Tomcat started on port …"完成web容器启动。

最后,还有一个问题未解答,就是start()是何时调用的?

start()何时调用
要解答这个问题,可以通过观察springboot的启动日志,看"Tomcat started on port …"这行日志是何时打印的。
按照这个方法,我们不难发现,这行日志仍然是在spring容器的refresh()里打印出来的,继续深入最终是锁定了refresh()里的最后一步,也就是finishRefresh()
ServletWebServerApplicationContext重写了finishRefresh()

@Override
protected void finishRefresh() {
super.finishRefresh();
WebServer webServer = startWebServer();
if (webServer != null) {
publishEvent(new ServletWebServerInitializedEvent(webServer, this));
}
}

private WebServer startWebServer() {
WebServer webServer = this.webServer;
if (webServer != null) {
webServer.start();
}
return webServer;
}

上面方法中的WebServer是一个接口,里面有三个方法start(), stop(), getPort() TomcatWebServer对其进行了实现,其中的start()就是在这里调用的,这里也就是最终启动web服务的地方。

至此,Springboot内嵌web服务器的秘密解开了。

总结
Spring框架基于接口的设计模式,使得整个框架具有良好的扩展性。我们再来回顾下spring是如何整合tomcat的。

首先,通过继承AbstractApplicationContext,重写onRefresh()对web容器进行初始化,重写finishRefresh()启动web服务。

其次,spring抽象了WebServer接口,提供了“启动”和“停止”两个基本方法,具体方法由不同的web容器各自实现,其中tomcat的实现类叫TomcatWebServer。

最后,TomcatWebServer在构造方法中调用initialize()初始化tomcat,调用start()方法启动web服务,在spring容器销毁之前调用stop()完成tomcat生命周期。




©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,386评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,142评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,704评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,702评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,716评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,573评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,314评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,230评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,680评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,873评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,991评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,706评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,329评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,910评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,038评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,158评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,941评论 2 355