Spring mvc原理之注册DispatcherServlet

背景

spring mvc作为优秀的web框架，从2003年问世（根据changelog）到现在已经经历了21年。springframework框架里，web相关的类从1.0版本的25个，发展到现在6.1版本，已经有103个。还不包括spring-boot里web相关的代码。初学者使用spring-boot-starter-web 能很快启动一个web服务，但是要理清内部的运行逻辑和理解作者的设计思路，就要花费很大力气。

下面我尝试模仿spring mvc，从0开始搭建web服务，剖析作者的设计意图。

web服务的基础-Tomcat

tomcat作为开源轻量级web服务器，支持java servlet，是spring boot默认的web服务器。通过内嵌的tomcat，我们可以很快速的开发web应用。我们通过一个demo，看一下开发web应用需要的最小配置。

一个小Demo

引入内嵌tomcat的pom文件：

<dependency><groupId>jakarta.annotation</groupId><artifactId>jakarta.annotation-api</artifactId><version>2.1.1</version><scope>compile</scope>
</dependency>
<dependency><groupId>org.apache.tomcat.embed</groupId><artifactId>tomcat-embed-core</artifactId><version>10.1.18</version><scope>compile</scope>
</dependency>

然后注册一个servlet就可以对外提供服务。

public static void main(String[] args) throws LifecycleException {
Tomcat tomcat = new Tomcat();String path = "C:\\\\Users\\\\admin\\\\AppData\\\\Local\\\\Temp\\\\tomcat.default.9999";tomcat.setBaseDir(path);Context context = tomcat.addContext("", path);tomcat.addServlet(context.getPath(), "defaultServlet", new HttpServlet() {@Overridepublic void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {System.out.println("get request " + req.getRequestURL());resp.setStatus(200);PrintWriter writer = resp.getWriter();writer.println(System.currentTimeMillis());}});context.addServletMappingDecoded("/*", "defaultServlet");Connector connector = new Connector("HTTP/1.1");connector.setPort(9999);tomcat.setConnector(connector);tomcat.start();tomcat.getServer().await();
}

这里做了几件事情：

  1. 初始化Tomcat实例，并设置根目录
  2. 创建一个Context
  3. 创建一个Servlet，并添加url路径到Servlet的映射关系
  4. 添加Connector，监听9999端口，这里支持HTTP/1.1协议
  5. 启动tomcat服务

访问http://localhost:9999就能看到正常返回了结果：

> curl -i <http://localhost:9999/abc/dd?xx=1>
HTTP/1.1 200
Content-Length: 15
Date: Wed, 24 Jan 2024 04:05:39 GMT1706069139905

Spring boot里的tomcat配置

了解完tomcat的基本使用方式，再对比spring boot里tomcat的用法。下面是spring boot初始化tomcat的逻辑：

// org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory
@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);configureEngine(tomcat.getEngine());for (Connector additionalConnector : this.additionalTomcatConnectors) {tomcat.getService().addConnector(additionalConnector);}prepareContext(tomcat.getHost(), initializers);return getTomcatWebServer(tomcat);
}

它这里干了几个事：

  1. 初始化Tomcat实例，并设置根目录
  2. 添加Server容器的LifecycleListener，作为一个扩展点开放出来
  3. 添加默认Connector，这里支持自定义Connector的属性，包括设置端口、协议等，又是一个扩展点
  4. 配置tomcat的Engine的backgroundProcessorDelay 属性和添加自定义engineValves
  5. 添加用户定义的Connector
  6. 创建一个Context，类型是spring自己定义的，继承了tomcat的Context
  7. 将Tomcat对象包装成spring的TomcatWebServer 对象

在不考虑内部细节的情况下，spring boot初始化tomcat的步骤基本和demo里的步骤是一样的。主要增加了很多扩展点，可以添加Server容器、自定义Connector、添加Engine的Valve（管道处理类）。还封装了tomcat的Context，在自己的Context里也加了很多扩展点。

另外，有一点很大的不同，就是spring boot的初始流程里没用看到注册Servlet的地方。我们都知道spring mvc核心的Servlet是DispatcherServlet，它会代理所有请求。下面分析DispatcherServlet是怎么注册到tomcat的Context。

