SpringBoot内嵌Tomcat启动流程

前言

Spring MVC 让开发者不用了解 Servlet 细节，专注于 Controller 编写 API 接口。Spring Boot 更是采用约定大于配置的设计思想，通过内嵌 Tomcat 的方式让开发者可以快速构建并部署一个 Web 应用。怎么做到的呢？

Tomcat启动方式

早期的开发，一般是基于 Spring 和 Spring MVC 构建我们的应用，然后把项目打成 War 包。在服务器上安装 Tomcat，把我们的 War 包放到对应的 webapp 目录下，启动 Tomcat 服务就可以访问了。
其实要部署我们的服务，没必要这么繁琐，通过代码启动 Tomcat 早就不是新鲜事了。

我这里写一个示例，只引入 Spring MVC 和 Tomcat 依赖：

<dependencies>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.3.31</version>
  </dependency>
  <dependency>
    <groupId>org.apache.tomcat.embed</groupId>
    <artifactId>tomcat-embed-core</artifactId>
    <version>9.0.83</version>
  </dependency>
</dependencies>

编写我们的 Controller

@RestController
public class HelloContrller {

    @RequestMapping("hello")
    public String hello() {
        return "hello world!";
    }
}

再编写我们的启动类，手动把 Tomcat 给启动起来并注册 DispatcherServlet。

@Configuration
@ComponentScan
public class Application {
    public static void main(String[] args) throws Exception {
        AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();
        context.register(Application.class);
        context.refresh();

        Tomcat tomcat = new Tomcat();
        Connector connector = new Connector();
        connector.setPort(8080);
        tomcat.getService().addConnector(connector);

        final String contextPath = "";
        StandardContext standardContext = new StandardContext();
        standardContext.setPath(contextPath);
        standardContext.addLifecycleListener(new Tomcat.FixContextListener());
        tomcat.getHost().addChild(standardContext);

        standardContext.addServletContainerInitializer(new ServletContainerInitializer() {
            @Override
            public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException {
                System.err.println("Servlet容器初始化...");
                DispatcherServlet servlet = new DispatcherServlet(context);
                tomcat.addServlet(contextPath, "DispatcherServlet", servlet);
                standardContext.addServletMappingDecoded("/*", "DispatcherServlet");
            }
        }, Collections.EMPTY_SET);
        tomcat.start();
    }
}

运行 Application 类，即可访问服务

curl localhost:8080/hello
hello world!

Spring Boot 底层其实也是这么干的，一起来分析下吧。

设计实现

回到程序启动的入口，为什么执行下面一行代码，Web 服务就起来了。

SpringApplication.run(Application.class, args);

Spring Boot 首先会实例化一个 SpringApplication 对象，在构造函数里，首先要推导出 Web 应用类型，才好启对应的服务。

public enum WebApplicationType {
	NONE,
    SERVLET,
    REACTIVE;
}
  • NONE：无需启动 Web 服务
  • SERVLET：基于 Servlet 容器的 Web 应用
  • REACTIVE：响应时 Web 应用

推导的方法是WebApplicationType#deduceFromClasspath，原理是检查 ClassPath 路径下是否存在对应的类。比如：存在org.springframework.web.reactive.DispatcherHandler类那就是 SERVLET 类型（不绝对）

private static final String[] SERVLET_INDICATOR_CLASSES = { "javax.servlet.Servlet",
        "org.springframework.web.context.ConfigurableWebApplicationContext" };
private static final String WEBMVC_INDICATOR_CLASS = "org.springframework.web.servlet.DispatcherServlet";
private static final String WEBFLUX_INDICATOR_CLASS = "org.springframework.web.reactive.DispatcherHandler";
private static final String JERSEY_INDICATOR_CLASS = "org.glassfish.jersey.servlet.ServletContainer";

static WebApplicationType deduceFromClasspath() {
    if (ClassUtils.isPresent(WEBFLUX_INDICATOR_CLASS, null) && !ClassUtils.isPresent(WEBMVC_INDICATOR_CLASS, null)
            && !ClassUtils.isPresent(JERSEY_INDICATOR_CLASS, null)) {
        return WebApplicationType.REACTIVE;
    }
    for (String className : SERVLET_INDICATOR_CLASSES) {
        if (!ClassUtils.isPresent(className, null)) {
            return WebApplicationType.NONE;
        }
    }
    return WebApplicationType.SERVLET;
}

