【转】Tomcat总体结构（Tomcat源代码阅读系列之二）

川长思鸟来 2021-12-24 02:27 286阅读 0赞

本文是[Tomcat源代码阅读系列][Tomcat]的第二篇文章，我们在本系列的第一篇文章：[在IntelliJ IDEA 和 Eclipse运行tomcat 7源代码][IntelliJ IDEA _ Eclipse_tomcat 7]一文中介绍了如何在intelliJ IDEA 和 Eclipse中运行Tomcat源代码，本文介绍一下Tomcat的总体结构。

> 本文没有特别指明的地方，源代码都是针对tomcat7.0.42来说。

# Tomcat的总体结构 #

Tomcat即是一个Http服务器也是一个Servlet容器，它的总体结构我们可以用下图来描述：

[![TomcatArchitecture.png][]][TomcatArchitecture.png]通过上图我们可以看出Tomcat中主要涉及Server,Service,Engine,Connector,Host,Context组件，之前用过Tomcat的童鞋是不是觉得这些组件的名称有点似曾相识的赶脚，没赶脚？！您再想想。好吧，不用你想了，我来告诉你吧。其实在Tomcat二进制分发包解压后,在conf目录中有一个server.xml文件，你打开它瞄两眼看看，是不是发现server.xml文件中已经包含了上述的几个名称。我拿我本地Tomcat7.0.42分发包中的server.xml来具体分析一下，它的内容如下：

<?xml version='1.0' encoding='utf-8'?>
    
    
    <Server port="8005" shutdown="SHUTDOWN">
      
      
      <Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
      
      <Listener className="org.apache.catalina.core.JasperListener" />
      
      <Listener className="org.apache.catalina.core.JreMemoryLeakPreventionListener" />
      <Listener className="org.apache.catalina.mbeans.GlobalResourcesLifecycleListener" />
      <Listener className="org.apache.catalina.core.ThreadLocalLeakPreventionListener" />
    
      
      <GlobalNamingResources>
        
        <Resource name="UserDatabase" auth="Container"
                  type="org.apache.catalina.UserDatabase"
                  description="User database that can be updated and saved"
                  factory="org.apache.catalina.users.MemoryUserDatabaseFactory"
                  pathname="conf/tomcat-users.xml" />
      </GlobalNamingResources>
    
      
      <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">
    
          
          
    
          
          <Realm className="org.apache.catalina.realm.LockOutRealm">
            
            <Realm className="org.apache.catalina.realm.UserDatabaseRealm"
                   resourceName="UserDatabase"/>
          </Realm>
    
          <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 "%r" %s %b" />
    
          </Host>
        </Engine>
      </Service>
    </Server>

接下来我们就根据上图以及conf/server.xml的内容来一步步描述一下上面所说的各种组件吧。

## Server ##

首先闪联登场的是咋们的Server大哥（大家能给点掌声吗？），Server是Tomcat中最顶层的组件，它可以包含多个Service组件。在Tomcat源代码中Server组件对应源码中的`org.apache.catalina.core.StandardServer`类。StandardServer的继承关系图如下图所示：[![StandardServer.jpg][]][StandardServer.jpg]

## Service ##

接下来咋们来看看Service组件，Service组件相当于Connetor和Engine组件的包装器，它将一个或者多个Connector组件和一个Engine建立关联。缺省的的配置文件中，定义一个叫`Catalina`的服务，并将Http,AJP这两个Connector关联到了一个名为`Catalina`的Engine.Service组件对应Tomcat源代码中的`org.apache.catalina.core.StandardService`,StandardService的继承关系图如下图所示：[![StandardService.png][]][StandardService.png]

## Connector ##

既然Tomcat需要提供http服务，而我们知道http应用层协议最终都是需要通过TCP层的协议进行包传递的，而Connector正是Tomcat中监听TCP网络连接的组件，一个Connector会监听一个独立的端口来处理来自客户端的连接。缺省的情况下Tomcat提供了如下两个Connector。我们分别描述一下：

1.  HTTP/1.1  
    `<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" />` 上面定义了一个Connector，它缺省监听端口8080,这个端口我们可以根据具体情况进行改动。`connectionTimeout`定义了连接超时时间，单位是毫秒，`redirectPort`定义了ssl的重定向接口，根据缺省的配置，Connector会将ssl请求重定向到8443端口。
2.  AJP/1.3  
    AJP表示`Apache Jserv Protocol`,此连接器将处理Tomcat和Aapache http服务器之间的交互，这个连机器是用来处理我们将Tomcat和Apache http服务器结合使用的情况。假如在同样的一台物理Server上面部署了一台Apache http服务器和多台Tomcat服务器，通过Apache服务器来处理静态资源以及负载均衡的时候，针对不同的Tomcat实例需要AJP监听不同的端口。

