Servlet-工作原理解析精品资料.docx

《Servlet-工作原理解析精品资料.docx》由会员分享，可在线阅读，更多相关《Servlet-工作原理解析精品资料.docx（33页珍藏版）》请在得力文库 - 分享文档赚钱的网站上搜索。

1、Servlet 工作原理解析许令波, Java 工程师, 淘宝网简介Web技术成为当今主流的互联网Web应用技术之一，而Servlet是Java Web技术的核心基础。因而掌握Servlet的工作原理是成为一名合格的Java Web技术开发人员的基本要求。本文将带你认识Java Web技术是如何基于Servlet工作，你将知道:l 以Tomcat为例了解Servlet容器是如何工作的？l 一个Web工程在Servlet容器中是如何启动的？l Servlet容器如何解析你在web.xml中定义的Servlet？l 用户的请求是如何被分配给指定的Servlet的？l Servlet容器如何管理Se

2、rvlet生命周期？你还将了解到最新的Servlet的API的类层次结构，以及Servlet中一些难点问题的分析。从Servlet容器说起要介绍Servlet必须要先把Servlet容器说清楚，Servlet与Servlet容器的关系有点像枪和子弹的关系，枪是为子弹而生，而子弹又让枪有了杀伤力。虽然它们是彼此依存的，但是又相互独立发展，这一切都是为了适应工业化生产的结果。从技术角度来说是为了解耦，通过标准化接口来相互协作。既然接口是连接Servlet与Servlet容器的关键，那我们就从它们的接口说起。前面说了Servlet容器作为一个独立发展的标准化产品，目前它的种类很多，但是它们都有自己的

3、市场定位，很难说谁优谁劣，各有特点。例如现在比较流行的Jetty，在定制化和移动领域有不错的发展，我们这里还是以大家最为熟悉Tomcat为例来介绍Servlet容器如何管理Servlet。Tomcat本身也很复杂，我们只从Servlet与Servlet容器的接口部分开始介绍，关于Tomcat的详细介绍可以参考我的另外一篇文章Tomcat系统架构与模式设计分析。Tomcat的容器等级中，Context容器是直接管理Servlet在容器中的包装类Wrapper，所以 Context容器如何运行将直接影响Servlet的工作方式。图1. Tomcat容器模型从上图可以看出Tomcat的容器分为四个等

4、级，真正管理Servlet的容器是Context容器，一个Context对应一个Web工程，在Tomcat的配置文件中可以很容易发现这一点，如下:清单 1 Context 配置参数 下面详细介绍一下Tomcat解析Context容器的过程，包括如何构建Servlet的过程。Servlet容器的启动过程Tomcat7也开始支持嵌入式功能，增加了一个启动类org.apache.catalina.startup.Tomcat。创建一个实例对象并调用start方法就可以很容易启动Tomcat，我们还可以通过这个对象来增加和修改Tomcat的配置参数，如可以动态增加Context、Servlet等。下面

