從 Servlet 容器說(shuō)起

• 要介紹 Servlet 必須要先把 Servlet 容器說(shuō)清楚壹店，Servlet 與 Servlet 容器的關(guān)系有點(diǎn)像槍和子彈的關(guān)系硅卢，槍是為子彈而生将塑，而子彈又讓槍有了殺傷力抬旺。雖然它們是彼此依存的开财，但是又相互獨(dú)立發(fā)展碾褂，這一切都是為了適應(yīng)工業(yè)化生產(chǎn)的結(jié)果正塌。從技術(shù)角度來(lái)說(shuō)是為了解耦乓诽，通過(guò)標(biāo)準(zhǔn)化接口來(lái)相互協(xié)作鸠天。既然接口是連接 Servlet 與 Servlet 容器的關(guān)鍵稠集，那我們就從它們的接口說(shuō)起剥纷。
• 前面說(shuō)了 Servlet 容器作為一個(gè)獨(dú)立發(fā)展的標(biāo)準(zhǔn)化產(chǎn)品晦鞋，目前它的種類很多鳖宾，但是它們都有自己的市場(chǎng)定位渔肩，很難說(shuō)誰(shuí)優(yōu)誰(shuí)劣周偎，各有特點(diǎn)蓉坎。例如現(xiàn)在比較流行的 Jetty蛉艾，在定制化和移動(dòng)領(lǐng)域有不錯(cuò)的發(fā)展勿侯，我們這里還是以大家最為熟悉 Tomcat 為例來(lái)介紹 Servlet 容器如何管理 Servlet助琐。Tomcat 本身也很復(fù)雜蛆橡，我們只從 Servlet 與 Servlet 容器的接口部分開(kāi)始介紹泰演，關(guān)于 Tomcat 的詳細(xì)介紹可以參考我的另外一篇文章《 Tomcat 系統(tǒng)架構(gòu)與模式設(shè)計(jì)分析》粥血。

• Tomcat 的容器等級(jí)中，Context 容器是直接管理 Servlet 在容器中的包裝類 Wrapper缭嫡，所以 Context 容器如何運(yùn)行將直接影響 Servlet 的工作方式。
  圖 1 . Tomcat 容器模型

  
  
  圖 1 . Tomcat 容器模型

從上圖可以看出 Tomcat 的容器分為四個(gè)等級(jí)评架，真正管理 Servlet 的容器是 Context 容器纵诞，一個(gè) Context 對(duì)應(yīng)一個(gè) Web 工程，在 Tomcat 的配置文件中可以很容易發(fā)現(xiàn)這一點(diǎn)嗡呼，如下：
清單 1 Context 配置參數(shù)

<Context path="/projectOne " docBase="D:\projects\projectOne"
reloadable="true" />

下面詳細(xì)介紹一下 Tomcat 解析 Context 容器的過(guò)程南窗，包括如何構(gòu)建 Servlet 的過(guò)程万伤。

Servlet 容器的啟動(dòng)過(guò)程

Tomcat7 也開(kāi)始支持嵌入式功能，增加了一個(gè)啟動(dòng)類 org.apache.catalina.startup.Tomcat放妈。創(chuàng)建一個(gè)實(shí)例對(duì)象并調(diào)用 start 方法就可以很容易啟動(dòng) Tomcat芜抒，我們還可以通過(guò)這個(gè)對(duì)象來(lái)增加和修改 Tomcat 的配置參數(shù)宅倒，如可以動(dòng)態(tài)增加 Context蹭劈、Servlet 等铺韧。下面我們就利用這個(gè) Tomcat 類來(lái)管理新增的一個(gè) Context 容器哈打，我們就選擇 Tomcat7 自帶的 examples Web 工程料仗，并看看它是如何加到這個(gè) Context 容器中的立轧。
清單 2 . 給 Tomcat 增加一個(gè) Web 工程

Tomcat tomcat = getTomcatInstance(); 
File appDir = new File(getBuildDirectory(), "webapps/examples"); 
tomcat.addWebapp(null, "/examples", appDir.getAbsolutePath()); 
tomcat.start(); 
ByteChunk res = getUrl("http://localhost:" + getPort() + 
              "/examples/servlets/servlet/HelloWorldExample"); 
assertTrue(res.toString().indexOf("<h1>Hello World!</h1>") > 0);

