Contents
  1. 1. Tomcat server 的内部结构
  2. 2. server的初始化和启动
  3. 3. http请求的处理
  4. 4. Request请求的转发处理
  5. 5. 设计模式
  6. 6. 参考链接

这两周主要看了下Tomcat7的源代码,若有所悟,遂写下本篇文章记录下我对Tomcat部分核心功能的理解,主要包括以下3个方面

  1. Tomcat是如何启动的
  2. 一次http请求,是如何转换成Request对象
  3. 从Request对象的生成到Request对象传递给Filter或者servlet,中间做了什么处理

Tomcat server 的内部结构

Alt text

默认情况下Server组件会包含一个service组件,service组件会包含Engine和Connector组件,Engine组件会包含host组件,host组件会包含Context组件

首先我们要看一下这几个组件各自的功能

  1. Server
    它代表整个容器,是 Tomcat 实例的顶层元素.由 org.apache.catalina.Server 接口来定义. 它用来控制 Tomcat 实例的启动与停止。在 Tomcat 启动阶段,通过 server 来控制的各 个 service 的启动。启动完成后它启动独立的端口监听,用来接收 Tomcat 的停止命令。 当接收到停止命令后它会触发 service 的停止与注销。并提供一个接口让其它程序能够访 问到这个 Service 集合、同时要维护它所包含的所有 Service 的生命周期,包括服务 初始化、服务终结、Service 定位与查找

  2. Service
    Service 是一个抽象的服务封装组件,是 web 容器的一个独立的运行单元。它具备了一个 web 容器所需要的监听连接,servlet 查找与调用,Session 创建与管理,日志服务等常用 功能。Service 只是在 Connector 和 Container 外面多包一层,把它们组装在一起,向外 面提供服务,一个 Service 可以设置多个 Connector,但是只能有一个 Engine Container 容器,将多个 Connector 收到的连接发送到同一个 Engine Container 进行处理,在tomcat中默认有两个connector,一个负责Http请求的处理,另一个负责AJP请求的处理

  3. Connector
    主要负责服务器的端口监听、接收浏览 器的发过来的 TCP 连接请求,将收到的 HTTP 请求信息转换成 Request 对象,并将 Request 提交 Engine 组件去执行,将执行完成后所得到的 Response 对象转换 HTTP 的响应信息返回 给浏览器。

  4. Engine
    Engine是Servlet处理器的一个实例,即servlet引擎, 一个Engine可以包含多个host

  5. host
    Engine容器中用于接收请求并进行相应处理的主机或虚拟主机,一个host可以对应多个Context

  6. Context
    每一个webapp最终都是以Context的形式存在,每个Context对应一个根路径和请求URL路径,host:port/path

每个组件的包含关系已经在server.xml中进行了对应的声明,在整个server初始化的过程中,会解析该文件生成对应的组件对象并确定组件之间的包含关系, server.xml 核心代码如下所示

<Server port="8005" shutdown="SHUTDOWN">
<Service name="Catalina">        

            <Connector port="8080" protocol="HTTP/1.1"
           connectionTimeout="20000"
           redirectPort="8443" />
           <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" />
           <Engine name="Catalina" defaultHost="localhost">
             <Host name="localhost"  appBase="webapps"
        unpackWARs="true" autoDeploy="true">
          <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs"
           prefix="localhost_access_log." suffix=".txt"
           pattern="%h %l %u %t &quot;%r&quot; %s %b" />

  </Host>
</Engine>
  </Service>
</Server>

server的初始化和启动

在整个server的启动过程中,首先要确定一个LifeCycle生命周期的概念
Alt text
每个组件都会直接或间接继承抽象类LifecycleBase,LifecycleBase会实现Lifecycle接口,实现了init(),start(),stop(),destroy()等模板方法,在对应模板方法中会调用相应的抽象方法诸如initInternal,startInternal()等,这样保证了tomcat能统一管理所有组件的生命周期

server的启动是从BootStrap的main方法开始
Alt text

主要代码是如下3句代码

bootstrap.init() 

该行代码主要做了以下几件事

  1. 设置catalina.home、catalina.base系统属性
  2. 创建commonLoader、catalinaLoader、sharedLoader类加载器
  3. 初始化Bootstrap对象

    daemon.load(args);
    

主要干了两件事

  1. 创建一个Digester对象,将当前对象压入Digester里的对象栈顶,根据inputSource里设置的文件xml路径及所创建的Digester对象所包含的解析规则生成相应对象,并调用相应方法将对象之间关联起来。
  2. 依次调用每个组件的init方法

     daemon.start();
    

该代码会链式调用每个组件的start()方法,在start方法中对调对应的startInternal方法

在这里要重点讲一下Connector,Tomcat默认会开启两个Http8080端口接收http请求,和AJP8009端口接收ajp请求
Connector会有一个JIOEndpoint对象
JIoEndpoint:处理请求的TCP链接,一个监听器线程拿到一个socket,并创建工作线程来处理该请求,更高级的Endpoint会使用队列复用线程

在JIOEndpoint的startInternal方法中会开启两个线程一个是Acceptor线程监听tcp/ip连接并传递给对应的processor和一个异步超时的线程,如下图429行和432行所示
Alt text

当整个tomcat启动会有如下几个线程在运行,其中除了main以外其他都为守护线程
Alt text

http请求的处理