5、我们就利用这个Tomcat类来管理新增的一个Context容器，我们就选择Tomcat7自带的examples Web工程，并看看它是如何加到这个Context容器中的。清单2. 给Tomcat增加一个Web工程Tomcat tomcat = getTomcatInstance(); File appDir = new File(getBuildDirectory(), webapps/examples); tomcat.addWebapp(null, /examples, appDir.getAbsolutePath(); tomcat.start(); ByteChunk res = ge

6、tUrl(http:/localhost: + getPort() + /examples/servlets/servlet/HelloWorldExample); assertTrue(res.toString().indexOf(Hello World!) 0); 清单1的代码是创建一个Tomcat实例并新增一个Web应用，然后启动 Tomcat 并调用其中的一个 HelloWorldExample Servlet，看有没有正确返回预期的数据。Tomcat 的addWebapp方法的代码如下:清单3. Tomcat.addWebapppublic Context addWebapp(Hos

7、t host, String url, String path) silence(url); Context ctx = new StandardContext(); ctx.setPath( url ); ctx.setDocBase(path); if (defaultRealm = null) initSimpleAuth(); ctx.setRealm(defaultRealm); ctx.addLifecycleListener(new DefaultWebXmlListener(); ContextConfig ctxCfg = new ContextConfig(); ctx.a

8、ddLifecycleListener(ctxCfg); ctxCfg.setDefaultWebXml(org/apache/catalin/startup/NO_DEFAULT_XML); if (host = null) getHost().addChild(ctx); else host.addChild(ctx); return ctx; 前面已经介绍了一个Web应用对应一个Context容器，也就是Servlet运行时的Servlet容器，添加一个Web 应用时将会创建一个StandardContext容器，并且给这个Context容器设置必要的参数，url和path分别代表这个应

9、用在Tomcat中的访问路径和这个应用实际的物理路径，这个两个参数与清单1中的两个参数是一致的。其中最重要的一个配置是ContextConfig，这个类将会负责整个Web应用配置的解析工作，后面将会详细介绍。最后将这个Context容器加到父容器Host中。接下去将会调用Tomcat的start方法启动Tomcat，如果你清楚Tomcat的系统架构，你会容易理解Tomcat的启动逻辑，Tomcat的启动逻辑是基于观察者模式设计的，所有的容器都会继承Lifecycle接口，它管理者容器的整个生命周期，所有容器的的修改和状态的改变都会由它去通知已经注册的观察者（Listener），关于这个设计模式

10、可以参考Tomcat的系统架构与设计模式，第二部分:设计模式。Tomcat启动的时序图可以用图 2 表示。上图描述了Tomcat启动过程中，主要类之间的时序关系，下面我们将会重点关注添加examples应用所对应的StandardContext容器的启动过程。当Context容器初始化状态设为init时，添加在Contex容器的Listener将会被调用。ContextConfig继承了 LifecycleListener接口，它是在调用清单3时被加入到StandardContext容器中。ContextConfig类会负责整个 Web应用的配置文件的解析工作。ContextConfig的in

11、it方法将会主要完成以下工作:1. 创建用于解析xml配置文件的contextDigester对象2. 读取默认context.xml配置文件，如果存在解析它3. 读取默认Host配置文件，如果存在解析它4. 读取默认Context自身的配置文件，如果存在解析它5. 设置Context的 DocBaseContextConfig的init方法完成后，Context容器的会执行startInternal方法，这个方法启动逻辑比较复杂，主要包括如下几个部分:1. 创建读取资源文件的对象2. 创建ClassLoader对象3. 设置应用的工作目录4. 启动相关的辅助类如:logger、realm、r

12、esources 等5. 修改启动状态，通知感兴趣的观察者（Web 应用的配置）6. 子容器的初始化7. 获取ServletContext 并设置必要的参数8. 初始化“load on startup”的ServletWeb应用的初始化工作Web应用的初始化工作是在ContextConfig的configureStart方法中实现的，应用的初始化主要是要解析 web.xml文件，这个文件描述了一个Web应用的关键信息，也是一个Web应用的入口。Tomcat首先会找globalWebXml这个文件的搜索路径是在engine的工作目录下寻找以下两个文件中的任一个org/apache/catalin

13、/startup/NO_DEFAULT_XML或conf/web.xml。接着会找hostWebXml这个文件可能会在 System.getProperty(catalina.base)/conf/$EngineName/$HostName/web.xml.default，接着寻找应用的配置文件 examples/WEB-INF/web.xml。web.xml文件中的各个配置项将会被解析成相应的属性保存在WebXml对象中。如果当前应用支持Servlet3.0，解析还将完成额外9项工作，这个额外的9项工作主要是为Servlet3.0新增的特性，包括jar包中的META-INF/web-frag

14、ment.xml的解析以及对annotations的支持。接下去将会将WebXml对象中的属性设置到Context容器中，这里包括创建Servlet对象、filter、listener等等。这段代码在WebXml的configureContext方法中。下面是解析Servlet的代码片段:清单4. 创建Wrapper实例for (ServletDef servlet : servlets.values() Wrapper wrapper = context.createWrapper(); String jspFile = servlet.getJspFile(); if (jspFile !

15、= null) wrapper.setJspFile(jspFile); if (servlet.getLoadOnStartup() != null) wrapper.setLoadOnStartup(servlet.getLoadOnStartup().intValue(); if (servlet.getEnabled() != null) wrapper.setEnabled(servlet.getEnabled().booleanValue(); wrapper.setName(servlet.getServletName(); Map params = servlet.getPar

16、ameterMap(); for (Entry entry : params.entrySet() wrapper.addInitParameter(entry.getKey(), entry.getValue(); wrapper.setRunAs(servlet.getRunAs(); Set roleRefs = servlet.getSecurityRoleRefs(); for (SecurityRoleRef roleRef : roleRefs) wrapper.addSecurityReference( roleRef.getName(), roleRef.getLink();

17、 wrapper.setServletClass(servlet.getServletClass(); MultipartDef multipartdef = servlet.getMultipartDef(); if (multipartdef != null) if (multipartdef.getMaxFileSize() != null & multipartdef.getMaxRequestSize()!= null & multipartdef.getFileSizeThreshold() != null) wrapper.setMultipartConfigElement(ne

18、w MultipartConfigElement( multipartdef.getLocation(), Long.parseLong(multipartdef.getMaxFileSize(), Long.parseLong(multipartdef.getMaxRequestSize(), Integer.parseInt( multipartdef.getFileSizeThreshold(); else wrapper.setMultipartConfigElement(new MultipartConfigElement( multipartdef.getLocation(); i

19、f (servlet.getAsyncSupported() != null) wrapper.setAsyncSupported( servlet.getAsyncSupported().booleanValue(); context.addChild(wrapper); 这段代码清楚的描述了如何将Servlet包装成Context容器中的StandardWrapper，这里有个疑问，为什么要将Servlet包装成StandardWrapper而不直接是Servlet对象。这里StandardWrapper是Tomcat容器中的一部分，它具有容器的特征，而Servlet为了一个独立的web开

20、发标准，不应该强耦合在Tomcat中。除了将Servlet包装成StandardWrapper并作为子容器添加到Context中，其它的所有web.xml属性都被解析到Context中，所以说Context容器才是真正运行Servlet的Servlet容器。一个Web应用对应一个Context容器，容器的配置属性由应用的web.xml指定，这样我们就能理解web.xml到底起到什么作用了。创建Servlet实例前面已经完成了Servlet的解析工作，并且被包装成StandardWrapper添加在Context容器中，但是它仍然不能为我们工作，它还没有被实例化。下面我们将介绍Servlet对象

21、是如何创建的，以及如何被初始化的。创建Servlet对象如果Servlet的load-on-startup配置项大于0，那么在Context容器启动的时候就会被实例化，前面提到在解析配置文件时会读取默认的globalWebXml，在conf下的web.xml文件中定义了一些默认的配置项，其定义了两个Servlet，分别是: org.apache.catalina.servlets.DefaultServlet和org.apache.jasper.servlet.JspServlet它们的load-on-startup分别是1和3，也就是当Tomcat启动时这两个Servlet就会被启动。创建S

22、ervlet实例的方法是从Wrapper.loadServlet开始的。loadServlet方法要完成的就是获取servletClass然后把它交给InstanceManager去创建一个基于servletClass.class的对象。如果这个Servlet配置了jsp-file，那么这个servletClass就是conf/web.xml中定义的org.apache.jasper.servlet.JspServlet了。创建Servlet对象的相关类结构图如下:图3. 创建 Servlet 对象的相关类结构初始化Servlet初始化Servlet在StandardWrapper的initS

23、ervlet方法中，这个方法很简单就是调用Servlet的init 的方法，同时把包装了StandardWrapper对象的StandardWrapperFacade作为ServletConfig传给Servlet。Tomcat容器为何要传StandardWrapperFacade给Servlet对象将在后面做详细解析。如果该Servlet关联的是一个jsp文件，那么前面初始化的就是JspServlet，接下去会模拟一次简单请求，请求调用这个jsp文件，以便编译这个jsp文件为class，并初始化这个class。这样Servlet对象就初始化完成了，事实上Servlet从被web.xml中解析

24、到完成初始化，这个过程非常复杂，中间有很多过程，包括各种容器状态的转化引起的监听事件的触发、各种访问权限的控制和一些不可预料的错误发生的判断行为等等。我们这里只抓了一些关键环节进行阐述，试图让大家有个总体脉络。下面是这个过程的一个完整的时序图，其中也省略了一些细节。图 4. 初始化 Servlet 的时序图Servlet体系结构我们知道Java Web应用是基于Servlet规范运转的，那么Servlet本身又是如何运转的呢？为何要设计这样的体系结构。图5. Servlet顶层类关联图从上图可以看出Servlet规范就是基于这几个类运转的，与Servlet主动关联的是三个类，分别是 Servl

25、etConfig、ServletRequest和ServletResponse。这三个类都是通过容器传递给Servlet的，其中 ServletConfig是在Servlet初始化时就传给Servlet了，而后两个是在请求达到时调用Servlet时传递过来的。我们很清楚ServletRequest和ServletResponse在Servlet运行的意义，但是ServletConfig和ServletContext对Servlet有何价值？仔细查看ServletConfig接口中声明的方法发现，这些方法都是为了获取这个Servlet的一些配置属性，而这些配置属性可能在Servlet运行时被用到

26、。而ServletContext又是干什么的呢？Servlet 的运行模式是一个典型的“握手型的交互式”运行模式。所谓“握手型的交互式”就是两个模块为了交换数据通常都会准备一个交易场景，这个场景一直跟随个这个交易过程直到这个交易完成为止。这个交易场景的初始化是根据这次交易对象指定的参数来定制的，这些指定参数通常就会是一个配置类。所以对号入座，交易场景就由ServletContext 来描述，而定制的参数集合就由 ServletConfig 来描述。而 ServletRequest 和 ServletResponse 就是要交互的具体对象了，它们通常都是作为运输工具来传递交互结果。Servlet

27、Config 是在 Servlet init 时由容器传过来的，那么 ServletConfig 到底是个什么对象呢？下图是 ServletConfig 和 ServletContext 在 Tomcat 容器中的类关系图。图 6. ServletConfig 在容器中的类关联图上图可以看出StandardWrapper和StandardWrapperFacade都实现了ServletConfig接口，而 StandardWrapperFacade是 StandardWrapper门面类。所以传给Servlet的是StandardWrapperFacade对象，这个类能够保证从Standard

28、Wrapper中拿到ServletConfig所规定的数据，而又不把ServletConfig不关心的数据暴露给Servlet。同样ServletContext也与ServletConfig有类似的结构，Servlet中能拿到的ServletContext的实际对象也是ApplicationContextFacade对象。ApplicationContextFacade同样保证ServletContex只能从容器中拿到它该拿的数据，它们都起到对数据的封装作用，它们使用的都是门面设计模式。通过ServletContext可以拿到Context 容器中一些必要信息，比如应用的工作路径，容器支持的

29、Servlet 最小版本等。Servlet中定义的两个ServletRequest和ServletResponse它们实际的对象又是什么呢？，我们在创建自己的 Servlet类时通常使用的都是HttpServletRequest和HttpServletResponse，它们继承了ServletRequest 和 ServletResponse。为何Context容器传过来的ServletRequest、ServletResponse 可以被转化为 HttpServletRequest 和 HttpServletResponse呢？图7. Request相关类结构图上图是Tomcat创建的Req

30、uest和Response的类结构图。Tomcat一接受到请求首先将会创建 org.apache.coyote.Request和org.apache.coyote.Response，这两个类是Tomcat内部使用的描述一次请求和相应的信息类它们是一个轻量级的类，它们作用就是在服务器接收到请求后，经过简单解析将这个请求快速的分配给后续线程去处理，所以它们的对象很小，很容易被JVM回收。接下去当交给一个用户线程去处理这个请求时又创建org.apache.catalina.connector.Request和org.apache.catalina.connector.Response对象。这两个对象

31、一直穿越整个Servlet容器直到要传给Servlet，传给Servlet的是Request和Response的门面类RequestFacade和RequestFacade，这里使用门面模式与前面一样都是基于同样的目的封装容器中的数据。一次请求对应的Request和Response的类转化如下图所示:图8. Request和Response的转变过程Servlet如何工作我们已经清楚了Servlet是如何被加载的、Servlet是如何被初始化的，以及Servlet的体系结构，现在的问题就是它是如何被调用的。当用户从浏览器向服务器发起一个请求，通常会包含如下信息:http:/hostname:p

32、ort/contextpath/servletpath，hostname和port是用来与服务器建立TCP连接，而后面的URL才是用来选择服务器中那个子容器服务用户的请求。那服务器是如何根据这个URL来达到正确的Servlet容器中的呢？Tomcat7.0中这件事很容易解决，因为这种映射工作有专门一个类来完成的，这个就是org.apache.tomcat.util.http.mapper，这个类保存了Tomcat的Container容器中的所有子容器的信息，当org.apache.catalina.connector.Request类在进入Container容器之前，mapper会根据这次请求

33、的hostnane和contextpath将host和context容器设置到Request的mappingData 属性中。所以当Request进入Container容器之前，它要访问那个子容器这时就已经确定了。图 9.Request 的 Mapper 类关系图可能你有疑问，mapper中怎么会有容器的完整关系，这要回到图2中19步MapperListener 类的初始化过程，下面是MapperListener的init方法代码 :清单 5. MapperListener.initpublic void init() findDefaultHost(); Engine engine = (E

34、ngine) connector.getService().getContainer(); engine.addContainerListener(this); Container conHosts = engine.findChildren(); for (Container conHost : conHosts) Host host = (Host) conHost; if (!LifecycleState.NEW.equals(host.getState() host.addLifecycleListener(this); registerHost(host); 这段代码的作用就是将Ma

35、pperListener类作为一个监听者加到整个Container容器中的每个子容器中，这样只要任何一个容器发生变化，MapperListener都将会被通知，相应的保存容器关系的MapperListener 的 mapper属性也会修改。for循环中就是将host及下面的子容器注册到mapper中。图 10.Request 在容器中的路由图上图描述了一次Request请求是如何达到最终的Wrapper容器的，我们现正知道了请求是如何达到正确的Wrapper容器，但是请求到达最终的Servlet还要完成一些步骤，必须要执行Filter链，以及要通知你在web.xml中定义的listener。接

36、下去就要执行Servlet的service方法了，通常情况下，我们自己定义的servlet并不是直接去实现javax.servlet.servlet接口，而是去继承更简单的HttpServlet类或者GenericServlet类，我们可以有选择的覆盖相应方法去实现我们要完成的工作。Servlet的确已经能够帮我们完成所有的工作了，但是现在的web应用很少有直接将交互全部页面都用 servlet来实现，而是采用更加高效的MVC框架来实现。这些MVC框架基本的原理都是将所有的请求都映射到一个Servlet，然后去实现service方法，这个方法也就是MVC框架的入口。当Servlet从Servl

37、et容器中移除时，也就表明该Servlet的生命周期结束了，这时Servlet的destroy方法将被调用，做一些扫尾工作。Session与Cookie前面我们已经说明了Servlet如何被调用，我们基于Servlet来构建应用程序，那么我们能从Servlet获得哪些数据信息呢？Servlet能够给我们提供两部分数据，一个是在Servlet初始化时调用init方法时设置的ServletConfig，这个类基本上含有了Servlet本身和Servlet所运行的Servlet容器中的基本信息。根据前面的介绍ServletConfig的实际对象是StandardWrapperFacade，到底能获得

38、哪些容器信息可以看看这类提供了哪些接口。还有一部分数据是由ServletRequest类提供，它的实际对象是RequestFacade，从提供的方法中发现主要是描述这次请求的 HTTP 协议的信息。所以要掌握Servlet的工作方式必须要很清楚HTTP协议，如果你还不清楚赶紧去找一些参考资料。关于这一块还有一个让很多人迷惑的Session与Cookie。Session与Cookie不管是对Java Web的熟练使用者还是初学者来说都是一个令人头疼的东西。Session与Cookie的作用都是为了保持访问用户与后端服务器的交互状态。它们有各自的优点也有各自的缺陷。然而具有讽刺意味的是它们优点和它

39、们的使用场景又是矛盾的，例如使用Cookie来传递信息时，随着Cookie个数的增多和访问量的增加，它占用的网络带宽也很大，试想假如Cookie占用200个字节，如果一天的PV有几亿的时候，它要占用多少带宽。所以大访问量的时候希望用Session，但是Session的致命弱点是不容易在多台服务器之间共享，所以这也限制了Session的使用。不管Session和Cookie有什么不足，我们还是要用它们。下面详细讲一下，Session如何基于Cookie来工作。实际上有三种方式能可以让Session正常工作:1. 基于URL Path Parameter，默认就支持2. 基于Cookie，如果你没

40、有修改Context容器个cookies标识的话，默认也是支持的3. 基于SSL，默认不支持，只有connector.getAttribute(SSLEnabled)为TRUE时才支持第一种情况下，当浏览器不支持Cookie功能时，浏览器会将用户的SessionCookieName重写到用户请求的URL参数中，它的传递格式如/path/Servlet;name=value;name2=value2?Name3=value3，其中“Servlet；”后面的 K-V 对就是要传递的Path Parameters，服务器会从这个Path Parameters中拿到用户配置的 SessionCooki

41、eName。关于这个SessionCookieName，如果你在web.xml中配置session-config配置项的话，其cookie-config下的 name 属性就是这个SessionCookieName值，如果你没有配置session-config配置项，默认的SessionCookieName就是大家熟悉的“JSESSIONID”。接着Request根据这个SessionCookieName到Parameters拿到Session ID并设置到request.setRequestedSessionId中。请注意如果客户端也支持Cookie的话，Tomcat仍然会解析Cookie中

42、的Session ID，并会覆盖URL中的Session ID。如果是第三种情况的话将会根据javax.servlet.request.ssl_session属性值设置Session ID。有了Session ID服务器端就可以创建HttpSession对象了，第一次触发是通过request.getSession()方法，如果当前的Session ID还没有对应的HttpSession对象那么就创建一个新的，并将这个对象加到 org.apache.catalina.Manager的sessions容器中保存，Manager类将管理所有Session的生命周期，Session过期将被回收，服务器

43、关闭，Session 将被序列化到磁盘等。只要这个HttpSession对象存在，用户就可以根据 Session ID来获取到这个对象，也就达到了状态的保持。图 11.Session 相关类图上从图中可以看出从request.getSession中获取的HttpSession对象实际上是StandardSession对象的门面对象，这与前面的Request和Servlet是一样的原理。下图是Session工作的时序图:图 12.Session 工作的时序图还有一点与Session关联的Cookie与其它Cookie没有什么不同，这个配置的配置可以通过web.xml中的session-confi

44、g配置项来指定。Servlet中的Listener整个Tomcat服务器中Listener使用的非常广泛，它是基于观察者模式设计的，Listener的设计对开发Servlet 应用程序提供了一种快捷的手段，能够方便的从另一个纵向维度控制程序和数据。目前Servlet中提供了5种两类事件的观察者接口，它们分别是:4 个 EventListeners类型的，ServletContextAttributeListener、ServletRequestAttributeListener、ServletRequestListener、HttpSessionAttributeListener 和2个 LifecycleListeners 类型的，ServletContextListener、HttpSessionListener。如下图所示:图 13.Servlet