清單 1 的代碼是創(chuàng)建一個(gè) Tomcat 實(shí)例并新增一個(gè) Web 應(yīng)用肺孵，然后啟動(dòng) Tomcat 并調(diào)用其中的一個(gè) HelloWorldExample Servlet颜阐，看有沒(méi)有正確返回預(yù)期的數(shù)據(jù)凳怨。
Tomcat 的 addWebapp 方法的代碼如下：
清單 3 .Tomcat.addWebapp

public Context addWebapp(Host 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.addLifecycleListener(ctxCfg); 
       ctxCfg.setDefaultWebXml("org/apache/catalin/startup/NO_DEFAULT_XML"); 
       if (host == null) { 
           getHost().addChild(ctx); 
       } else { 
           host.addChild(ctx); 
       } 
       return ctx; 
}

前面已經(jīng)介紹了一個(gè) Web 應(yīng)用對(duì)應(yīng)一個(gè) Context 容器肤舞，也就是 Servlet 運(yùn)行時(shí)的 Servlet 容器李剖，添加一個(gè) Web 應(yīng)用時(shí)將會(huì)創(chuàng)建一個(gè) StandardContext 容器偶芍，并且給這個(gè) Context 容器設(shè)置必要的參數(shù)匪蟀，url 和 path 分別代表這個(gè)應(yīng)用在 Tomcat 中的訪問(wèn)路徑和這個(gè)應(yīng)用實(shí)際的物理路徑材彪，這個(gè)兩個(gè)參數(shù)與清單 1 中的兩個(gè)參數(shù)是一致的段化。其中最重要的一個(gè)配置是 ContextConfig普气，這個(gè)類將會(huì)負(fù)責(zé)整個(gè) Web 應(yīng)用配置的解析工作，后面將會(huì)詳細(xì)介紹履肃。最后將這個(gè) Context 容器加到父容器 Host 中。
接下去將會(huì)調(diào)用 Tomcat 的 start 方法啟動(dòng) Tomcat膘螟，如果你清楚 Tomcat 的系統(tǒng)架構(gòu)荆残，你會(huì)容易理解 Tomcat 的啟動(dòng)邏輯，Tomcat 的啟動(dòng)邏輯是基于觀察者模式設(shè)計(jì)的俘闯，所有的容器都會(huì)繼承 Lifecycle 接口真朗，它管理者容器的整個(gè)生命周期蝗碎，所有容器的的修改和狀態(tài)的改變都會(huì)由它去通知已經(jīng)注冊(cè)的觀察者（Listener）衍菱，關(guān)于這個(gè)設(shè)計(jì)模式可以參考《 Tomcat 的系統(tǒng)架構(gòu)與設(shè)計(jì)模式，第二部分：設(shè)計(jì)模式》琼锋。Tomcat 啟動(dòng)的時(shí)序圖可以用圖 2 表示缕坎。
圖 2. Tomcat 主要類的啟動(dòng)時(shí)序圖（查看大圖）

圖 2. Tomcat 主要類的啟動(dòng)時(shí)序圖

1. 創(chuàng)建用于解析 xml 配置文件的 contextDigester 對(duì)象
2. 讀取默認(rèn) context.xml 配置文件迈着，如果存在解析它
3. 讀取默認(rèn) Host 配置文件裕菠，如果存在解析它
4. 讀取默認(rèn) Context 自身的配置文件奴潘，如果存在解析它
5. 設(shè)置 Context 的 DocBase

ContextConfig 的 init 方法完成后，Context 容器的會(huì)執(zhí)行 startInternal 方法奈虾，這個(gè)方法啟動(dòng)邏輯比較復(fù)雜，主要包括如下幾個(gè)部分：

1. 創(chuàng)建讀取資源文件的對(duì)象
2. 創(chuàng)建 ClassLoader 對(duì)象
3. 設(shè)置應(yīng)用的工作目錄
4. 啟動(dòng)相關(guān)的輔助類如：logger浪册、realm、resources 等
5. 修改啟動(dòng)狀態(tài)笆环，通知感興趣的觀察者（Web 應(yīng)用的配置）
6. 子容器的初始化
7. 獲取 ServletContext 并設(shè)置必要的參數(shù)
8. 初始化“l(fā)oad on startup”的 Servlet

Web 應(yīng)用的初始化工作