Spring Boot 本质还是一个 Spring 应用，所以它肯定是要依赖上下文容器对象的。所以在run()里它会调用createApplicationContext()根据 Web 应用类型创建对应的 ConfigurableApplicationContext。不同的 Web 应用类型对应不同的实现类，创建职责交给了DefaultApplicationContextFactory#create，它会去解析META-INF/spring.factories文件里配置的工厂类，然后判断哪个工厂类支持创建。

private <T> T getFromSpringFactories(WebApplicationType webApplicationType,
        BiFunction<ApplicationContextFactory, WebApplicationType, T> action, Supplier<T> defaultResult) {
    for (ApplicationContextFactory candidate : SpringFactoriesLoader.loadFactories(ApplicationContextFactory.class,
            getClass().getClassLoader())) {
        // 实例化 AnnotationConfigServletWebServerApplicationContext
        T result = action.apply(candidate, webApplicationType);
        if (result != null) {
            return result;
        }
    }
    return (defaultResult != null) ? defaultResult.get() : null;
}

默认配置的工厂类：

org.springframework.boot.ApplicationContextFactory=\
org.springframework.boot.web.reactive.context.AnnotationConfigReactiveWebServerApplicationContext.Factory,\
org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext.Factory

默认是 Servlet 环境，所以会使用 AnnotationConfigServletWebServerApplicationContext.Factory 工厂类，创建的上下文对象是 AnnotationConfigServletWebServerApplicationContext。
实例化上下文对象后，紧接着就是调用其refresh()刷新上下文，这是个模板方法，流程在分析 Spring 源码时已经说过了，这里就略过了。
我们这里要重点关注的是子类重写后的扩展方法ServletWebServerApplicationContext#onRefresh，它会在父类准备好整个环境后创建 Web 服务。

@Override
protected void onRefresh() {
    super.onRefresh();
    try {
        createWebServer();
    }
    catch (Throwable ex) {
        throw new ApplicationContextException("Unable to start web server", ex);
    }
}

createWebServer()首先要获取 ServletWebServerFactory 工厂对象，默认的 Servlet 容器是 Tomcat，所以工厂类是 TomcatServletWebServerFactory。在实例化工厂类时要求传入一组 ServletContextInitializer，Spring 在初始化 Servlet 容器时会调用它的onStartup()用于注册 Servlet。

private void createWebServer() {
    WebServer webServer = this.webServer;
    ServletContext servletContext = getServletContext();
    if (webServer == null && servletContext == null) {// 默认走这里
        StartupStep createWebServer = this.getApplicationStartup().start("spring.boot.webserver.create");
        ServletWebServerFactory factory = getWebServerFactory();
        createWebServer.tag("factory", factory.getClass().toString());
        // 通过工厂获取WebServer，会直接启动
        this.webServer = factory.getWebServer(getSelfInitializer());
        createWebServer.end();
        getBeanFactory().registerSingleton("webServerGracefulShutdown",
                new WebServerGracefulShutdownLifecycle(this.webServer));
        getBeanFactory().registerSingleton("webServerStartStop",
                new WebServerStartStopLifecycle(this, this.webServer));
    }
    ......
}

private org.springframework.boot.web.servlet.ServletContextInitializer getSelfInitializer() {
    return this::selfInitialize;
}

// Spring初始化Servlet容器时触发
private void selfInitialize(ServletContext servletContext) throws ServletException {
    prepareWebApplicationContext(servletContext);
    registerApplicationScope(servletContext);
    WebApplicationContextUtils.registerEnvironmentBeans(getBeanFactory(), servletContext);
    for (ServletContextInitializer beans : getServletContextInitializerBeans()) {
        beans.onStartup(servletContext);
    }
}

TomcatServletWebServerFactory#getWebServer会实例化 Tomcat 并启动。