Connector对应源代码中的`org.apache.catalina.connector.Connector`,它的继承关系图如下所示：[![Connector.png][]][Connector.png]

## Engine ##

Tomcat中有一个容器的概念，而Engine,Host,Context都属于Contanier，我们先来说说最顶层的容器Engine.  
一个Engine可以包含一个或者多个Host,也就是说我们一个Tomcat的实例可以配置多个虚拟主机。  
缺省的情况下`<Engine name="Catalina" defaultHost="localhost">`定义了一个名称为Cataline的Engine.Engine对应源代码中的`org.apache.catalina.core.StandardEngine`，它的继承关系图如下图所示：[![StandardEngine.png][]][StandardEngine.png]

## Host ##

Host定义了一个虚拟主机，一个虚拟主机可以有多个Context，缺省的配置如下：  
`<Host name="localhost" appBase="webapps" unpackWARs="true" autoDeploy="true">….</Host>` 其中`appBase`为webapps，也就是`<CATALINA_HOME>\webapps`目录，`unpackingWARS`属性指定在appBase指定的目录中的war包都自动的解压，缺省配置为true,`autoDeploy`属性指定是否对加入到appBase目录的war包进行自动的部署，缺省为true.  
Host对应源代码中的`org.apache.catalina.core.StandardHost`,它的继承关系图如下所示：[![StandardHost.png][]][StandardHost.png]

## Context ##

在Tomcat中，每一个运行的webapp其实最终都是以Context的形成存在，每个Context都有一个根路径和请求URL路径，Context对应源代码中的`org.apache.catalina.core.StandardContext`,它的继承关系图如下图所示：[![StandardContext.png][]][StandardContext.png]在Tomcat中我们通常采用如下的两种方式创建一个Context.下面分别描述一下：

1.  在`<CATALINA-HOME>\webapps`目录中创建一个目录，这个时候将**自动创建一个context**，默认context的访问url为`http://host:port/dirname`,你也可以通过在`ContextRoot\META-INF`中创建一个context.xml的文件，其中包含如下的内容来指定应用的访问路径。 `<Context path="/yourUrlPath" />`
2.  conf\\server.xml文件中增加context元素。 第二种创建context的方法，我们可以选择在server.xml文件的`<Host>`元素，比如我们在server.xml文件中增加如下内容：

server.xml

......
        ......
        <Context path="/mypath" docBase="/Users/tiger/develop/xxx" reloadable="true">
        </Context>
      </Host>
    </Engine>
      </Service>
    </Server>

这样的话，我们就可以通过`http://host:port/mypath`访问上面配置的context了。

## Valve ##

Valve中文意思是阀门，Valve是Tomcat中责任链模式的实现，通过链接多个Valve对请求进行处理。其中Valve可以定义在任何的Container中，上面说的Engine,Host,Context都属于容器。tomcat 默认定义了一个名为`org.apache.catalina.valves.AccessLogValve`的Valve,这个Valve负责拦截每个请求，然后记录一条访问日志。

通过上面的分析，我们发现Server,Service,Engine,Host,Context都实现了`org.apache.catalina.Lifecycle`接口，通过这个接口管理了这些核心组件的生命周期，关于这些组件的生命周期，我们在下一篇文章描述。

Reference：

[Tomcat总体结构 （Tomcat源代码阅读系列之二）][Tomcat_ _Tomcat]

转载于:https://www.cnblogs.com/549294286/p/3708609.html

[Tomcat]: http://imtiger.net/blog/2013/10/08/tomcat-source-code-study/
[IntelliJ IDEA _ Eclipse_tomcat 7]: http://imtiger.net/blog/2013/10/14/run-tomcat-in-idea-or-eclipse/
[TomcatArchitecture.png]: http://imtiger.net/images/2013/10/16/TomcatArchitecture.png
[StandardServer.jpg]: http://imtiger.net/images/2013/10/16/StandardServer.jpg
[StandardService.png]: http://imtiger.net/images/2013/10/16/StandardService.png
[Connector.png]: http://imtiger.net/images/2013/10/16/Connector.png
[StandardEngine.png]: http://imtiger.net/images/2013/10/16/StandardEngine.png
[StandardHost.png]: http://imtiger.net/images/2013/10/16/StandardHost.png
[StandardContext.png]: http://imtiger.net/images/2013/10/16/StandardContext.png
[Tomcat_ _Tomcat]: http://imtiger.net/blog/2013/10/16/tomcat-architecture/