DispatcherServlet注册到tomcat容器

spring boot是通过ServletContextInitializer来注册tomcat的Servlet、Filter、Listener等对象到ServletContext里。所以第一步要先将DispatcherServlet转成ServletContextInitializer对象。

DispatcherServlet怎么转成ServletContextInitializer对象

DispatcherServlet是一个Servlet类型，要转成ServletContextInitializer，需要一个包装类，DispatcherServletRegistrationBean就是这个包装类。 DispatcherServletRegistrationBean是ServletContextInitializer的子类，在spring boot启动时，通过自动装配机制，注册了DispatcherServletRegistrationBean。并且将DispatcherServlet对象放到了DispatcherServletRegistrationBean对象里。 DispatcherServletRegistrationBean的注册流程：

  1. DispatcherServletAutoConfiguration配置类先初始化了DispatcherServlet、DispatcherServletRegistrationBean对象
  2. 在DispatcherServletRegistrationBean对象里放入注册Servlet需要的信息
public DispatcherServletRegistrationBean dispatcherServletRegistration(DispatcherServlet dispatcherServlet,WebMvcProperties webMvcProperties, ObjectProvider<MultipartConfigElement> multipartConfig) {DispatcherServletRegistrationBean registration = new DispatcherServletRegistrationBean(dispatcherServlet,webMvcProperties.getServlet().getPath());registration.setName(DEFAULT_DISPATCHER_SERVLET_BEAN_NAME);registration.setLoadOnStartup(webMvcProperties.getServlet().getLoadOnStartup());multipartConfig.ifAvailable(registration::setMultipartConfig);return registration;
}

在得到ServletContextInitializer后就要考虑什么时候去执行它，并将DispatcherServlet注册到tomcat容器。这时先看一下tomcat的初始化过程。

tomcat创建时机

SpringApplication.run()方法在执行refreshContext(context)时，会调用AnnotationConfigServletWebServerApplicationContext.refresh()方法，一直会调用到web容器的父类ServletWebServerApplicationContext的createWebServer()。

生成tomcat对象

createWebServer()会调用TomcatServletWebServerFactory.getWebServer()来初始化tomcat对象。

初始化tomcat对象需要设置一个tomcat上下文，对应类型是StandardContext。这里spring自定义了StandardContext的子类TomcatEmbeddedContext作为tomcat上下文。

这时spring会预定义3个ServletContextInitializer，并封装到TomcatStarter里。TomcatStarter是ServletContainerInitializer的子类，ServletContainerInitializer是tomcat的对象和ServletContextInitializer不一样，后者是spring的对象。 然后调用TomcatEmbeddedContext.addServletContainerInitializer(TomcatStarter)，把TomcatStarter添加到tomcat上下文的initializers属性里。initializers属性在启动tomcat时会用到。

tomcat初始化后，会被包装成TomcatWebServer对象，然后在构造函数里启动tomcat。之后tomcat就会从上下文对象里拿到ServletContextInitializer进行初始化。

tomcat初始化流程

  1. tomcat.start()调用server.start()
  2. server又调用service.start()
  3. service又调用engine.start()
  4. engine通过线程池调用host.start()
  5. host通过线程池调用TomcatEmbeddedContext.start()，这会执行父类方法StandardContext.startInternal()，方法里会把上面initializers里的ServletContainerInitializer对象拿出来，也就是上面的TomcatStarter对象，调用它的onStartup()方法
  6. TomcatStarter又会调用它里面的几个ServletContextInitializer.onstartup(servletContext) TomcatStarter默认包含3个ServletContextInitializer，我们关注的是ServletWebServerApplicationContext.selfInitialize()方法对应的匿名ServletContextInitializer，代码如下：
private void selfInitialize(ServletContext servletContext) throws ServletException {prepareWebApplicationContext(servletContext);registerApplicationScope(servletContext);WebApplicationContextUtils.registerEnvironmentBeans(getBeanFactory(), servletContext);for (ServletContextInitializer beans : getServletContextInitializerBeans()) {beans.onStartup(servletContext);}
}