@Override
public WebServer getWebServer(ServletContextInitializer... initializers) {
    if (this.disableMBeanRegistry) {
        Registry.disableRegistry();
    }
    Tomcat tomcat = new Tomcat();
    // 基础目录
    File baseDir = (this.baseDirectory != null) ? this.baseDirectory : createTempDir("tomcat");
    tomcat.setBaseDir(baseDir.getAbsolutePath());
    for (LifecycleListener listener : this.serverLifecycleListeners) {
        tomcat.getServer().addLifecycleListener(listener);
    }
    // 连接器
    Connector connector = new Connector(this.protocol);
    connector.setThrowOnFailure(true);
    tomcat.getService().addConnector(connector);
    customizeConnector(connector);
    tomcat.setConnector(connector);
    tomcat.getHost().setAutoDeploy(false);
    // 配置Engine
    configureEngine(tomcat.getEngine());
    for (Connector additionalConnector : this.additionalTomcatConnectors) {
        tomcat.getService().addConnector(additionalConnector);
    }
    /**
     * 配置上下文，这里会把ServletContextInitializer封装成TomcatStarter
     * 并设置到Host.Context
     */
    prepareContext(tomcat.getHost(), initializers);
    return getTomcatWebServer(tomcat);
}

配置 Tomcat 是个复杂的过程，这里不赘述，与我们最相关的就是 Port、ContextPath、Servlet 的配置，我们重点关注 Servlet 的配置。
我们知道，Spring MVC 的核心是 DispatcherServlet，它是何时被注册到 Tomcat 的呢？？？这就不得不提到另一个组件 ServletContainerInitializer。
ServletContainerInitializer 是 Servlet 3.0 提供的用来初始化 Servlet 容器的接口，通过实现这个接口可以让第三方组件有机会来对容器做一些初始化的工作，比如动态的注册 Servlet、Filter 等等。
显然，Spring Boot 需要注册 DispatcherServlet。所以 Spring Boot 首先会把容器内的所有 ServletContextInitializer Bean 统一封装成 TomcatStarter，而 TomcatStarter 恰恰就是 ServletContainerInitializer 的实现类。所以 Tomcat 启动时会触发其onStartup()

@Override
public void onStartup(Set<Class<?>> classes, ServletContext servletContext) throws ServletException {
    try {
        for (ServletContextInitializer initializer : this.initializers) {
            initializer.onStartup(servletContext);
        }
    }
    catch (Exception ex) {
    }
}

代码很简单，就是挨个调用ServletContextInitializer#onStartup，其中有个最关键的实现类就是 DispatcherServletRegistrationBean，顾名思义，它就是用来注册 DispatcherServlet。
image.png
注册的方法是ServletRegistrationBean#addRegistration，这里就会注册我们最关心的 DispatcherServlet

@Override
protected ServletRegistration.Dynamic addRegistration(String description, ServletContext servletContext) {
    String name = getServletName();
    return servletContext.addServlet(name, this.servlet);
}

为了便于理解，这里画了一张流程图：
image.png

尾巴

Spring Boot 本身也是个 Spring 应用，它也要依赖于上下文容器对象，如果我们构建的是 Web 应用，它就会创建适用于 Web 环境的上下文容器，例如 ServletWebServerApplicationContext，然后通过父类的模板方法来 refresh，只不过它重写了 onRefresh 方法，等待父类准备好环境后会创建 WebServer，启动我们的 Web 服务，默认启动的是 Tomcat，然后通过实现 ServletContainerInitializer 的方式来注册 DispatcherServlet。这就是 Spring Boot 内嵌 Tomcat 的秘密。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/310865.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

Java 数据结构篇-实现 AVL 树的核心方法

Java 数据结构篇-实现 AVL 树的核心方法

&#x1f525;博客主页&#xff1a; 【小扳_-CSDN博客】 ❤感谢大家点赞&#x1f44d;收藏⭐评论✍ 文章目录 1.0 AVL 树的说明 2.0 AVL 树的成员变量及其构造方法 3.0 实现 AVL 树的核心方法 3.1 获取当前节点的高度 height(AVLNode node) 3.2 更新当前节点的高度 updateHeig…
阅读更多...
软件安全测评需要关注哪些?湖南CMA、CNAS软件测试公司推荐

软件安全测评需要关注哪些?湖南CMA、CNAS软件测试公司推荐

在当今信息化的社会&#xff0c;软件安全问题日益凸显&#xff0c;给个人和企业的数据安全造成了极大的威胁。为了保障软件的安全性&#xff0c;软件安全测评应运而生。 软件安全测评是通过对软件系统的评估&#xff0c;发现其中存在的安全漏洞和风险&#xff0c;为软件的开发…
阅读更多...
大模型 RAG 问答技术架构及核心模块盘点：从 Embedding、prompt-embedding 到 Reranker

