当今微服务大行其道,Tomcat作为服务基石,功不可没
感谢点星⭐⭐的朋友们,本仓库通过手写Tomcat,希望能够带着大家攻克Web系统底层原理,领悟服务器设计哲学,带你卷向更高处
Tomcat宏观架构如下:
在手写Tomcat之前,你需要先掌握HTTP请求/响应的基本格式:
HTTP请求格式如下:
- 第一行:请求方法 路径 协议/版本
- 后面是请求头
- 空一行
- 请求体
GET /hello.txt HTTP/1.1
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7
Accept-Encoding: gzip, deflate, br
Accept-Language: zh-CN,zh;q=0.9
Cache-Control: max-age=0
Connection: keep-alive
Host: localhost:8080
Sec-Fetch-Dest: document
Sec-Fetch-Mode: navigate
Sec-Fetch-Site: none
Sec-Fetch-User: ?1
Upgrade-Insecure-Requests: 1
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36
sec-ch-ua: "Google Chrome";v="113", "Chromium";v="113", "Not-A.Brand";v="24"
请求体(支持不同的类型如json、xml、x-www-form-urlencoded等)
HTTP响应格式类似:
- 状态行: 协议/版本 响应码 msg
- 响应头
- 空行
- 响应体
HTTP/1.1 200 OK
Content-Type: text/html
Content-Length: 12
Server: tomcat
Hello World!
handson-tomcat章节如下;
- 一、服务层
- 二、连接层
- 三、容器层
- 四、多应用
- 五、集成Spring
第五章中,Spring部分的源码同样是手写,见我另一个仓库:https://github.com/Halfmoonly/handson-spring
与handson-spring
一样,handson-tomcat
依旧采取多分支开发的方式,分支结构如下:
- a-server01:实现一个最简单的静态资源服务器,根据请求返回基本的响应结构
- a-server02:服务器引入
commons-lang3
,自定义动态资源Servlet
,并支持Servlet
内容动态填充 - a-server03:服务器引入
javax.servlet-api
,对用户自定义的Servlet
适配标准的Servlet
规范 - b-connector01:引入
Tomcat
连接层,同时对HttpServer
一拆为二Connector
和Processor
,做到职责分离 - b-connector02:提高服务器性能,实现
Processor
对象池 - b-connector03:进一步提高服务器性能,设计线程
Processor
,同时实现与Connector
线程之间的同步机制 - b-connector04:对
Request
相关的代码适配Servlet
规范,封装RequestLine
并解析请求第一行信息,和DefaultHeaders
请求头信息 - b-connector05:对
Response
相关的代码适配Servlet
规范,并进行响应码,响应头的解析 - b-connector06:门面模式的应用,分别对
HttpRequest
和HttpResponse
适配门面,选择性的隐藏内部细节 - b-connector07:更进一步,对
HttpRequest
进行GET
路径参数,以及POST
请求体的解析,同时改造 SocketInputStream,由继承 InputStream 改为继承 ServletInputStream。使输入流适配Servlet规范 - b-connector08:对请求侧设计
Cookie
,解析请求路径或者请求头Cookie
中的jsessionid
,对服务器设计存储Sessions
集合<jsessionid,session>
- b-connector09:对响应头设计
Set-Cookie
,使之有状态,终于可以把多次没有上下文关联的HTTP
访问视为同一个用户访问。在Response
返回参数中回写Session
信息,使得客户端程序能够接受这个信息,下次请求 Server时携带Session信息 - b-connector10:本节我们简单探讨了一下
Keep-alive
和chunked
模式,让同一个Socket
可以用于多次访问,减少了Socket
的连接和关闭。 - c-container-01:本节初步引入了容器的实现,
ServletContainer
,同时为了后续增强对Servlet生命周期的管理用ServletWrapper代替了Servlet - c-container-02:参考
Tomcat
项目结构,形成了两层容器,ServletContext
(原ServletContainer)和ServletWrapper
,Tomcat
把Wrapper
也看作一种容器,也就是隶属于 Context 之下的子容器(Child Container) - c-container-03:引入逆序职责链模式
Pipeline+Valve
,Valve
设计用于Tomcat
容器间处理流程主机->引擎->应用程序,没有url
模式,所以拦截所有应用程序/请求,不属于Servlet
规范。注意同层容器内可以配置多个Valve
并且是逆序触发的,因此每层容器中的基础阀setBasic
用于触发下层容器执行- 每层容器都通过抽象父类
ContainerBase
组合了StandardPipeline pipeline
,StandardPipeline
代表当前层容器的阀门集合,组合了Valve valves[]
- 父容器
StandardHost
指定基础阀为StandardHostValve
,通过持有的pipeline
触发子容器StandardContext
- 父容器
StandardContext
指定基础阀为StandardContextValve
,通过持有的pipeline
触发最后的容器StandardWrapper
- 父容器
StandardWrapper
指定基础阀为StandardWrapperValve
,通过持有的pipeline
构造和触发后续的过滤器Filter
- 过滤器
Filter
见下面的分支c-container-04
,过滤器之后最终就会抵达用户Servlet
应用
- 每层容器都通过抽象父类
- c-container-04:引入顺序职责链模式
Filter
,Filter
设计主要用于Tomcat
最后应用层面请求和响应处理,支持url-parttern
仅拦截对给定应用程序的请求,属于Servlet
规范 - c-container-05:引入监听器
Listener
,首先定义了事件接口和监听接口,然后在容器Container
启动过程中通过反射提前收集到所有用户配置的监听器实现,最后框架会在合适的位置执行用户的监听逻辑 - d-mapp-01:通过引入更大的容器
StandardHost
,隔离URLClassLoader
与StandardContext
。隔离不同用户的应用路径加载,甚至是同名应用(不同路径代表不同版本:jvm:classloader+classname
)隔离加载 - d-mapp-02:自定义了类加载器用于打破
JVM
默认的双亲委派规则,分别是CommonClassLoader
用于加载lib
目录,以及WebappClassLoader
用于加载用户webapps
目录中的Servlet
- d-mapp-03:引入
server.xml
和web.xml
配置解析,分别管理Host
启动配置与Servlet
加载配置 - e-itg-spring-01:独立服务器
Tomcat
托管Spring
,Spring
通过ServletContextListener
接入Tomcat
,而后DispatcherServlet
接管了所有的Servlet流量。Spring
只是作为webapps
接入Tomcat
,我们暂未考虑Spring
嵌入Tomcat
模式embedded
- 更多分支正在更新中...
main分支包含以上所有功能特性,全量/增量开发文档见docs目录