Web 應(yīng)用的初始化工作是在 ContextConfig 的 configureStart 方法中實(shí)現(xiàn)的攒至，應(yīng)用的初始化主要是要解析 web.xml 文件，這個(gè)文件描述了一個(gè) Web 應(yīng)用的關(guān)鍵信息躁劣，也是一個(gè) Web 應(yīng)用的入口迫吐。
Tomcat 首先會(huì)找 globalWebXml 這個(gè)文件的搜索路徑是在 engine 的工作目錄下尋找以下兩個(gè)文件中的任一個(gè) org/apache/catalin/startup/NO_DEFAULT_XML 或 conf/web.xml。接著會(huì)找 hostWebXml 這個(gè)文件可能會(huì)在 System.getProperty("catalina.base")/conf/${EngineName}/${HostName}/web.xml.default账忘，接著尋找應(yīng)用的配置文件 examples/WEB-INF/web.xml。web.xml 文件中的各個(gè)配置項(xiàng)將會(huì)被解析成相應(yīng)的屬性保存在 WebXml 對(duì)象中鳖擒。如果當(dāng)前應(yīng)用支持 Servlet3.0溉浙，解析還將完成額外 9 項(xiàng)工作，這個(gè)額外的 9 項(xiàng)工作主要是為 Servlet3.0 新增的特性蒋荚，包括 jar 包中的 META-INF/web-fragment.xml 的解析以及對(duì) annotations 的支持戳稽。
接下去將會(huì)將 WebXml 對(duì)象中的屬性設(shè)置到 Context 容器中，這里包括創(chuàng)建 Servlet 對(duì)象期升、filter惊奇、listener 等等互躬。這段代碼在 WebXml 的 configureContext 方法中。下面是解析 Servlet 的代碼片段：
清單 4. 創(chuàng)建 Wrapper 實(shí)例