前面提到了Acceptor线程是监听tcp/ip链接,我们看一下具体代码如下图所示,216行从serversocket获取连接请求,231行会调用processSocket处理该请求

Alt text

JIoEndpoint中的processSocket方法会新开一个线程处理请求,保证当前线程不会被阻塞,如528行所示
Alt text

SocketProcessor会调用AbstractConnectionHandler的process方法,该方法会调用AbstractHttp11Processor的process方法, 在该方法中会解析请求的请求行,请求头部并封装成Tomcat内置对象org.apache.coyote.Request,整个处理流程的时序图如下所示
Alt text

Request请求的转发处理

Alt text
这张图描述当用户发出的请求被解析成Request对象后,会被protocolHandler传递给Engine的Pipeline的ValueA,然后传递给ValueB,EngineValue以此类推最终会传递给context的FilterChain和Servlet,在servlet中生成的response会逆向进行传递直至传给protocolHandler
Alt text

在StandardWrapperValue的invoke方法中会将request请求传递给FilterChain处理如下图205行所示
Alt text

ApplicationFilterChain的doFilter()方法
Alt text

在doFilter方法中会调用internalDoFilter方法,如果filterChain还有下一个filter,则调用下一个filter的doFilter方法,若当前filter为最后一个filter,则会调用servlet的service方法如下图305行所示
Alt text

在整个Request传递处理的过程中我们会注意到有一个叫Value的对象,Tomcat7中一个管道pipeline可以包含多个阀(Valve),这些阀共分为两类,一类叫基础阀(通过getBasic、setBasic方法调用),一类是普通阀(通过addValve、removeValve调用)。管道都是包含在一个容器当中,所以API里还有getContainer和setContainer方法。一个管道一般有一个基础阀(通过setBasic添加),可以有0到多个普通阀(通过addValve添加)。
所有的阀类都会实现org.apache.catalina.Valve这个接口

这里可以看出容器内的Engine、Host、Context、Wrapper容器组件的实现的共通点:
1.这些组件内部都有一个成员变量pipeline,因为它们都是从org.apache.catalina.core.ContainerBase类继承来的,pipeline就定义在这个类中。所以每一个容器内部都关联了一个管道。
2.都是在类的构造方法中设置管道内的基础阀。
3.所有的基础阀的实现最后都会调用其下一级容器(直接从请求中获取下一级容器对象的引用)的getPipeline().getFirst().invoke()方法,直到Wrapper组件。因为Wrapper是对一个Servlet的包装,所以它的基础阀内部调用的过滤器链的doFilter方法和Servlet的service方法。

自此对于服务器的启动,以及浏览器发出一次socket连接请求之后,tomcat容器内部的运转处理流程已经有了一个大致的理解

设计模式

可以想象Tomcat源代码运用了大量的设计模式来组织自己的代码使代码有更好的可读性,程序有更好地扩展性,其中Tomcat源代码主要运用了以下几个设计模式

  1. facade门面模式:在一个大的系统中有多个子系统时,子系统如果不想暴露自己的内部数据给其他系统,那么就可以设计一个门面,把对象封装起来,其他系统通过该门面访问对应对象的数据,其中对Request,Response的封装,以及ApplcationContext到ServletContext的封装都用到了该模式
  2. 观察者设计模式:也叫发布-订阅模式,也就是事件监听机制,通常在某个事件发生的前后会触发一些操作,其中控制组件生命周期的Lifecycle就是这种模式的体现。LifecycleListener代表的是抽象观察者,定义了一个lifecycleEvent方法,该方法就是当主题发生变化时要执行的方法,当组件的生命周期发生变化时,会调用LifecycleSupport的fireLifecycleEvent方法,该方法调用所有监听者的lifecycleEvent方法
    Alt text
  3. Command命令:主要用来封装命令,把发出命令的责任和执行命令的责任分开,在tomcat中connector和container之间,server创建HttpConnector对象,然后创建命令HttpProcessor对象,并把它交给ContainerBase容器进行处理,这样ContainerBase可以通过不同的方式来处理请求
  4. 责任链:这个设计模式也是Tomcat中Container设计的基础,整个容器就是通过一个链连接在一起的,这个链一直将请求正确地传递给最终处理请求的那个servlet。责任链模式实际上是很多对象由每个对象对其下家的引用而连接起来形成的一条链,请求在这条链上传递,在tomcat中,请求从Engine到host在到context一直到Wrapper都是通过这条链进行传递
  5. 模板方法: 当我们知道一个算法的所有步骤以及每个步骤的执行顺序,但是不知道所有步骤具体如何执行。模板方法模式会将不知道如何执行的步骤封装成abstract method, 并提供抽象类来控制工作流(即为模板方法,被声明为final,子类无法覆盖),具体实现类会实现具体的abstract method来实现特定的执行步骤。在tomcat中整个server组件的启动运用了模板方法,在LifecycleBase中init()中控制了组件的初始化流程,并会调用抽象方法initInternal(),该方法会有具体的实现类来实现以此调用组件特定的初始化方法
    Alt text

参考链接

  1. Tomcat7源码解析
  2. How Tomcat Works
  3. 深入分析Java Web技术内幕
Contents
  1. 1. Tomcat server 的内部结构
  2. 2. server的初始化和启动
  3. 3. http请求的处理
  4. 4. Request请求的转发处理
  5. 5. 设计模式
  6. 6. 参考链接