核心逻辑在getServletContextInitializerBeans()里，方法返回ServletContextInitializerBeans对象。 ServletContextInitializerBeans是ServletContextInitializer的集合，它会把beanFactory里的ServletContextInitializer对象加进来，并且还把Servlet、Fileter、Listerner等spring bean包装成RegistrationBean（RegistrationBean是ServletContextInitializer的子类）也加进来。这样就得到一个ServletContextInitializer列表，默认会加载的对象有：

  1. DispatcherServletRegistrationBean
  2. CharacterEncodingFilter
  3. OrderedFormContentFilter
  4. OrderedRequestContextFilter

然后调用每个ServletContextInitializer的onStartup(servletContext)方法。

DispatcherServletRegistrationBean注册DispatcherServlet

注册DispatcherServlet要执行这两行代码：

// 添加servlet
servletContext.addServlet(servletName, servlet);// 添加映射关系
context.addServletMappingDecoded(urlPattern, servletName);

DispatcherServletRegistrationBean里onStratup方法会调用register()方法。register()方法会做两个事情：

  1. 执行addRegistration()方法，会把里面的DispatcherServlet对象注册到ServletContext，并返回ServletRegistration对象。

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

  2. 执行configure()方法，注册url到DispatcherServlet对象的映射，逻辑在registration.addMapping(urlMapping)里

    // org.springframework.boot.web.servlet.ServletRegistrationBean#configure
protected void configure(ServletRegistration.Dynamic registration) {// ...if (!ObjectUtils.isEmpty(urlMapping)) {registration.addMapping(urlMapping);}// ...
}// org.apache.catalina.core.ApplicationServletRegistration#addMapping
public Set<String> addMapping(String... urlPatterns) {// ...for (String urlPattern : urlPatterns) {context.addServletMappingDecoded(UDecoder.URLDecode(urlPattern, StandardCharsets.UTF_8), wrapper.getName());}return Collections.emptySet();
}

到这里，DispatcherServlet就成功注册到了toncat的上下文上，并且和url建立了映射关系，默认url是"/"。

总结

spring boot的基础是tomcat，就要遵循tomcat的servlet规范。它通过ServletContextInitializer实现了Servlet的自动注册机制；用DispatcherServlet代理所有请求，内部实现了请求的路由、类型转换等。将开发者和tomcat解耦，也方便框架去替换不同的web容器。

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

clickhouse数据库 使用http 方式交付查询sql

clickhouse数据库 使用http 方式交付查询sql

今天使用clickhouse 的HTTP 方式进行查询语句 clickhouse 服务 搭建在192.168.0.111 上面 那么我们如何快速的去查询呢 如下 我们可以使用curl 功能 或者直接在浏览器上输入对应的查询命令 如下&#xff1a; http://192.168.0.111:8123/userdefault&password123456&…
阅读更多...
ubuntu20根目录扩容

ubuntu20根目录扩容

ubuntu根目录/ 或者 /home文件夹有时出现空间满了的情况&#xff0c;可以用gparted工具进行空间的重新分配。 首先&#xff0c;如果你是双系统&#xff0c;需要从windows系统下磁盘压缩分配一部分未使用的空间给ubuntu&#xff0c;注意压缩的空间要邻接ubuntu所在盘的位置。 …
阅读更多...
力扣刷MySQL-第七弹（详细讲解）

力扣刷MySQL-第七弹（详细讲解）

&#x1f389;欢迎您来到我的MySQL基础复习专栏 ☆* o(≧▽≦)o *☆哈喽~我是小小恶斯法克&#x1f379; ✨博客主页&#xff1a;小小恶斯法克的博客 &#x1f388;该系列文章专栏&#xff1a;力扣刷题讲解-MySQL &#x1f379;文章作者技术和水平很有限&#xff0c;如果文中出…
阅读更多...
【Flink-1.17-教程】-【五】Flink 中的时间和窗口（2）时间语义

【Flink-1.17-教程】-【五】Flink 中的时间和窗口（2）时间语义