for (ServletDef servlet : servlets.values()) { 
           Wrapper wrapper = context.createWrapper(); 
           String jspFile = servlet.getJspFile(); 
           if (jspFile != 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<String,String> params = servlet.getParameterMap(); 
           for (Entry<String, String> entry : params.entrySet()) { 
               wrapper.addInitParameter(entry.getKey(), entry.getValue()); 
           } 
           wrapper.setRunAs(servlet.getRunAs()); 
           Set<SecurityRoleRef> roleRefs = servlet.getSecurityRoleRefs(); 
           for (SecurityRoleRef roleRef : roleRefs) { 
               wrapper.addSecurityReference( 
                       roleRef.getName(), roleRef.getLink()); 
           } 
           wrapper.setServletClass(servlet.getServletClass()); 
           MultipartDef multipartdef = servlet.getMultipartDef(); 
           if (multipartdef != null) { 
               if (multipartdef.getMaxFileSize() != null && 
                       multipartdef.getMaxRequestSize()!= null && 
                       multipartdef.getFileSizeThreshold() != null) { 
                   wrapper.setMultipartConfigElement(new 
MultipartConfigElement( 
                           multipartdef.getLocation(), 
                           Long.parseLong(multipartdef.getMaxFileSize()), 
                           Long.parseLong(multipartdef.getMaxRequestSize()), 
                           Integer.parseInt( 
                                   multipartdef.getFileSizeThreshold()))); 
               } else { 
                   wrapper.setMultipartConfigElement(new 
MultipartConfigElement( 
                           multipartdef.getLocation())); 
               } 
           } 
           if (servlet.getAsyncSupported() != null) { 
               wrapper.setAsyncSupported( 
                       servlet.getAsyncSupported().booleanValue()); 
           } 
           context.addChild(wrapper); 
}

這段代碼清楚的描述了如何將 Servlet 包裝成 Context 容器中的 StandardWrapper颂郎，這里有個(gè)疑問(wèn)吼渡，為什么要將 Servlet 包裝成 StandardWrapper 而不直接是 Servlet 對(duì)象。這里 StandardWrapper 是 Tomcat 容器中的一部分乓序，它具有容器的特征寺酪，而 Servlet 為了一個(gè)獨(dú)立的 web 開(kāi)發(fā)標(biāo)準(zhǔn)，不應(yīng)該強(qiáng)耦合在 Tomcat 中竭缝。
除了將 Servlet 包裝成 StandardWrapper 并作為子容器添加到 Context 中房维，其它的所有 web.xml 屬性都被解析到 Context 中，所以說(shuō) Context 容器才是真正運(yùn)行 Servlet 的 Servlet 容器抬纸。一個(gè) Web 應(yīng)用對(duì)應(yīng)一個(gè) Context 容器咙俩，容器的配置屬性由應(yīng)用的 web.xml 指定，這樣我們就能理解 web.xml 到底起到什么作用了湿故。

創(chuàng)建 Servlet 實(shí)例

前面已經(jīng)完成了 Servlet 的解析工作匹耕，并且被包裝成 StandardWrapper 添加在 Context 容器中，但是它仍然不能為我們工作霉咨，它還沒(méi)有被實(shí)例化污秆。下面我們將介紹 Servlet 對(duì)象是如何創(chuàng)建的，以及如何被初始化的墅茉。

創(chuàng)建 Servlet 對(duì)象

如果 Servlet 的 load-on-startup 配置項(xiàng)大于 0命黔，那么在 Context 容器啟動(dòng)的時(shí)候就會(huì)被實(shí)例化，前面提到在解析配置文件時(shí)會(huì)讀取默認(rèn)的 globalWebXml就斤，在 conf 下的 web.xml 文件中定義了一些默認(rèn)的配置項(xiàng)悍募，其定義了兩個(gè) Servlet，分別是：org.apache.catalina.servlets.DefaultServlet 和 org.apache.jasper.servlet.JspServlet 它們的 load-on-startup 分別是 1 和 3洋机，也就是當(dāng) Tomcat 啟動(dòng)時(shí)這兩個(gè) Servlet 就會(huì)被啟動(dòng)坠宴。
創(chuàng)建 Servlet 實(shí)例的方法是從 Wrapper. loadServlet 開(kāi)始的。loadServlet 方法要完成的就是獲取 servletClass 然后把它交給 InstanceManager 去創(chuàng)建一個(gè)基于 servletClass.class 的對(duì)象绷旗。如果這個(gè) Servlet 配置了 jsp-file喜鼓，那么這個(gè) servletClass 就是 conf/web.xml 中定義的 org.apache.jasper.servlet.JspServlet 了。
創(chuàng)建 Servlet 對(duì)象的相關(guān)類結(jié)構(gòu)圖如下：
圖 3. 創(chuàng)建 Servlet 對(duì)象的相關(guān)類結(jié)構(gòu)

圖 3. 創(chuàng)建 Servlet 對(duì)象的相關(guān)類結(jié)構(gòu)

初始化 Servlet

初始化 Servlet 在 StandardWrapper 的 initServlet 方法中衔肢，這個(gè)方法很簡(jiǎn)單就是調(diào)用 Servlet 的 init 的方法庄岖，同時(shí)把包裝了 StandardWrapper 對(duì)象的 StandardWrapperFacade 作為 ServletConfig 傳給 Servlet。Tomcat 容器為何要傳 StandardWrapperFacade 給 Servlet 對(duì)象將在后面做詳細(xì)解析膀懈。
如果該 Servlet 關(guān)聯(lián)的是一個(gè) jsp 文件顿锰，那么前面初始化的就是 JspServlet，接下去會(huì)模擬一次簡(jiǎn)單請(qǐng)求，請(qǐng)求調(diào)用這個(gè) jsp 文件硼控，以便編譯這個(gè) jsp 文件為 class刘陶，并初始化這個(gè) class。
這樣 Servlet 對(duì)象就初始化完成了牢撼，事實(shí)上 Servlet 從被 web.xml 中解析到完成初始化匙隔，這個(gè)過(guò)程非常復(fù)雜，中間有很多過(guò)程熏版，包括各種容器狀態(tài)的轉(zhuǎn)化引起的監(jiān)聽(tīng)事件的觸發(fā)纷责、各種訪問(wèn)權(quán)限的控制和一些不可預(yù)料的錯(cuò)誤發(fā)生的判斷行為等等。我們這里只抓了一些關(guān)鍵環(huán)節(jié)進(jìn)行闡述撼短，試圖讓大家有個(gè)總體脈絡(luò)再膳。
下面是這個(gè)過(guò)程的一個(gè)完整的時(shí)序圖曲横，其中也省略了一些細(xì)節(jié)。
圖 4. 初始化 Servlet 的時(shí)序圖（查看大圖）

圖 4. 初始化 Servlet 的時(shí)序圖

Servlet 體系結(jié)構(gòu)

我們知道 Java Web 應(yīng)用是基于 Servlet 規(guī)范運(yùn)轉(zhuǎn)的灾杰，那么 Servlet 本身又是如何運(yùn)轉(zhuǎn)的呢熙参？為何要設(shè)計(jì)這樣的體系結(jié)構(gòu)。
圖 5.Servlet 頂層類關(guān)聯(lián)圖

圖 5.Servlet 頂層類關(guān)聯(lián)圖

圖 6. ServletConfig 在容器中的類關(guān)聯(lián)圖

圖 7.Request 相關(guān)類結(jié)構(gòu)圖

圖 8.Request 和 Response 的轉(zhuǎn)變過(guò)程

圖 9.Request 的 Mapper 類關(guān)系圖

public void init() { 
       findDefaultHost(); 
       Engine engine = (Engine) 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); 
           } 
       } 
}

