Tomcat 总体结构

Tomcat运行流程
Connector的工作流程

一.Tomcat 总体结构

tomcat
|---bin Tomcat：存放启动和关闭tomcat脚本；

|---confTomcat：存放不同的配置文件（server.xml和web.xml）；
|---doc：存放Tomcat文档；
|---lib/japser/common：存放Tomcat运行需要的库文件（JARS）；
|---logs：存放Tomcat执行时的LOG文件；
|---src：存放Tomcat的源代码；
|---webapps：Tomcat的主要Web发布目录（包括应用程序示例）；
|---work：存放jsp编译后产生的class文件；

1.Server(服务器)是Tomcat构成的顶级构成元素，所有一切均包含在Server中，Server的实现类StandardServer可以包含一个到多个Services。

2.次顶级元素Service的实现类为StandardService调用了容器(Container)接口，其实是调用了Servlet Engine(引擎)，而且StandardService类中也指明了该Service归属的Server。

3. 连接器(Connector)将Service和Container连接起来，首先它需要注册到一个Service，它的作用就是把来自客户端的请求转发到Container(容器)，这就是它为什么称作连接器的原因。多个Connector可以对应一个Container。

4.接下来次级的构成元素就是容器(Container)，主机(Host)、上下文(Context)和引擎(Engine)均继承自Container接口，所以它们都是容器。但是，它们是有父子关系的，在主机(Host)、上下文(Context)和引擎(Engine)这三类容器中，引擎是顶级容器，直接包含是主机容器，而主机容器又包含上下文容器，所以引擎、主机和上下文从大小上来说又构成父子关系，虽然它们都继承自Container接口。

我们从功能的角度将Tomcat源代码分成5个子模块，它们分别是：

1. Jsper子模块：这个子模块负责jsp页面的解析、jsp属性的验证，同时也负责将jsp页面动态转换为java代码并编译成class文件。在Tomcat源代码中，凡是属于org.apache.jasper包及其子包中的源代码都属于这个子模块；
2. Servlet和Jsp规范的实现模块：这个子模块的源代码属于javax.servlet包及其子包，如我们非常熟悉的javax.servlet.Servlet接口、javax.servet.http.HttpServlet类及javax.servlet.jsp.HttpJspPage就位于这个子模块中；
3. Catalina子模块：这个子模块包含了所有以org.apache.catalina开头的java源代码。该子模块的任务是规范了Tomcat的总体架构，定义了Server、Service、Host、Connector、Context、Session及Cluster等关键组件及这些组件的实现，这个子模块大量运用了Composite设计模式。同时也规范了Catalina的启动及停止等事件的执行流程。从代码阅读的角度看，这个子模块应该是我们阅读和学习的重点。
4. Connectors子模块：如果说上面三个子模块实现了Tomcat应用服务器的话，那么这个子模块就是Web服务器的实现。所谓连接器(Connector)就是一个连接客户和应用服务器的桥梁，它接收用户的请求，并把用户请求包装成标准的Http请求(包含协议名称，请求头Head，请求方法是Get还是Post等等)。同时，这个子模块还按照标准的Http协议，负责给客户端发送响应页面，比如在请求页面未发现时，connector就会给客户端浏览器发送标准的Http 404错误响应页面。
5. Resource子模块：这个子模块包含一些资源文件，如Server.xml及Web.xml配置文件。严格说来，这个子模块不包含java源代码，但是它还是Tomcat编译运行所必需的。 

Tomcat运行流程

假设来自客户的请求为：http://localhost:8080/test/index.jsp