【Flink-1.17-教程】-【五】Flink 中的时间和窗口&#xff08;2&#xff09;时间语义 1&#xff09;Flink 中的时间语义2&#xff09;时间语义的分类2.1.处理时间&#xff08;process time&#xff09;2.2.摄取时间&#xff08;ingestion time&#xff09;2.3.事件时间&#xf…
阅读更多...
DBeaver-ce工具创建表并设置id自增

DBeaver-ce工具创建表并设置id自增

DBeaver-很多版本自增加不了ID&#xff0c;报错“[SQLITE_ERROR] SQL error or missing database (AUTOINCREMENT is only allowed on an INTEGER PRIMARY KEY)” Error creating new object 原因&#xff1a; Cannot invoke "org.jkiss.dbeaver.model.struct.DBSObjec…
阅读更多...
将python打包成exe文件

将python打包成exe文件

将python打包成exe文件 文章目录 将python打包成exe文件1.安装PyInstaller2.配置pyinstaller到环境变量3.打包 以上一篇文章&#x1f517;用python删除重复文件并放入回收站为例&#xff0c;演示了如何用python写一个删除重复文件并放入回收站的功能代码&#xff0c;但是每次都…
阅读更多...
大创项目推荐 题目： 基于深度学习的疲劳驾驶检测 深度学习

大创项目推荐 题目： 基于深度学习的疲劳驾驶检测 深度学习

文章目录 0 前言1 课题背景2 实现目标3 当前市面上疲劳驾驶检测的方法4 相关数据集5 基于头部姿态的驾驶疲劳检测5.1 如何确定疲劳状态5.2 算法步骤5.3 打瞌睡判断 6 基于CNN与SVM的疲劳检测方法6.1 网络结构6.2 疲劳图像分类训练6.3 训练结果 7 最后 0 前言 &#x1f525; 优…
阅读更多...
Webpack5 基本使用 - 3（完结）

Webpack5 基本使用 - 3（完结）

环境区分 可以定义多个配置文件&#xff0c;通过 webpack-merge 合并配置文件。 安装 webpack-merge yarn add webpack-merge公共配置 // webpack.common.js const path require(path) const HtmlWebpackPlugin require(html-webpack-plugin)module.exports {entry: path…
阅读更多...
【问题解决】Java-生成word和pdf中文乱码（小方框）

【问题解决】Java-生成word和pdf中文乱码（小方框）

问题情境&#xff1a; 项目中生成pdf报告采用的逻辑为&#xff1a;对代码中resoure下的固定的word模版进行文件读取&#xff0c;替换关键字&#xff0c;生成word&#xff0c;然后word转pdf的思路。 在本地运行没有问题&#xff0c;签章和页面字体均为问题&#xff0c;但部署服…
阅读更多...
外呼机器人有什么优势？

外呼机器人有什么优势？

外呼机器人有什么优势&#xff1f;值得受到大多数电销企业的追捧&#xff01; 1、电话外呼效率高&#xff1a; 每天可拨打的电话数量是人工的5-10倍&#xff0c;人工一天只能拨打200-300通电话&#xff0c;机器人每天能打3000通电话以上&#xff0c;无须休息&#xff0c;按照…
阅读更多...
动态规划学习——数字转为字母

动态规划学习——数字转为字母

问题&#xff1a; 假设1对应A,2对应B,3对应C...26对应Z 现在给定一个数字串&#xff0c;求其可以转化为多少种字母串 如111可以转化为AAA,AK,KA 问题分析&#xff1a; 由于一共有26个英文字母&#xff0c;所以既可以一个数字对应一个字母&#xff0c;也可以两个数字对应一个…
阅读更多...
Java-NIO篇章（4）——Reactor反应器模式

Java-NIO篇章（4）——Reactor反应器模式

前面已经讲过了Java-NIO中的三大核心组件Selector、Channel、Buffer&#xff0c;现在组件我们回了&#xff0c;但是如何实现一个超级高并发的socket网络通信程序呢&#xff1f;假设&#xff0c;我们只有一台内存为32G的Intel-i710八核的机器&#xff0c;如何实现同时2万个客户端…
阅读更多...
openGauss学习笔记-206 openGauss 数据库运维-常见故障定位案例-too many clients already