大模型 RAG 问答技术架构及核心模块盘点：从 Embedding、prompt-embedding 到 Reranker

对于RAG而言&#xff0c;2023年已经出现了很多工作&#xff0c;草台班子有了一堆&#xff0c;架构也初步走通&#xff0c;2024年应该会围绕搜索增强做更多的优化工作。 因此我们今天来系统回顾下RAG中的模块&#xff0c;包括一些架构&#xff0c;文本嵌入embedding等&#xff…
阅读更多...
MATLAB根据数据拟合曲线

MATLAB根据数据拟合曲线

MATLAB根据数据拟合曲线 MATLAB根据数据拟合曲线视频观看 MATLAB根据数据拟合曲线 x1[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,6…
阅读更多...
深入浅出Android dmabuf_dump工具

深入浅出Android dmabuf_dump工具

dmabuf是什么&#xff1f; 可以参考我之前写的一篇文章&#xff0c;在这篇文章中有介绍dma_buf&#xff1a;BufferManager_驱动的buffermanager-CSDN博客 dmabuf_dump工具介绍(基于Android 14) dmabuf_dump是一个可执行文件&#xff0c;接收参数调用libdmabufinfo.a的接口完成…
阅读更多...
C#，入门教程(15)——类（class）的基础知识

C#，入门教程(15)——类（class）的基础知识

上一篇&#xff1a; C#&#xff0c;入门教程(14)——字符串与其他数据类型的转换https://blog.csdn.net/beijinghorn/article/details/124004562 物以类聚&#xff0c;凡物必类。 类的使用&#xff0c;须遵循几个简单的原则&#xff1a; &#xff08;1&#xff09;能类则类&a…
阅读更多...
宏集案例丨宏集PC Runtime软件助推食品行业生产线数字化革新

宏集案例丨宏集PC Runtime软件助推食品行业生产线数字化革新

来源&#xff1a;宏集科技 工业物联网 宏集案例丨宏集PC Runtime软件助推食品行业生产线数字化革新 原文链接&#xff1a;https://mp.weixin.qq.com/s/DwzVzifUiidNr-FT3Zfzpg 欢迎关注虹科&#xff0c;为您提供最新资讯&#xff01; 01 前言 近年来&#xff0c;中国食品行业…
阅读更多...
想进入游戏开发领域，应该先学习C++编程还是C#编程？

想进入游戏开发领域，应该先学习C++编程还是C#编程？

想进入游戏开发领域&#xff0c;应该先学习C编程还是C#编程&#xff1f; 当你决心踏入游戏开发者的行列时&#xff0c;最先迎接你的将是引擎的选择。引擎是游戏的心脏&#xff0c;所有精彩的画面和内容都是脉脉游戏血液从引擎中流淌而出。Unity、Unreal Engine、Cocos等引擎盛…
阅读更多...
牛客字符串

牛客字符串

提示&#xff1a;文章写完后&#xff0c;目录可以自动生成&#xff0c;如何生成可参考右边的帮助文档 文章目录 前言一、pandas是什么&#xff1f;二、使用步骤 1.引入库2.读入数据总结 前言 提示&#xff1a;这里可以添加本文要记录的大概内容&#xff1a; 例如&#xff1a;…
阅读更多...
存储卷（数据卷）—主要是nfs方式挂载

存储卷（数据卷）—主要是nfs方式挂载

1、定义 容器内的目录和宿主机的目录进行挂载 容器在系统上的生命周期是短暂的&#xff0c;一旦容器被删除&#xff0c;数据会丢失。k8s基于控制器创建的pod&#xff0c;delete相当于重启&#xff0c;容器的状态会恢复到原始状态。一旦回到原始状态&#xff0c;后天编辑的文件…
阅读更多...
二叉树的层序遍历（C++详解）

二叉树的层序遍历（C++详解）

文章目录 写在前面解题思路具体做法 写在前面 本篇文章使用C实现了二叉树的层序遍历。在实现二叉树层序遍历时&#xff0c;一般情况下&#xff0c;大家可能直接输出遍历结果。然而&#xff0c;在解决在线评测&#xff08;OJ&#xff09;问题时&#xff0c;有时要求将每一层的遍…
阅读更多...
这7个设计素材网站太好用了，特别是第一款！

这7个设计素材网站太好用了，特别是第一款！

网页设计师在使用网页设计素材时&#xff0c;会优先考虑那些免费优质的网页设计素材网站。找到一个免费优质的网页设计素材网站并不容易。有些网站要么需要开设材料网站的会员&#xff0c;要么设计素材质量差。即时设计整理总结了 7 个免费的网页设计素材网站&#xff0c;对 “…
阅读更多...
GENMARK控制器维修SMALL SMC4092

GENMARK控制器维修SMALL SMC4092

晶圆转移机器人SMALL CONTROLLER控制器维修 SMC1100 半导体设备机械臂GENMARK控制器维修 eSensor特点&#xff1a; &#xff08;1&#xff09;基于DNA杂交和电化学检测原理&#xff1b; &#xff08;2&#xff09;电化学传感检测&#xff0c;并非荧光或光学检测。 电子信号的…
阅读更多...
中国光伏展

中国光伏展

中国光伏展是中国最大的光伏产业展览会&#xff0c;每年在国内举办一次。该展览会汇集了国内外光伏行业的领先企业和专业人士&#xff0c;展示最新的光伏技术、产品和解决方案。 中国光伏展旨在促进光伏行业的发展和创新&#xff0c;提升光伏产业的国际竞争力。展览会涵盖了光伏…
阅读更多...
一、Sharding-JDBC系列01：整合SpringBoot实现分库分表，读写分离

一、Sharding-JDBC系列01：整合SpringBoot实现分库分表，读写分离

目录 一、概述 二、案例演示-水平分表 (1)、创建springboot工程 (2)、创建数据库和数据表 (3)、application.yaml配置分片规则 (4)、测试数据插入、查询操作 4.1、插入-控制台SQL日志 4.2、查询-控制台SQL日志 三、案例演示-水平分库 (1)、创建数据库和数据表 (2…
阅读更多...
React07-路由管理器react-router-dom（v6）

React07-路由管理器react-router-dom（v6）

react-router 是一个流行的用于 React 应用程序路由的库。它使我们能够轻松定义应用程序的路由&#xff0c;并将它们映射到特定的组件&#xff0c;这样可以很容易地创建复杂的单页面应用&#xff0c;并管理应用程序的不同视图。 react-router 是基于 React 构建的&#xff0c;…
阅读更多...
离线安装telnet-server

离线安装telnet-server

telnet下载地址&#xff1a; https://vault.centos.org/ 需要下载telnet 和 telnet-server 确认自己的服务器版本&#xff0c;我这里使用的是&#xff08;Red Hat Enterprise Linux Server release 7.0 (Maipo)&#xff09;对应的是Centos 7.0,所有到 https://vault.centos.or…
阅读更多...
平面光波导_三层均匀平面光波导_射线分析法

平面光波导_三层均匀平面光波导_射线分析法

平面光波导_三层均匀平面光波导_射线分析法 三层均匀平面光波导&#xff1a; 折射率沿 x x x 方向有变化&#xff0c;沿 y y y、 z z z 方向没有变化三层&#xff1a;芯区( n 1 n_1 n1​) > > > 衬底( n 2 n_2 n2​) ≥ \geq ≥ 包层( n 3 n_3 n3​)包层通常为空…
阅读更多...
许战海矩阵战略洞察：如何解决3亿调味品企业朱老六的增长难题

许战海矩阵战略洞察：如何解决3亿调味品企业朱老六的增长难题

​长春市朱老六食品股份有限公司&#xff0c;是一家以生产腐乳、酸菜等生物发酵品为主的民营企业。 创始人团队自1991年起开发腐乳产品&#xff0c;并于1997年创立“朱老六”品牌。公司专研地道东北味&#xff0c;有着多年的专业经验和深厚的行业积淀&#xff0c;2019年腐乳产…
阅读更多...
创建ROS模型与小机器人地图规划

创建ROS模型与小机器人地图规划

1、打开自己的VM系统 2、安装小机器人的安装包&#xff0c;输入如下命令&#xff0c;回车输入密码(自己设的)&#xff1a; sudo apt install ros-noetic-turtlebot3-simulations ros-noetic-turtlebot3-slam ros-noetic-turtlebot3-navigation 提示我之前安装过了 3、用rosla…
阅读更多...
最新文章

Copyright @ 2022~2023