這段代碼的作用就是將 MapperListener 類作為一個(gè)監(jiān)聽(tīng)者加到整個(gè) Container 容器中的每個(gè)子容器中掌猛，這樣只要任何一個(gè)容器發(fā)生變化荔茬，MapperListener 都將會(huì)被通知，相應(yīng)的保存容器關(guān)系的 MapperListener 的 mapper 屬性也會(huì)修改坊萝。for 循環(huán)中就是將 host 及下面的子容器注冊(cè)到 mapper 中十偶。
圖 10.Request 在容器中的路由圖

圖 10.Request 在容器中的路由圖

1. 基于 URL Path Parameter舔腾，默認(rèn)就支持
2. 基于 Cookie，如果你沒(méi)有修改 Context 容器個(gè) cookies 標(biāo)識(shí)的話肢娘，默認(rèn)也是支持的
3. 基于 SSL撬陵，默認(rèn)不支持，只有 connector.getAttribute("SSLEnabled")為 TRUE 時(shí)才支持

第一種情況下贱枣，當(dāng)瀏覽器不支持 Cookie 功能時(shí)吼句，瀏覽器會(huì)將用戶的 SessionCookieName 重寫(xiě)到用戶請(qǐng)求的 URL 參數(shù)中逢捺，它的傳遞格式如 /path/Servlet;name=value;name2=value2? Name3=value3辉巡，其中“Servlet;”后面的 K-V 對(duì)就是要傳遞的 Path Parameters郊楣，服務(wù)器會(huì)從這個(gè) Path Parameters 中拿到用戶配置的 SessionCookieName郎逃。關(guān)于這個(gè) SessionCookieName伦吠，如果你在 web.xml 中配置 session-config 配置項(xiàng)的話衡怀，其 cookie-config 下的 name 屬性就是這個(gè) SessionCookieName 值棍矛，如果你沒(méi)有配置 session-config 配置項(xiàng)，默認(rèn)的 SessionCookieName 就是大家熟悉的“JSESSIONID”抛杨。接著 Request 根據(jù)這個(gè) SessionCookieName 到 Parameters 拿到 Session ID 并設(shè)置到 request.setRequestedSessionId 中够委。
請(qǐng)注意如果客戶端也支持 Cookie 的話，Tomcat 仍然會(huì)解析 Cookie 中的 Session ID怖现，并會(huì)覆蓋 URL 中的 Session ID茁帽。
如果是第三種情況的話將會(huì)根據(jù) javax.servlet.request.ssl_session 屬性值設(shè)置 Session ID。
有了 Session ID 服務(wù)器端就可以創(chuàng)建 HttpSession 對(duì)象了屈嗤，第一次觸發(fā)是通過(guò) request. getSession() 方法潘拨，如果當(dāng)前的 Session ID 還沒(méi)有對(duì)應(yīng)的 HttpSession 對(duì)象那么就創(chuàng)建一個(gè)新的，并將這個(gè)對(duì)象加到org.apache.catalina. Manager 的 sessions 容器中保存饶号，Manager 類將管理所有 Session 的生命周期铁追，Session 過(guò)期將被回收，服務(wù)器關(guān)閉茫船，Session 將被序列化到磁盤(pán)等脂信。只要這個(gè) HttpSession 對(duì)象存在癣蟋，用戶就可以根據(jù) Session ID 來(lái)獲取到這個(gè)對(duì)象，也就達(dá)到了狀態(tài)的保持狰闪。
圖 11.Session 相關(guān)類圖

圖 11.Session 相關(guān)類圖

圖 12.Session 工作的時(shí)序圖

圖 13.Servlet 中的 Listener

總結(jié)

本文涉及到內(nèi)容有點(diǎn)多防楷，要把每個(gè)細(xì)節(jié)都說(shuō)清楚，似乎不可能坏逢，本文試著從 Servlet 容器的啟動(dòng)到 Servlet 的初始化域帐，以及 Servlet 的體系結(jié)構(gòu)等這些環(huán)節(jié)中找出一些重點(diǎn)來(lái)講述赘被，目的是能讀者有一個(gè)總體的完整的結(jié)構(gòu)圖是整，同時(shí)也詳細(xì)分析了其中的一些難點(diǎn)問(wèn)題，希望對(duì)大家有所幫助民假。