1. 请求被发送到本机端口8080，被在那里侦听的Coyote HTTP/1.1 Connector获得
2. Connector把该请求交给它所在的Service的Engine来处理，并等待Engine的回应
3. Engine获得请求localhost:8080/test/index.jsp，匹配它所有虚拟主机Host
4. Engine匹配到名为localhost的Host（即使匹配不到也把请求交给该Host处理，因为该Host被定义为该Engine的默认主机）
5. localhost Host获得请求/test/index.jsp，匹配它所拥有的所有Context
6. Host匹配到路径为/test的Context（如果匹配不到就把该请求交给路径名为""的Context去处理）
7. path="/test"的Context获得请求/index.jsp，在它的mapping table中寻找对应的servlet
8. Context匹配到URL PATTERN为*.jsp的servlet，对应于JspServlet类
9. 构造HttpServletRequest对象和HttpServletResponse对象，作为参数调用JspServlet的doGet或doPost方法
10. Context把执行完了之后的HttpServletResponse对象返回给Host
11. Host把HttpServletResponse对象返回给Engine
12. Engine把HttpServletResponse对象返回给Connector
13. Connector把HttpServletResponse对象返回给客户browser

二.Container 结构

Container 就是Servlet 容器。

Container是容器的父接口，所有子容器都必须实现这个接口，Container容器的设计用的是典型的责任链的设计模式，它有四个子 容器组件构成，分别是：Engine、Host、Context、Wrapper，这四个组件不是平行的，而是父子关系，Engine包含 Host,Host 包含 Context，Context 包含 Wrapper。通常一个 Servlet class 对应一个 Wrapper，如果有多个 Servlet 就可以定义多个 Wrapper，如果有多 个 Wrapper 就要定义一个更高的Container 了，如 Context， Context 通常就是对应下面这个配置：

 在server.xml 配置：

<Context
 
path="/library"
docBase="D:\projects\library\deploy\target\library.war"
reloadable="true"
/>

三.Connector 

对Connector的配置位于conf/server.xml文件中。

1.一个典型的配置如下：（BIO HTTP/1.1 Connector配置）

<Connector port=”8080” protocol=”HTTP/1.1” maxThreads=”150” 
connectionTimeout=”20000” redirectPort=”8443” >

其它一些重要属性如下：

• acceptCount : 接受连接request的最大连接数目，默认值是10
• address : 绑定IP地址，如果不绑定，默认将绑定任何IP地址
• allowTrace : 如果是true,将允许TRACE HTTP方法
• compressibleMimeTypes : 各个mimeType, 以逗号分隔，如text/html,text/xml
• compression : 如果带宽有限的话，可以用GZIP压缩
• connectionTimeout : 超时时间，默认为60000ms (60s)
• maxKeepAliveRequest : 默认值是100
• maxThreads : 处理请求的Connector的线程数目，默认值为200

如果是SSL配置，如下：

<Connector port="8181" protocol="HTTP/1.1" SSLEnabled="true" 
    maxThreads="150" scheme="https" secure="true" 
    clientAuth="false" sslProtocol = "TLS" 
    address="0.0.0.0" 
    keystoreFile="E:/java/jonas-full-5.1.0-RC3/conf/keystore.jks" 
    keystorePass="changeit" /> 

其中，keystoreFile为证书位置，keystorePass为证书密码。

2. NIO HTTP/1.1 Connector配置

<Connector port=”8080” protocol=”org.apache.coyote.http11.Http11NioProtocol” 
    maxThreads=”150” connectionTimeout=”20000” redirectPort=”8443” >

类图：

Connector工作流程顺序图：

 

Connector的工作流程

我们以Http11AprProtocol为例说明Connector的工作流程。

1. 它将工作委托给NioEndpoint类。在NioEndpoint类的init方法中构建一个SocketServer(当然，不同的实现类会有一些微小的变化，例如如果是NIO，它构建的就是SocketServerChannel)
2. 在NioEndpoint.Acceptor类中会接收一个客户端新的连接请求，如下图：

    

3. 在NioEndpoint类中，有一个内部接口Handle，该接口定义如下：

    

4. 在Http11NioProtocol类中实现了Handle这个内部接口，并调用Http11NioProcessor类(该类实现了ActionHook回调接口)。在Response类中会调用ActionHook实现类的相关方法的，Response类的action方法如下：

    

5. Http11NioProcessor的process实现方法中，会通过Adapter来调用Servler容器生成响应结果。

