Servlet3.0新規(guī)范.doc

簡介：Servlet 是 Java EE 規(guī)范體系的重要組成部分，也是 Java 開發(fā)人員必須具備的基礎技能，Servlet 3.0 是 Servlet 規(guī)范的最新版本。本文主要介紹了 Servlet 3.0 引入的若干重要新特性，包括異步處理、新增的注解支持、可插性支持等等，為讀者順利向新版本過渡掃清障礙。Servlet 3.0 新特性概述Servlet 3.0 作為 Java EE 6 規(guī)范體系中一員，隨著 Java EE 6 規(guī)范一起發(fā)布。該版本在前一版本（Servlet 2.5）的基礎上提供了若干新特性用于簡化 Web 應用的開發(fā)和部署。其中有幾項特性的引入讓開發(fā)者感到非常興奮，同時也獲得了 Java 社區(qū)的一片贊譽之聲：1. 異步處理支持：有了該特性，Servlet 線程不再需要一直阻塞，直到業(yè)務處理完畢才能再輸出響應，最后才結(jié)束該 Servlet 線程。在接收到請求之后，Servlet 線程可以將耗時的操作委派給另一個線程來完成，自己在不生成響應的情況下返回至容器。針對業(yè)務處理較耗時的情況，這將大大減少服務器資源的占用，并且提高并發(fā)處理速度。2. 新增的注解支持：該版本新增了若干注解，用于簡化 Servlet、過濾器（Filter）和監(jiān)聽器（Listener）的聲明，這使得 web.xml 部署描述文件從該版本開始不再是必選的了。3. 可插性支持：熟悉 Struts2 的開發(fā)者一定會對其通過插件的方式與包括 Spring 在內(nèi)的各種常用框架的整合特性記憶猶新。將相應的插件封裝成 JAR 包并放在類路徑下，Struts2 運行時便能自動加載這些插件?，F(xiàn)在 Servlet 3.0 提供了類似的特性，開發(fā)者可以通過插件的方式很方便的擴充已有 Web 應用的功能，而不需要修改原有的應用。下面我們將逐一講解這些新特性，通過下面的學習，讀者將能夠明晰了解 Servlet 3.0 的變化，并能夠順利使用它進行日常的開發(fā)工作。回頁首異步處理支持Servlet 3.0 之前，一個普通 Servlet 的主要工作流程大致如下：首先，Servlet 接收到請求之后，可能需要對請求攜帶的數(shù)據(jù)進行一些預處理；接著，調(diào)用業(yè)務接口的某些方法，以完成業(yè)務處理；最后，根據(jù)處理的結(jié)果提交響應，Servlet 線程結(jié)束。其中第二步的業(yè)務處理通常是最耗時的，這主要體現(xiàn)在數(shù)據(jù)庫操作，以及其它的跨網(wǎng)絡調(diào)用等，在此過程中，Servlet 線程一直處于阻塞狀態(tài)，直到業(yè)務方法執(zhí)行完畢。在處理業(yè)務的過程中，Servlet 資源一直被占用而得不到釋放，對于并發(fā)較大的應用，這有可能造成性能的瓶頸。對此，在以前通常是采用私有解決方案來提前結(jié)束 Servlet 線程，并及時釋放資源。Servlet 3.0 針對這個問題做了開創(chuàng)性的工作，現(xiàn)在通過使用 Servlet 3.0 的異步處理支持，之前的 Servlet 處理流程可以調(diào)整為如下的過程：首先，Servlet 接收到請求之后，可能首先需要對請求攜帶的數(shù)據(jù)進行一些預處理；接著，Servlet 線程將請求轉(zhuǎn)交給一個異步線程來執(zhí)行業(yè)務處理，線程本身返回至容器，此時 Servlet 還沒有生成響應數(shù)據(jù)，異步線程處理完業(yè)務以后，可以直接生成響應數(shù)據(jù)（異步線程擁有 ServletRequest 和 ServletResponse 對象的引用），或者將請求繼續(xù)轉(zhuǎn)發(fā)給其它 Servlet。如此一來， Servlet 線程不再是一直處于阻塞狀態(tài)以等待業(yè)務邏輯的處理，而是啟動異步線程之后可以立即返回。異步處理特性可以應用于 Servlet 和過濾器兩種組件，由于異步處理的工作模式和普通工作模式在實現(xiàn)上有著本質(zhì)的區(qū)別，因此默認情況下，Servlet 和過濾器并沒有開啟異步處理特性，如果希望使用該特性，則必須按照如下的方式啟用：1. 對于使用傳統(tǒng)的部署描述文件 (web.xml) 配置 Servlet 和過濾器的情況，Servlet 3.0 為 和 標簽增加了 子標簽，該標簽的默認取值為 false，要啟用異步處理支持，則將其設為 true 即可。以 Servlet 為例，其配置方式如下所示： DemoServlet footmark.servlet.Demo Servlet true 2. 對于使用 Servlet 3.0 提供的 WebServlet 和 WebFilter 進行 Servlet 或過濾器配置的情況，這兩個注解都提供了 asyncSupported 屬性，默認該屬性的取值為 false，要啟用異步處理支持，只需將該屬性設置為 true 即可。以 WebFilter 為例，其配置方式如下所示：WebFilter(urlPatterns = /demo,asyncSupported = true) public class DemoFilter implements Filter. 一個簡單的模擬異步處理的 Servlet 示例如下：WebServlet(urlPatterns = /demo, asyncSupported = true)public class AsyncDemoServlet extends HttpServlet Override public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException, ServletException resp.setContentType(text/html;charset=UTF-8); PrintWriter out = resp.getWriter(); out.println(進入Servlet的時間： + new Date() + .); out.flush(); /在子線程中執(zhí)行業(yè)務調(diào)用，并由其負責輸出響應，主線程退出 AsyncContext ctx = req.startAsync(); new Thread(new Executor(ctx).start(); out.println(結(jié)束Servlet的時間： + new Date() + .); out.flush(); public class Executor implements Runnable private AsyncContext ctx = null; public Executor(AsyncContext ctx) this.ctx = ctx; public void run() try /等待十秒鐘，以模擬業(yè)務方法的執(zhí)行 Thread.sleep(10000); PrintWriter out = ctx.getResponse().getWriter(); out.println(業(yè)務處理完畢的時間： + new Date() + .); out.flush(); plete(); catch (Exception e) e.printStackTrace(); 除此之外，Servlet 3.0 還為異步處理提供了一個監(jiān)聽器，使用 AsyncListener 接口表示。它可以監(jiān)控如下四種事件：1. 異步線程開始時，調(diào)用 AsyncListener 的 onStartAsync(AsyncEvent event) 方法；2. 異步線程出錯時，調(diào)用 AsyncListener 的 onError(AsyncEvent event) 方法；3. 異步線程執(zhí)行超時，則調(diào)用 AsyncListener 的 onTimeout(AsyncEvent event) 方法；4. 異步執(zhí)行完畢時，調(diào)用 AsyncListener 的 onComplete(AsyncEvent event) 方法；要注冊一個 AsyncListener，只需將準備好的 AsyncListener 對象傳遞給 AsyncContext 對象的 addListener() 方法即可，如下所示：AsyncContext ctx = req.startAsync(); ctx.addListener(new AsyncListener() public void onComplete(AsyncEvent asyncEvent) throws IOException / 做一些清理工作或者其他 . ); 回頁首新增的注解支持Servlet 3.0 的部署描述文件 web.xml 的頂層標簽 有一個 metadata-complete 屬性，該屬性指定當前的部署描述文件是否是完全的。如果設置為 true，則容器在部署時將只依賴部署描述文件，忽略所有的注解（同時也會跳過 web-fragment.xml 的掃描，亦即禁用可插性支持，具體請看后文關于可插性支持的講解）；如果不配置該屬性，或者將其設置為 false，則表示啟用注解支持（和可插性支持）。WebServletWebServlet 用于將一個類聲明為 Servlet，該注解將會在部署時被容器處理，容器將根據(jù)具體的屬性配置將相應的類部署為 Servlet。該注解具有下表給出的一些常用屬性（以下所有屬性均為可選屬性，但是 vlaue 或者 urlPatterns 通常是必需的，且二者不能共存，如果同時指定，通常是忽略 value 的取值）：表 1. WebServlet 主要屬性列表屬性名類型描述nameString指定 Servlet 的 name 屬性，等價于 。如果沒有顯式指定，則該 Servlet 的取值即為類的全限定名。valueString該屬性等價于 urlPatterns 屬性。兩個屬性不能同時使用。urlPatternsString指定一組 Servlet 的 URL 匹配模式。等價于 標簽。loadOnStartupint指定 Servlet 的加載順序，等價于 標簽。initParamsWebInitParam指定一組 Servlet 初始化參數(shù)，等價于 標簽。asyncSupportedboolean聲明 Servlet 是否支持異步操作模式，等價于 標簽。descriptionString該 Servlet 的描述信息，等價于 標簽。displayNameString該 Servlet 的顯示名，通常配合工具使用，等價于 標簽。下面是一個簡單的示例：WebServlet(urlPatterns = /simple, asyncSupported = true, loadOnStartup = -1, name = SimpleServlet, displayName = ss, initParams = WebInitParam(name = username, value = tom) ) public class SimpleServlet extends HttpServlet 如此配置之后，就可以不必在 web.xml 中配置相應的 和 元素了，容器會在部署時根據(jù)指定的屬性將該類發(fā)布為 Servlet。它的等價的 web.xml 配置形式如下： ss SimpleServlet footmark.servlet.SimpleServlet -1 true username tom SimpleServlet /simpleWebInitParam該注解通常不單獨使用，而是配合 WebServlet 或者 WebFilter 使用。它的作用是為 Servlet 或者過濾器指定初始化參數(shù)，這等價于 web.xml 中 和 的 子標簽。WebInitParam 具有下表給出的一些常用屬性：表 2. WebInitParam 的常用屬性屬性名類型是否可選描述nameString否指定參數(shù)的名字，等價于 。valueString否指定參數(shù)的值，等價于 。descriptionString是關于參數(shù)的描述，等價于 。WebFilterWebFilter 用于將一個類聲明為過濾器，該注解將會在部署時被容器處理，容器將根據(jù)具體的屬性配置將相應的類部署為過濾器。該注解具有下表給出的一些常用屬性 ( 以下所有屬性均為可選屬性，但是 value、urlPatterns、servletNames 三者必需至少包含一個，且 value 和 urlPatterns 不能共存，如果同時指定，通常忽略 value 的取值 )：表 3. WebFilter 的常用屬性屬性名類型描述filterNameString指定過濾器的 name 屬性，等價于 valueString該屬性等價于 urlPatterns 屬性。但是兩者不應該同時使用。urlPatternsString指定一組過濾器的 URL 匹配模式。等價于 標簽。servletNamesString指定過濾器將應用于哪些 Servlet。取值是 WebServlet 中的 name 屬性的取值，或者是 web.xml 中 的取值。dispatcherTypesDispatcherType指定過濾器的轉(zhuǎn)發(fā)模式。具體取值包括：ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。initParamsWebInitParam指定一組過濾器初始化參數(shù)，等價于 標簽。asyncSupportedboolean聲明過濾器是否支持異步操作模式，等價于 標簽。descriptionString該過濾器的描述信息，等價于 標簽。displayNameString該過濾器的顯示名，通常配合工具使用，等價于 標簽。下面是一個簡單的示例：WebFilter(servletNames = SimpleServlet,filterName=SimpleFilter) public class LessThanSixFilter implements Filter. 如此配置之后，就可以不必在 web.xml 中配置相應的 和 元素了，容器會在部署時根據(jù)指定的屬性將該類發(fā)布為過濾器。它等價的 web.xml 中的配置形式為： SimpleFilter xxx SimpleFilter SimpleServlet WebListener該注解用于將類聲明為監(jiān)聽器，被 WebListener 標注的類必須實現(xiàn)以下至少一個接口： ServletContextListener ServletContextAttributeListener ServletRequestListener ServletRequestAttributeListener HttpSessionListener HttpSessionAttributeListener該注解使用非常簡單，其屬性如下：表 4. WebListener 的常用屬性屬性名類型是否可選描述valueString是該監(jiān)聽器的描述信息。一個簡單示例如下：WebListener(This is only a demo listener) public class SimpleListener implements ServletContextListener. 如此，則不需要在 web.xml 中配置 標簽了。它等價的 web.xml 中的配置形式如下： footmark.servlet.SimpleListener MultipartConfig該注解主要是為了輔助 Servlet 3.0 中 HttpServletRequest 提供的對上傳文件的支持。該注解標注在 Servlet 上面，以表示該 Servlet 希望處理的請求的 MIME 類型是 multipart/form-data。另外，它還提供了若干屬性用于簡化對上傳文件的處理。具體如下：表 5. MultipartConfig 的常用屬性屬性名類型是否可選描述fileSizeThresholdint是當數(shù)據(jù)量大于該值時，內(nèi)容將被寫入文件。locationString是存放生成的文件地址。maxFileSizelong是允許上傳的文件最大值。默認值為 -1，表示沒有限制。maxRequestSizelong是針對該 multipart/form-data 請求的最大數(shù)量，默認值為 -1，表示沒有限制。回頁首可插性支持如果說 3.0 版本新增的注解支持是為了簡化 Servlet/ 過濾器 / 監(jiān)聽器的聲明，從而使得 web.xml 變?yōu)榭蛇x配置， 那么新增的可插性 (pluggability) 支持則將 Servlet 配置的靈活性提升到了新的高度。熟悉 Struts2 的開發(fā)者都知道，Struts2 通過插件的形式提供了對包括 Spring 在內(nèi)的各種開發(fā)框架的支持，開發(fā)者甚至可以自己為 Struts2 開發(fā)插件，而 Servlet 的可插性支持正是基于這樣的理念而產(chǎn)生的。使用該特性，現(xiàn)在我們可以在不修改已有 Web 應用的前提下，只需將按照一定格式打成的 JAR 包放到 WEB-INF/lib 目錄下，即可實現(xiàn)新功能的擴充，不需要額外的配置。Servlet 3.0 引入了稱之為“Web 模塊部署描述符片段”的 web-fragment.xml 部署描述文件，該文件必須存放在 JAR 文件的 META-INF 目錄下，該部署描述文件可以包含一切可以在 web.xml 中定義的內(nèi)容。JAR 包通常放在 WEB-INF/lib 目錄下，除此之外，所有該模塊使用的資源，包括 class 文件、配置文件等，只需要能夠被容器的類加載器鏈加載的路徑上，比如 classes 目錄等?，F(xiàn)在，為一個 Web 應用增加一個 Servlet 配置有如下三種方式 ( 過濾器、監(jiān)聽器與 Servlet 三者的配置都是等價的，故在此以 Servlet 配置為例進行講述，過濾器和監(jiān)聽器具有與之非常類似的特性 )： 編寫一個類繼承自 HttpServlet，將該類放在 classes 目錄下的對應包結(jié)構(gòu)中，修改 web.xml，在其中增加一個 Servlet 聲明。這是最原始的方式； 編寫一個類繼承自 HttpServlet，并且在該類上使用 WebServlet 注解將該類聲明為 Servlet，將該類放在 classes 目錄下的對應包結(jié)構(gòu)中，無需修改 web.xml 文件。 編寫一個類繼承自 HttpServlet，將該類打成 JAR 包，并且在 JAR 包的 META-INF 目錄下放置一個 web-fragment.xml 文件，該文件中聲明了相應的 Servlet 配置。web-fragment.xml 文件示例如下： fragment footmark.servlet.FragmentServlet fragment /fragment 從上面的示例可以看出，web-fragment.xml 與 web.xml 除了在頭部聲明的 XSD 引用不同之外，其主體配置與 web.xml 是完全一致的。由于一個 Web 應用中可以出現(xiàn)多個 web-fragment.xml 聲明文件，加上一個 web.xml 文件，加載順序問題便成了不得不面對的問題。Servlet 規(guī)范的專家組在設計的時候已經(jīng)考慮到了這個問題，并定義了加載順序的規(guī)則。web-fragment.xml 包含了兩個可選的頂層標簽， 和 ，如果希望為當前的文件指定明確的加載順序，通常需要使用這兩個標簽， 主要用于標識當前的文件，而 則用于指定先后順序。一個簡單的示例如下： FragmentA FragmentB FragmentC .如上所示， 標簽的取值通常是被其它 web-fragment.xml 文件在定義先后順序時引用的，在當前文件中一般用不著，它起著標識當前文件的作用。在 標簽內(nèi)部，我們可以定義當前 web-fragment.xml 文件與其他文件的相對位置關系，這主要通過 的 和 子標簽來實現(xiàn)的。在這兩個子標簽內(nèi)部可以通過 標簽來指定相對應的文件。比如： FragmentB FragmentC 以上片段則表示當前文件必須在 FragmentB 和 FragmentC 之后解析。 的使用于此相同，它所表示的是當前文件必須早于 標簽里所列出的 web-fragment.xml 文件。除了將所比較的文件通過 在 和 中列出之外，Servlet 還提供了一個簡化的標簽 。它表示除了當前文件之外的其他所有的 web-fragment.xml 文件。該標簽的優(yōu)先級要低于使用 明確指定的相對位置關系。回頁首ServletContext 的性能增強除了以上的新特性之外，ServletContext 對象的功能在新版本中也得到了增強?，F(xiàn)在，該對象支持在運行時動態(tài)部署 Servlet、過濾器、監(jiān)聽器，以及為 Servlet 和過濾器增加 URL 映射等。以 Servlet 為例，過濾器與監(jiān)聽器與之類似。ServletContext 為動態(tài)配置 Servlet 增加了如下方法： ServletRegistration.Dynamic addServlet(String servletName,Class servletClass) ServletRegistration.Dynamic addServlet(String servletName, Servlet servlet) ServletRegistration.Dynamic addServlet(String servletName, String className) T createServlet(Class clazz) ServletRegistration getServletRegistration(String servletName) Map getServletRegistrations()其中前三個方法的作用是相同的，只是參數(shù)類型不同而已；通過 createServlet() 方法創(chuàng)建的 Servlet，通常需要做一些自定義的配置，然后使用 addServlet() 方法來將其動態(tài)注冊為一個可以用于服務的 Servlet。兩個 getServletRegistration() 方法主要用于動態(tài)為 Servlet 增加映射信息，這等價于在 web.xml( 抑或 web-fragment.xml) 中使用 標簽為存在的 Servlet 增加映射信息。以上 ServletContext 新增的方法要么是在 ServletContextListener 的 contexInitialized 方法中調(diào)用，要么是在 ServletContainerInitializer 的 onStartup() 方法中調(diào)用。ServletContainerInitializer 也是 S