Tomcat处理HTTP请求源码分析（上）
fmms
13年前
<p>很多开源应用服务器都是集成tomcat作为web container的，而且对于tomcat的servlet container这部分代码很少改动。这样，这些应用服务器的性能基本上就取决于Tomcat处理HTTP请求的connector模块的性能。本文首 先从应用层次分析了tomcat所有的connector种类及用法，接着从架构上分析了connector模块在整个tomcat中所处的位置，最后对 connector做了详细的源代码分析。并且我们以Http11NioProtocol为例详细说明了tomcat是如何通过实现 ProtocolHandler接口而构建connector的。</p> <h2>1 Connector介绍</h2> <h3>1.1 Connector的种类</h3> <p>Tomcat源码中与connector相关的类位于org.apache.coyote包中，Connector分为以下几类：</p> <ul> <li>Http Connector, 基于HTTP协议，负责建立HTTP连接。它又分为BIO Http Connector与NIO Http Connector两种，后者提供非阻塞IO与长连接Comet支持。</li> <li>AJP Connector, 基于AJP协议，AJP是专门设计用来为tomcat与http服务器之间通信专门定制的协议，能提供较高的通信速度和效率。如与Apache服务器集成时，采用这个协议。</li> <li>APR HTTP Connector, 用C实现，通过JNI调用的。主要提升对静态资源（如HTML、图片、CSS、JS等）的访问性能。现在这个库已独立出来可用在任何项目中。Tomcat在配置APR之后性能非常强劲。</li> </ul> <h3>1.2 Connector的配置</h3> <p>对Connector的配置位于conf/server.xml文件中。</p> <h4>1.2.1 BIO HTTP/1.1 Connector配置</h4> <p>一个典型的配置如下：</p> <pre> <connector protocol="”<b" port="”8080”"> HTTP/1.1” maxThreads=”150” connectionTimeout=”20000” redirectPort=”8443” </connector></pre> <p>其它一些重要属性如下：</p> <ul> <li>acceptCount : 接受连接request的最大连接数目，默认值是10</li> <li>address : 绑定IP地址，如果不绑定，默认将绑定任何IP地址</li> <li>allowTrace : 如果是true,将允许TRACE HTTP方法</li> <li>compressibleMimeTypes : 各个mimeType, 以逗号分隔，如text/html,text/xml</li> <li>compression : 如果带宽有限的话，可以用GZIP压缩</li> <li>connectionTimeout : 超时时间，默认为60000ms (60s)</li> <li>maxKeepAliveRequest : 默认值是100</li> <li>maxThreads : 处理请求的Connector的线程数目，默认值为200</li> </ul> <p>如果是SSL配置，如下：</p> <pre> <connector protocol="HTTP/1.1" port="8181" <b="" address="0.0.0.0" sslprotocol="TLS" clientauth="false" secure="true" scheme="https" maxthreads="150" sslenabled="true"> keystoreFile="E:/java/jonas-full-5.1.0-RC3/conf/keystore.jks" <b>keystorePass="changeit" </b>/> </connector></pre> <p>其中，keystoreFile为证书位置，keystorePass为证书密码</p> <h4>1.2.2 NIO HTTP/1.1 Connector配置</h4> <pre> <connector protocol="”<b" port="”8080”"> org.apache.coyote.http11.Http11NioProtocol” maxThreads=”150” connectionTimeout=”20000” redirectPort=”8443” </connector></pre> <h4>1.2.3 Native APR Connector配置</h4> <ol> <li>ARP是用C/C++写的，对静态资源（HTML，图片等）进行了优化。所以要下载本地库 <p>tcnative-1.dll与openssl.exe，将其放在%tomcat%\bin目录下。</p> <p>下载地址是：<a href="/misc/goto?guid=4959498382853252984">http://tomcat.heanet.ie/native/1.1.10/binaries/win32/</a></p> </li> <li>在server.xml中要配置一个Listener,如下图。这个配置tomcat是默认配好的。 <pre> <!--APR library loader. Documentation at /docs/apr.html --> <listener sslengine="on" classname="org.apache.catalina.core.AprLifecycleListener"> </listener></pre></li> <li>配置使用APR connector <pre> <connector protocol="”<b" port="”8080”"> org.apache.coyote.http11.Http11AprProtocol” <p>maxThreads=”150” connectionTimeout=”20000” redirectPort=”8443”</p> </connector></pre></li> <li>如果配置成功，启动tomcat,会看到如下信息： <pre>org.apache.coyote.http11.Http11AprProtocol init </pre></li> </ol> <h2>2 Connector在Tomcat中所处的位置</h2> <h3>2.1 Tomcat架构</h3> <p class="image-wide"><img border="0" alt="Tomcat处理HTTP请求源码分析（上）" src="https://simg.open-open.com/show/59a324e70eab7cf85ca1ea7173a6e005.jpg" width="415" height="284" _p="true" _href="img://image1.jpg" /></p> <p><strong>图2-1 Tomcat架构 </strong></p> <ul> <li>Server(服务器)是Tomcat构成的顶级构成元素，所有一切均包含在Server中，Server的实现类StandardServer可以包含一个到多个Services;</li> <li>次顶级元素Service的实现类为StandardService调用了容器(Container)接口，其实是调用了Servlet Engine(引擎)，而且StandardService类中也指明了该Service归属的Server；</li> <li>接下来次级的构成元素就是容器(Container)，主机(Host)、上下文(Context)和引擎(Engine)均继承自 Container接口，所以它们都是容器。但是，它们是有父子关系的，在主机(Host)、上下文(Context)和引擎(Engine)这三类容器 中，引擎是顶级容器，直接包含是主机容器，而主机容器又包含上下文容器，所以引擎、主机和上下文从大小上来说又构成父子关系，虽然它们都继承自 Container接口。</li> <li>连接器(Connector)将Service和Container连接起来，首先它需要注册到一个Service，它的作用就是把来自客户端的请求转发到Container(容器)，这就是它为什么称作连接器的原因。</li> </ul> <p>故我们从功能的角度将Tomcat源代码分成5个子模块，它们分别是：</p> <ol> <li>Jsper子模块：这个子模块负责jsp页面的解析、jsp属性的验证，同时也负责将jsp页面动态转换为java代码并编译成class文件。在Tomcat源代码中，凡是属于org.apache.jasper包及其子包中的源代码都属于这个子模块；</li> <li>Servlet和Jsp规范的实现模块：这个子模块的源代码属于javax.servlet包及其子包，如我们非常熟悉的 javax.servlet.Servlet接口、javax.servet.http.HttpServlet类及 javax.servlet.jsp.HttpJspPage就位于这个子模块中；</li> <li>Catalina子模块：这个子模块包含了所有以org.apache.catalina开头的java源代码。该子模块的任务是规范了 Tomcat的总体架构，定义了Server、Service、Host、Connector、Context、Session及Cluster等关键组 件及这些组件的实现，这个子模块大量运用了Composite设计模式。同时也规范了Catalina的启动及停止等事件的执行流程。从代码阅读的角度 看，这个子模块应该是我们阅读和学习的重点。</li> <li>Connectors子模块：如果说上面三个子模块实现了Tomcat应用服务器的话，那么这个子模块就是Web服务器的实现。所谓连接 器(Connector)就是一个连接客户和应用服务器的桥梁，它接收用户的请求，并把用户请求包装成标准的Http请求(包含协议名称，请求头 Head，请求方法是Get还是Post等等)。同时，这个子模块还按照标准的Http协议，负责给客户端发送响应页面，比如在请求页面未发现 时，connector就会给客户端浏览器发送标准的Http 404错误响应页面。</li> <li>Resource子模块：这个子模块包含一些资源文件，如Server.xml及Web.xml配置文件。严格说来，这个子模块不包含java源代码，但是它还是Tomcat编译运行所必需的。</li> </ol> <h3>2.2 Tomcat运行流程</h3> <p class="image-wide"><img border="0" alt="Tomcat处理HTTP请求源码分析（上）" src="https://simg.open-open.com/show/f1aa8a781479109792f43efbc6793fd4.jpg" width="545" height="220" _p="true" _href="img://image1.jpg" /></p> <p><strong>图2-2 tomcat运行流程 </strong></p> <p>假设来自客户的请求为：<a href="/misc/goto?guid=4959498382948576562">http://localhost:8080/test/index.jsp</a></p> <ol> <li>请求被发送到本机端口8080，被在那里侦听的Coyote HTTP/1.1 Connector获得</li> <li>Connector把该请求交给它所在的Service的Engine来处理，并等待Engine的回应</li> <li>Engine获得请求localhost:8080/test/index.jsp，匹配它所有虚拟主机Host</li> <li>Engine匹配到名为localhost的Host（即使匹配不到也把请求交给该Host处理，因为该Host被定义为该Engine的默认主机）</li> <li>localhost Host获得请求/test/index.jsp，匹配它所拥有的所有Context</li> <li>Host匹配到路径为/test的Context（如果匹配不到就把该请求交给路径名为""的Context去处理）</li> <li>path="/test"的Context获得请求/index.jsp，在它的mapping table中寻找对应的servlet</li> <li>Context匹配到URL PATTERN为*.jsp的servlet，对应于JspServlet类</li> <li>构造HttpServletRequest对象和HttpServletResponse对象，作为参数调用JspServlet的doGet或doPost方法</li> <li>Context把执行完了之后的HttpServletResponse对象返回给Host</li> <li>Host把HttpServletResponse对象返回给Engine</li> <li>Engine把HttpServletResponse对象返回给Connector</li> <li>Connector把HttpServletResponse对象返回给客户browser</li> </ol> <h2>3 Connector源码分析</h2> <h3>3.1 Tomcat的启动分析与集成设想</h3> <p>我们知道，启动tomcat有两种方式：</p> <ul> <li>双击bin/startup.bat</li> <li>运行bin/catalina.bat run</li> </ul> <p>它们对应于Bootstrap与Catalina两个类，我们现在只关心Catalina这个类，这个类使用Apache Digester解析conf/server.xml文件生成tomcat组件，然后再调用Embedded类的start方法启动tomcat。</p> <p>所以，集成Tomcat的方式就有以下两种了：</p> <ul> <li>沿用tomcat自身的server.xml</li> <li>自己定义一个xml格式来配置tocmat的各参数，自己再写解析这段xml，然后使用tomcat提供的API根据这些xml来生成Tomcat组件，最后调用Embedded类的start方法启动tomcat</li> </ul> <p>个人觉得第一种方式要优越，给开发者比较好的用户体验，如果使用这种，直接模仿Catalina类的方法即可实现集成。</p> <p>目前，JOnAS就使用了这种集成方式，JBoss、GlassFish使用的第二种自定义XML的方式。</p> <h3>3.2 Connector类图与顺序图</h3> <p class="image-wide"><img style="width:713px;height:396px;" border="0" alt="Tomcat处理HTTP请求源码分析（上）" src="https://simg.open-open.com/show/7583b05fe86837290f94c6fe3c62d46d.jpg" width="1139" height="633" _p="true" _href="img://image1.jpg" /></p> <p><strong>图3-1 Connector相关类图 </strong></p> <p class="image-wide"><img style="width:680px;height:281px;" border="0" alt="Tomcat处理HTTP请求源码分析（上）" src="https://simg.open-open.com/show/e0ae1bbf830029d7987ec352097aa746.jpg" width="1217" height="507" _p="true" _href="img://image1.jpg" /></p> <p><strong>图3-2 Connector工作流程顺序图 </strong></p> <p>从上面二图中我们可以得到如下信息：</p> <ol> <li>Tomcat中有四种容器(Context、Engine、Host、Wrapper)，前三者常见，第四个不常见但它也是实现了Container接口的容器</li> <li>如果要<b>自定义一个Connector的话，只需要实现ProtocolHander接口</b>,该接口定义如下：</li> </ol> <p class="image-wide"><img border="0" alt="Tomcat处理HTTP请求源码分析（上）" src="https://simg.open-open.com/show/d68e087d447f8aa1430fb43d80733b41.jpg" width="649" height="669" _p="true" _href="img://image1.jpg" /></p> <p><strong>图3-3 自定义connector时需实现的ProtocolHandler接口 </strong></p> <p>Tomcat以HTTP（包括BIO与NIO）、AJP、APR、内存四种协议实现了该接口（它们分别是：AjpAprProtocol、 AjpProtocol、Http11AprProtocol、Http11NioProtocol、Http11Protocal、 JkCoyoteHandler、MemoryProtocolHandler），要使用哪种Connector就在conf/server.xml中配 置，在Connector的构造函数中会通过反射实例化所配置的实现类：</p> <pre> <connector protocol="org.apache.coyote.http11.Http11AprProtocol " port="8181"> </connector></pre> <h3>3.3 Connector的工作流程</h3> <p>下面我们以Http11AprProtocol为例说明Connector的工作流程。</p> <ol> <li>它将工作委托给NioEndpoint类。在NioEndpoint类的init方法中构建一个SocketServer(当然，不同的实现类会有一些微小的变化，例如如果是NIO，它构建的就是SocketServerChannel)</li> <li>在NioEndpoint.Acceptor类中会接收一个客户端新的连接请求，如下图： <p class="image-wide"><img border="0" alt="Tomcat处理HTTP请求源码分析（上）" src="https://simg.open-open.com/show/60d40698ebc98c35b716482674940dc2.jpg" width="570" height="561" _p="true" _href="img://image1.jpg" /></p> </li> <li>在NioEndpoint类中，有一个内部接口Handle，该接口定义如下： <p class="image-wide"><img border="0" alt="Tomcat处理HTTP请求源码分析（上）" src="https://simg.open-open.com/show/f146a6241cd6ba3891202b856f3c8186.jpg" width="564" height="119" _p="true" _href="img://image1.jpg" /></p> </li> <li>在Http11NioProtocol类中实现了Handle这个内部接口，并调用Http11NioProcessor类(该类实现了 ActionHook回调接口)。在Response类中会调用ActionHook实现类的相关方法的，Response类的action方法如下： <p class="image-wide"><img border="0" alt="Tomcat处理HTTP请求源码分析（上）" src="https://simg.open-open.com/show/2a01ddee8e5102e131b20890f706c012.jpg" width="469" height="142" _p="true" _href="img://image1.jpg" /></p> </li> <li>Http11NioProcessor的process实现方法中，会通过Adapter来调用Servler容器生成响应结果。</li> </ol> <h2>关于作者</h2> <p>张华，长期从事Java方面的开发工作，有搜索引擎、中间件应用服务器、互联网、云计算等领域的行业经验，目前正在从事基于Power的虚拟化技术研发。博客地址：<a href="/misc/goto?guid=4959498383069299594">http://blog.csdn.net/quqi99</a></p>