一、Tomcat背景
　　自从JSP发布之后，推出了各式各样的JSP引擎。Apache Group在完成GNUJSP1.0的开发以后，开始考虑在SUN的JSWDK基础上开发一个可以直接提供Web服务的JSP服务器，当然同时也支持Servlet, 这样Tomcat就诞生了。Tomcat是jakarta项目中的一个重要的子项目，其被JavaWorld杂志的编辑选为2001年度最具创新的java产品，同时它又是sun公司官方推荐的servlet和jsp容器，因此其越来越多的受到软件公司和开发人员的喜爱。servlet和jsp的最新规范都可以在tomcat的新版本中得到实现。其次，Tomcat是完全免费的软件，任何人都可以从互联网上自由地下载。Tomcat与Apache的组合相当完美。

 

三、Tomcat类加载

    Bootstrap($JAVA_HOME/jre/lib/ext/*.jar)
System($CLASSPATH/*.class和指定的jar)
Common($CATALINA_HOME/common 下的classes,lib,endores三个子目录)
Catalina ($CATALINA_HOME/server/下的classes和lib目录仅对Tomcat可见)
&Shared($CATALINA_HOME/shared/下的classes和lib目录以及$CATALINA_HOME/lib目录)仅对Web应用程序可见,对Tomcat不可见WebApp($WEBAPP/Web-INF/*仅对该WEB应用可见classes/*.classlib/*.jar)

加载类和资源的顺序为：
1、/Web-INF/classes

2、/Web-INF/lib/*.jar

3、Bootstrap

4、System

5、$CATALINA_HOME/common/classes
6、$CATALINA_HOME/common/endores/*.jar

7、$CATALINA_HOME/common/lib/*.jar

8、$CATALINA_HOME/shared/classes
9、$CATALINA_HOME/shared/lib/*.jar  

四、server.xml配置简介：

下面讲述这个文件中的基本配置信息，更具体的配置信息请参考tomcat的文档：
    server:          1、port 指定一个端口，这个端口负责监听关闭tomcat的请求
          2、shutdown 指定向端口发送的命令字符串
    service:          1、name 指定service的名字
    Connector (表示客户端和service之间的连接)：
          1、port 指定服务器端要创建的端口号，并在这个断口监听来自客户端的请求
          2、minProcessors 服务器启动时创建的处理请求的线程数
          3、maxProcessors 最大可以创建的处理请求的线程数
          4、enableLookups 如果为true，则可以通过调用request.getRemoteHost()进行DNS查

询来得到远程客户端的实际主机名，若为false则不进行DNS查询，而是返回其ip地址
          5、redirectPort 指定服务器正在处理http请求时收到了一个SSL传输请求后重定向的端口号
          6、acceptCount 指定当所有可以使用的处理请求的线程数都被使用时，可以放到处理

队列中的请求数，超过这个数的请求将不予处理
          7、connectionTimeout 指定超时的时间数(以毫秒为单位)
    Engine(表示指定service中的请求处理机，接收和处理来自Connector的请求)：
          1、defaultHost 指定缺省的处理请求的主机名，它至少与其中的一个host元素的name属性值是一样的
    Context (表示一个web应用程序)：
          1、docBase 应用程序的路径或者是WAR文件存放的路径
          2、path 表示此web应用程序的url的前缀，这样请求的url为http://localhost:8080/path/****
          3、reloadable 这个属性非常重要，如果为true，则tomcat会自动检测应用程序的/WEB-INF/lib 和/WEB-INF/classes目录的变化，自动装载新的应用程序，我们可以在不重起tomcat的情况下改变应用程序
    host (表示一个虚拟主机)：
          1、name 指定主机名
          2、appBase 应用程序基本目录，即存放应用程序的目录
          3、unpackWARs 如果为true，则tomcat会自动将WAR文件解压，否则不解压，直接

从WAR文件中运行应用程序
    Logger (表示日志，调试和错误信息)：
          1、className 指定logger使用的类名，此类必须实现org.apache.catalina.Logger 接口
          2、prefix 指定log文件的前缀
          3、suffix 指定log文件的后缀
          4、timestamp 如果为true，则log文件名中要加入时间，如下例:localhost_log.2001-10-04.txt
  Realm (表示存放用户名，密码及role的数据库)：
          1、className 指定Realm使用的类名，此类必须实现org.apache.catalina.Realm接口
   Valve (功能与Logger差不多，其prefix和suffix属性解释和Logger 中的一样)：
          1、className 指定Valve使用的类名，如用org.apache.catalina.valves.AccessLogValve类可以记录应用程序的访问信息
    directory（指定log文件存放的位置）：
    1、pattern 有两个值，common方式记录远程主机名或ip地址，用户名，日期，第一行请求的字符串，HTTP响应代码，发送的字节数。combined方式比common方式记录的值更多

 

五、web.xml配置简介：

1、默认(欢迎)文件的设置

 在tomcat4\conf\web.xml中，<welcome-file-list>与IIS中的默认文件意思相同。

 <welcome-file-list>

 <welcome-file>index.html</welcome-file>

 <welcome-file>index.htm</welcome-file>

 <welcome-file>index.jsp</welcome-file>

 </welcome-file-list> 

2、报错文件的设置

<error-page>

<error-code>404</error-code>

<location>/notFileFound.jsp</location>

</error-page>

<error-page>

<exception-type>java.lang.NullPointerException</exception-type>

<location>/null.jsp</location>

</error-page>

如果某文件资源没有找到，服务器要报404错误，按上述配置则会调用\webapps\ROOT\notFileFound.jsp。

如果执行的某个JSP文件产生NullPointException ，则会调用\webapps\ROOT\null.jsp

 

3、会话超时的设置

设置session 的过期时间，单位是分钟；

<session-config>

<session-timeout>30</session-timeout>

</session-config>

 

4、过滤器的设置

<filter>

<filter-name>FilterSource</filter-name>

<filter-class>project4. FilterSource</filter-class>

</filter>

<filter-mapping>

<filter-name>FilterSource</filter-name>

<url-pattern>/WwwServlet</url-pattern>

(<url-pattern>/haha/*</url-pattern>)

</filter-mapping>

 

过滤：

1) 身份验证的过滤Authentication Filters

2) 日志和审核的过滤Logging and AuditingFilters

3) 图片转化的过滤Image conversionFilters

4) 数据压缩的过滤Data compressionFilters

5) 加密过滤Encryption Filters

6) Tokenizing Filters

7) 资源访问事件触发的过滤Filters that triggerresource access events XSL/T 过滤XSL/T filters

9) 内容类型的过滤Mime-type chain Filter 注意监听器的顺序，如：先安全过滤，然后资源，

然后内容类型等，这个顺序可以自己定。

 

六、管理
    1、用户配置
      在进行具体Tomcat管理之前，先给tomcat添加一个用户，使这个用户有权限来进行管理。
      打开conf目录下的tomcat-users.xml文件，在相应的位置添加下面一行：
    <user name="user"password="user" roles="standard,manager"/>
    然后重起tomcat，在浏览器中输入http://localhost:8080/manager/，会弹出对话框，输入上面的用户

名和密码即可。     2、应用程序列表
      在浏览器中输入http://localhost:8080/manager/list，浏览器将会显示如下的信息：
    OK - Listed applications for virtualhost localhost
    /ex:running:1
    /examples:running:1
    /webdav:running:0
    /tomcat-docs:running:0
    /manager:running:0
    /:running:0
     上面显示的信息分别为：应用程序的路径、当前状态、连接这个程序的session数  3、重新装载应用程序
      在浏览器中输入http://localhost:8080/manager/reload?path=/examples，浏览器显示如下：
    OK - Reloaded application at contextpath /examples    

这表示example应用程序装载成功，如果我们将server.xml的Context元素的reloadable属性设为true，则没必要利用这种方式重新装载应用程序，因为tomcat会自动装载。

 

4、显示session信息
    在浏览器中输入http://localhost:8080/manager/sessions?path=/examples，浏览器显示如下：
    OK - Session information for application at contextpath /examples Default maximum session inactive

interval 30 minutes 5、启动和关闭应用程序
   在浏览器中输入http://localhost:8080/manager/start?path=/examples和

http://localhost:8080/manager/stop?path=/examples分别启动和关闭examples应用程序。

 

  注意：    
  1：经过我测试，我设置Context   的path="",reloadable=true，然后放一个WAR文件到webapps目录，结果tomcat不能检测出此文件(重起tomcat可以)，而把此文件解压，则tomcat会自动检测出这个新的应用程序。如果不能自动检测WAR文件，我们可以利用下面管理中讲的方法来部署应用程序。    
   
  2：默认的server.xml中，Realm元素只设置了一个className属性，但此文件中也包含几个通过JDBC连接到数据库进行验证的示例(被注释掉了)，通过Realm元素我们可以实现容器安全管理(Container   Managed   Security)。    
   
  3：还有一些元素我们没有介绍，如Parameter，loader，你可以通过tomcat的文档获取这些元素的信息。   

三)：管理       
  1：配置    
  在进行具体的管理之前，我们先给tomcat添加一个用户，使这个用户有权限来进行管理。   
  打开conf目录下的tomcat-users.xml文件，在相应的位置添加下面一行：  
  注意：这一行的最后部分一定是/>,tomcat的文档掉了/符号，如果没有/符号的话，tomcat重起时将无法访问应用程序。通过logs/catalina.out文件你可以看到这个错误的详细信息。      
  然后重起tomcat，在浏览器中输入http://localhost:8080/manager/，会弹出对话框，输入上面的用户名和密码即可。   
  2：应用程序列表    
  在浏览器中输入http://localhost:8080/manager/list，浏览器将会显示如下的信息：   
  OK   -   Listed   applications   for   virtual  host   localhost    
  /ex:running:1    
  /examples:running:1    
  /webdav:running:0    
  /tomcat-docs:running:0    
  /manager:running:0    
  /:running:0      
  上面的信息分别为应用程序的路径，当前状态(running   或者stopped)，与这个程序相连的session数。    
  3：重新装载应用程序    
  在浏览器中输入  http://localhost:8080/manager/reload?path=/examples，浏览器显示如下：  
  OK   -   Reloaded   application   at   context  path   /examples       
  表示example应用程序装载成功，如果我们将server.xml的Context元素的reloadable属性设为true(见上面表格)，则没必要利用这种方式重新装载应用程序，因为tomcat会自动装载。     
  4：显示session信息   
  在浏览器中输入http://localhost:8080/manager/sessions?path=/examples，浏览器显示如下：   
  OK   -   Session   information   for  application   at   context   path   /examples  Default   maximum   session   inactive   interval   30  minutes       
  5：启动和关闭应用程序    
  在浏览器中输入http://localhost:8080/manager/start?path=/examples和http://localhost:8080/manager/stop?path=/examples分别启动和关闭examples应用程序。   
  6：部署及撤销部署    
  WAR有两种组织方式，一种是按一定的目录结构组织文件，一种是一个后缀为WAR的压缩包，因此它的部署方式也有两种：    
  (1)：在浏览器中输入：http://localhost:8080/manager/install?path=/examples&war=file:/c:examples   
  就会将按目录结构组织的WAR部署   
   
  (2)：如果输入:http://localhost:8080/manager/install?path=/examples&war=jar:file:/c:examples.war!/   
  就会将按压缩包组织的WAR部署，注意此url后半部分一定要有!/号。    
  部署后就可以用   http://localhost:8080/examples访问了。   
  在浏览器中输入：http://localhost:8080/manager/remove?path=/examples  就会撤销刚才部署的应用程序。   
  (四)：与apache集成    
  虽然tomcat也可以作web服务器,但其处理静态html的速度比不上apache,且其作为web服务器的功能远不如apache,因此我们想把apache和tomcat集成起来。   
  我们以linux系统为例介绍.   
  从apache网站下载apache1.3.22源代码版本，然后使用如下命令配置安装apache：  
  mkdir   /usr/local/apache    
  tar   zxvf   apache.1.32.tar.gz    
  cd   apache.1.32    
  ./configure   --prefix=/usr/local/apache   --enable-module=so   
  make    
  make   install    

  注意configure命令指定目标安装目录，并且加入DSO(Dynamic   Shared   Object)支持，注意一定不要忘了这一个选项。    
   
  然后下载webapp模块，将解压后mod_webapp.so文件放入apache的libexec目录，编辑apache的conf目录下的httpd.conf，在这个文件的最后加入下面三行：      
  LoadModule   webapp_module   libexec/mod_webapp.so   
  WebAppConnection   warpConnection   warp   localhost:8008   
  WebAppDeploy   examples   warpConnection   /examples/    
  第一行是加入webapp模块，如果编译apache时不增加DSO支持，则无法使用LoadModule指令，第二行指定tomcat与apache的连接，第三行指定部署那个应用，这两个指令使用格式如下：   
  WebAppConnection   [connection   name]   [provider]  [host:port]    
  WebAppDeploy   [application   name]   [connection  name]   [url   path]       
  其中connection   name指定连接名，provider只能是warp，port端口与你的tomcat的配置文件server.xml最后几行指定的要保持一致。文件如下：      
  port="8008"   minProcessors="5"  maxProcessors="75"    
  enableLookups="true"    
  acceptCount="10"   debug="0"/>    
  ******       
  application   name与你在tomcat中部署的应用名一致，url   path指定访问这个应用的url。例如上面的例子可以通过http://localhost/examples/来访问tomcat中的examples应用。  

  (五)：中文问题   
  一般jsp的乱码问题可以通过在jsp中加入来解决，至于servlet的乱码在可以使用servlet2.3中提供的HttpServeletRequest.setCharacterEncoding函数。更详细的中文问题请见JSP/Servlet  中的汉字编码问题。       
  四：综述    
  tomcat作为一个servlet(jsp也被编译为servlet执行)容器，其应用前景是非常好的，如果与jboss结合起来，则可以实现sun的j2ee规范(用jboss作ejb服务器)。jboss的官方网站也提供集成了tomcat3.2*的jboss以供下载。另外一个开源的应用服务器(enhydra)  也是基于tomcat的，其提供了更友好的管理界面，部署应用程序也更简单，功能也更强大。

1 - Tomcat Server的组成部分

1.1 - Server

A Server element represents the entire Catalina servletcontainer. (Singleton)

1.2 - Service

A Service element represents the combination of one ormore Connector components that share a single Engine
Service是这样一个集合：它由一个或者多个Connector组成，以及一个Engine，负责处理所有Connector所获得的客户请求

1.3 - Connector

一个Connector将在某个指定端口上侦听客户请求，并将获得的请求交给Engine来处理，从Engine处获得回应并返回客户
TOMCAT有两个典型的Connector，一个直接侦听来自browser的http请求，一个侦听来自其它WebServer的请求
Coyote Http/1.1 Connector 在端口8080处侦听来自客户browser的http请求
Coyote JK2 Connector 在端口8009处侦听来自其它WebServer(Apache)的servlet/jsp代理请求

1.4 - Engine

The Engine element represents the entire requestprocessing machinery associated with a particular Service
It receives and processes all requests from one or more Connectors
and returns the completed response to the Connector for ultimate transmissionback to the client
Engine下可以配置多个虚拟主机Virtual Host，每个虚拟主机都有一个域名
当Engine获得一个请求时，它把该请求匹配到某个Host上，然后把该请求交给该Host来处理
Engine有一个默认虚拟主机，当请求无法匹配到任何一个Host上的时候，将交给该默认Host来处理

1.5 - Host

代表一个VirtualHost，虚拟主机，每个虚拟主机和某个网络域名Domain Name相匹配
每个虚拟主机下都可以部署(deploy)一个或者多个WebApp，每个Web App对应于一个Context，有一个Context path
当Host获得一个请求时，将把该请求匹配到某个Context上，然后把该请求交给该Context来处理
匹配的方法是“最长匹配”，所以一个path==""的Context将成为该Host的默认Context
所有无法和其它Context的路径名匹配的请求都将最终和该默认Context匹配

1.6 - Context

一个Context对应于一个Web Application，一个WebApplication由一个或者多个Servlet组成
Context在创建的时候将根据配置文件$CATALINA_HOME/conf/web.xml和$WEBAPP_HOME/WEB-INF/web.xml载入Servlet类
当Context获得请求时，将在自己的映射表(mappingtable)中寻找相匹配的Servlet类
如果找到，则执行该类，获得请求的回应，并返回。