openGauss学习笔记-206 openGauss 数据库运维-常见故障定位案例-too many clients already

文章目录 openGauss学习笔记-206 openGauss 数据库运维-常见故障定位案例-too many clients already206.1 高并发报错“too many clients already”或无法创建线程206.1.1 问题现象206.1.2 原因分析206.1.3 处理办法 openGauss学习笔记-206 openGauss 数据库运维-常见故障定位案…
阅读更多...
143基于matlab的2D平面桁架有限元分析

143基于matlab的2D平面桁架有限元分析

基于matlab的2D平面桁架有限元分析&#xff0c;可以改变材料参数&#xff0c;输出平面结构外形&#xff0c;各桁架应力&#xff0c;位移及作用力。可查看节点力&#xff0c;程序已调通&#xff0c;可直接运行。 143 matlab 平面桁架 有限元分析 桁架应力 (xiaohongshu.com)
阅读更多...
element-ui 树形控件 通过点击某个节点，遍历获取上级的所有父节点和本身节点

element-ui 树形控件 通过点击某个节点，遍历获取上级的所有父节点和本身节点

1、需求&#xff1a;点击树形控件的某个节点&#xff0c;需要拿到它上级的所有父节点进行操作 2、代码&#xff1a; 树形控件代码 <el-tree:data"deptOptions"node-click"getVisitCheckedNodes"ref"target_tree_Speech"node-key"id&qu…
阅读更多...
prometheus监控RabbitMQ策略

prometheus监控RabbitMQ策略

一般用官方的rabbitmq_exporter采取数据即可&#xff0c;然后在普米配置。但如果rabbitmq节点的队列数超过了5000&#xff0c;往往rabbitmq_exporter就会瘫痪&#xff0c;因为rabbitmq_exporter采集的信息太多&#xff0c;尤其是那些队列的细节&#xff0c;所以队列多了&#x…
阅读更多...
ubuntu下docker卸载和重新安装

ubuntu下docker卸载和重新安装

卸载&#xff1a;步骤一&#xff1a;停止Docker服务 首先&#xff0c;我们需要停止正在运行的Docker服务。打开终端&#xff0c;执行以下命令&#xff1a; sudo systemctl stop docker 步骤二&#xff1a;删除Docker安装包 接下来&#xff0c;我们需要删除已经安装的Docker软件…
阅读更多...
2024年美赛数学建模思路 - 案例：异常检测

2024年美赛数学建模思路 - 案例：异常检测

文章目录 赛题思路一、简介 -- 关于异常检测异常检测监督学习 二、异常检测算法2. 箱线图分析3. 基于距离/密度4. 基于划分思想 建模资料 赛题思路 &#xff08;赛题出来以后第一时间在CSDN分享&#xff09; https://blog.csdn.net/dc_sinor?typeblog 一、简介 – 关于异常…
阅读更多...
[云访谈]熊娟：要把钟煲煲打造成万店级连锁品牌

[云访谈]熊娟：要把钟煲煲打造成万店级连锁品牌

导读 众所周知&#xff0c;疫情后期餐饮行业的挑战加剧&#xff0c;市场上流传着这样一句话&#xff1a;“餐饮倒闭率达到百分百”。这意味着&#xff0c;在一条街上&#xff0c;可能每个店铺每年都要更换一次老板。 从宏观角度来看&#xff0c;疫情确实对餐饮业造成了重创。…
阅读更多...
Qt‘s 撤销框架（Qt‘s Undo Framework）

Qt‘s 撤销框架（Qt‘s Undo Framework）

一、开篇序言 我们常常有这样的业务场景，需要支持撤回的动作（即 undo）。如果让你来设计，聪明的你肯定也能立即想到解决问题的办法，对，将操作的 command { 对象，指令，属性 } 保存到一个容器中。 如果是仅需要单步撤销， 使用栈容器 保存command，动作执行即指令入栈， …
阅读更多...
最新文章

Copyright @ 2022~2023