Servlet 3.0 新特性詳解

Servlet 3.0 新特性概述

Servlet 3.0 做爲 Java EE 6 規範體系中一員，隨着 Java EE 6 規範一塊兒發佈。該版本在前一版本（Servlet 2.5）的基礎上提供了若干新特性用於簡化 Web 應用的開發和部署。其中有幾項特性的引入讓開發者感到很是興奮，同時也得到了 Java 社區的一片讚譽之聲：

1. 異 步處理支持：有了該特性，Servlet 線程再也不須要一直阻塞，直到業務處理完畢才能再輸出響應，最後才結束該 Servlet 線程。在接收到請求以後，Servlet 線程能夠將耗時的操做委派給另外一個線程來完成，本身在不生成響應的狀況下返回至容器。針對業務處理較耗時的狀況，這將大大減小服務器資源的佔用，而且提升 併發處理速度。

2. 新增的註解支持：該版本新增了若干註解，用於簡化 Servlet、過濾器（Filter）和監聽器（Listener）的聲明，這使得 web.xml 部署描述文件從該版本開始再也不是必選的了。

3. 可 插性支持：熟悉 Struts2 的開發者必定會對其經過插件的方式與包括 Spring 在內的各類經常使用框架的整合特性記憶猶新。將相應的插件封裝成 JAR 包並放在類路徑下，Struts2 運行時便能自動加載這些插件。如今 Servlet 3.0 提供了相似的特性，開發者能夠經過插件的方式很方便的擴充已有 Web 應用的功能，而不須要修改原有的應用。

下面咱們將逐一講解這些新特性，經過下面的學習，讀者將可以明晰瞭解 Servlet 3.0 的變化，並可以順利使用它進行平常的開發工做。

異步處理支持

Servlet 3.0 以前，一個普通 Servlet 的主要工做流程大體以下：首先，Servlet 接收到請求以後，可能須要對請求攜帶的數據進行一些預處理；接着，調用業務接口的某些方法，以完成業務處理；最後，根據處理的結果提交響 應，Servlet 線程結束。其中第二步的業務處理一般是最耗時的，這主要體如今數據庫操做，以及其它的跨網絡調用等，在此過程當中，Servlet 線程一直處於阻塞狀態，直到業務方法執行完畢。在處理業務的過程當中，Servlet 資源一直被佔用而得不到釋放，對於併發較大的應用，這有可能形成性能的瓶頸。對此，在之前一般是採用私有解決方案來提早結束 Servlet 線程，並及時釋放資源。

Servlet 3.0 針對這個問題作了開創性的工做，如今經過使用 Servlet 3.0 的異步處理支持，以前的 Servlet 處理流程能夠調整爲以下的過程：首先，Servlet 接收到請求以後，可能首先須要對請求攜帶的數據進行一些預處理；接着，Servlet 線程將請求轉交給一個異步線程來執行業務處理，線程自己返回至容器，此時 Servlet 尚未生成響應數據，異步線程處理完業務之後，能夠直接生成響應數據（異步線程擁有 ServletRequest 和 ServletResponse 對象的引用），或者將請求繼續轉發給其它 Servlet。如此一來， Servlet 線程再也不是一直處於阻塞狀態以等待業務邏輯的處理，而是啓動異步線程以後能夠當即返回。

異步處理特性能夠應用於 Servlet 和過濾器兩種組件，因爲異步處理的工做模式和普通工做模式在實現上有着本質的區別，所以默認狀況下，Servlet 和過濾器並無開啓異步處理特性，若是但願使用該特性，則必須按照以下的方式啓用：

1. 對 於使用傳統的部署描述文件 (web.xml) 配置 Servlet 和過濾器的狀況，Servlet 3.0 爲 <servlet> 和 <filter> 標籤增長了 <async-supported> 子標籤，該標籤的默認取值爲 false，要啓用異步處理支持，則將其設爲 true 便可。以 Servlet 爲例，其配置方式以下所示：

   <servlet> 
       <servlet-name>DemoServlet</servlet-name> 
       <servlet-class>footmark.servlet.Demo Servlet</servlet-class> 
       <async-supported>true</async-supported> 
   </servlet>

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();

        //在子線程中執行業務調用，並由其負責輸出響應，主線程退出
        AsyncContext ctx = req.startAsync();
        new Thread(new Executor(ctx)).start();

        out.println("結束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 {
            //等待十秒鐘，以模擬業務方法的執行
            Thread.sleep(10000);
            PrintWriter out = ctx.getResponse().getWriter();
            out.println("業務處理完畢的時間：" + new Date() + ".");
            out.flush();
            ctx.complete();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

除此以外，Servlet 3.0 還爲異步處理提供了一個監聽器，使用 AsyncListener 接口表示。它能夠監控以下四種事件：

1. 異步線程開始時，調用 AsyncListener 的 onStartAsync(AsyncEvent event) 方法；

2. 異步線程出錯時，調用 AsyncListener 的 onError(AsyncEvent event) 方法；

3. 異步線程執行超時，則調用 AsyncListener 的 onTimeout(AsyncEvent event) 方法；

4. 異步執行完畢時，調用 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 的頂層標籤 <web-app> 有一個 metadata-complete 屬性，該屬性指定當前的部署描述文件是不是徹底的。若是設置爲 true，則容器在部署時將只依賴部署描述文件，忽略全部的註解（同時也會跳過 web-fragment.xml 的掃描，亦即禁用可插性支持，具體請看後文關於 可插性支持的講解）；若是不配置該屬性，或者將其設置爲 false，則表示啓用註解支持（和可插性支持）。

@WebServlet

@WebServlet 用於將一個類聲明爲 Servlet，該註解將會在部署時被容器處理，容器將根據具體的屬性配置將相應的類部署爲 Servlet。該註解具備下表給出的一些經常使用屬性（如下全部屬性均爲可選屬性，可是 vlaue 或者 urlPatterns 一般是必需的，且兩者不能共存，若是同時指定，一般是忽略 value 的取值）：

表 1. @WebServlet 主要屬性列表

屬性名	類型	描述
name	String	指定 Servlet 的 name 屬性，等價於 <servlet-name>。若是沒有顯式指定，則該 Servlet 的取值即爲類的全限定名。
value	String[]	該屬性等價於 urlPatterns 屬性。兩個屬性不能同時使用。
urlPatterns	String[]	指定一組 Servlet 的 URL 匹配模式。等價於 <url-pattern> 標籤。
loadOnStartup	int	指定 Servlet 的加載順序，等價於 <load-on-startup> 標籤。
initParams	WebInitParam[]	指定一組 Servlet 初始化參數，等價於 <init-param> 標籤。
asyncSupported	boolean	聲明 Servlet 是否支持異步操做模式，等價於 <async-supported> 標籤。
description	String	該 Servlet 的描述信息，等價於 <description> 標籤。
displayName	String	該 Servlet 的顯示名，一般配合工具使用，等價於 <display-name> 標籤。

下面是一個簡單的示例：

@WebServlet(urlPatterns = {"/simple"}, asyncSupported = true, 
loadOnStartup = -1, name = "SimpleServlet", displayName = "ss", 
initParams = {@WebInitParam(name = "username", value = "tom")} 
) 
public class SimpleServlet extends HttpServlet{ … }

如此配置以後，就能夠沒必要在 web.xml 中配置相應的 <servlet> 和 <servlet-mapping> 元素了，容器會在部署時根據指定的屬性將該類發佈爲 Servlet。它的等價的 web.xml 配置形式以下：

<servlet>
    <display-name>ss</display-name>
    <servlet-name>SimpleServlet</servlet-name>
    <servlet-class>footmark.servlet.SimpleServlet</servlet-class>
    <load-on-startup>-1</load-on-startup>
    <async-supported>true</async-supported>
    <init-param>
        <param-name>username</param-name>
        <param-value>tom</param-value>
    </init-param>
</servlet>
<servlet-mapping>
    <servlet-name>SimpleServlet</servlet-name>
    <url-pattern>/simple</url-pattern>
</servlet-mapping>

@WebInitParam

該 註解一般不單獨使用，而是配合 @WebServlet 或者 @WebFilter 使用。它的做用是爲 Servlet 或者過濾器指定初始化參數，這等價於 web.xml 中 <servlet> 和 <filter> 的 <init-param> 子標籤。@WebInitParam 具備下表給出的一些經常使用屬性：

表 2. @WebInitParam 的經常使用屬性

屬性名	類型	是否可選	描述
name	String	否	指定參數的名字，等價於 <param-name>。
value	String	否	指定參數的值，等價於 <param-value>。
description	String	是	關於參數的描述，等價於 <description>。

@WebFilter

@WebFilter 用於將一個類聲明爲過濾器，該註解將會在部署時被容器處理，容器將根據具體的屬性配置將相應的類部署爲過濾器。該註解具備下表給出的一些經常使用屬性 ( 如下全部屬性均爲可選屬性，可是 value、urlPatterns、servletNames 三者必需至少包含一個，且 value 和 urlPatterns 不能共存，若是同時指定，一般忽略 value 的取值 )：

表 3. @WebFilter 的經常使用屬性

屬性名	類型	描述
filterName	String	指定過濾器的 name 屬性，等價於 <filter-name>
value	String[]	該屬性等價於 urlPatterns 屬性。可是二者不該該同時使用。
urlPatterns	String[]	指定一組過濾器的 URL 匹配模式。等價於 <url-pattern> 標籤。
servletNames	String[]	指定過濾器將應用於哪些 Servlet。取值是 @WebServlet 中的 name 屬性的取值，或者是 web.xml 中 <servlet-name> 的取值。
dispatcherTypes	DispatcherType	指定過濾器的轉發模式。具體取值包括： ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。
initParams	WebInitParam[]	指定一組過濾器初始化參數，等價於 <init-param> 標籤。
asyncSupported	boolean	聲明過濾器是否支持異步操做模式，等價於 <async-supported> 標籤。
description	String	該過濾器的描述信息，等價於 <description> 標籤。
displayName	String	該過濾器的顯示名，一般配合工具使用，等價於 <display-name> 標籤。

下面是一個簡單的示例：

@WebFilter(servletNames = {"SimpleServlet"},filterName="SimpleFilter") 
public class LessThanSixFilter implements Filter{...}

如此配置以後，就能夠沒必要在 web.xml 中配置相應的 <filter> 和 <filter-mapping> 元素了，容器會在部署時根據指定的屬性將該類發佈爲過濾器。它等價的 web.xml 中的配置形式爲：

<filter> 
    <filter-name>SimpleFilter</filter-name> 
    <filter-class>xxx</filter-class> 
</filter> 
<filter-mapping> 
    <filter-name>SimpleFilter</filter-name> 
    <servlet-name>SimpleServlet</servlet-name> 
</filter-mapping>

@WebListener

該註解用於將類聲明爲監聽器，被 @WebListener 標註的類必須實現如下至少一個接口：

• ServletContextListener

• ServletContextAttributeListener

• ServletRequestListener

• ServletRequestAttributeListener

• HttpSessionListener

• HttpSessionAttributeListener

該註解使用很是簡單，其屬性以下：

表 4. @WebListener 的經常使用屬性

屬性名	類型	是否可選	描述
value	String	是	該監聽器的描述信息。

一個簡單示例以下：

@WebListener("This is only a demo listener") 
public class SimpleListener implements ServletContextListener{...}

如此，則不須要在 web.xml 中配置 <listener> 標籤了。它等價的 web.xml 中的配置形式以下：

<listener> 
    <listener-class>footmark.servlet.SimpleListener</listener-class> 
</listener>

@MultipartConfig

該 註解主要是爲了輔助 Servlet 3.0 中 HttpServletRequest 提供的對上傳文件的支持。該註解標註在 Servlet 上面，以表示該 Servlet 但願處理的請求的 MIME 類型是 multipart/form-data。另外，它還提供了若干屬性用於簡化對上傳文件的處理。具體以下：

表 5. @MultipartConfig 的經常使用屬性

屬性名	類型	是否可選	描述
fileSizeThreshold	int	是	當數據量大於該值時，內容將被寫入文件。
location	String	是	存放生成的文件地址。
maxFileSize	long	是	容許上傳的文件最大值。默認值爲 -1，表示沒有限制。
maxRequestSize	long	是	針對該 multipart/form-data 請求的最大數量，默認值爲 -1，表示沒有限制。

可插性支持

若是說 3.0 版本新增的註解支持是爲了簡化 Servlet/ 過濾器 / 監聽器的聲明，從而使得 web.xml 變爲可選配置， 那麼新增的可插性 (pluggability) 支持則將 Servlet 配置的靈活性提高到了新的高度。熟悉 Struts2 的開發者都知道，Struts2 經過插件的形式提供了對包括 Spring 在內的各類開發框架的支持，開發者甚至能夠本身爲 Struts2 開發插件，而 Servlet 的可插性支持正是基於這樣的理念而產生的。使用該特性，如今咱們能夠在不修改已有 Web 應用的前提下，只需將按照必定格式打成的 JAR 包放到 WEB-INF/lib 目錄下，便可實現新功能的擴充，不須要額外的配置。

Servlet 3.0 引入了稱之爲「Web 模塊部署描述符片斷」的 web-fragment.xml 部署描述文件，該文件必須存放在 JAR 文件的 META-INF 目錄下，該部署描述文件能夠包含一切能夠在 web.xml 中定義的內容。JAR 包一般放在 WEB-INF/lib 目錄下，除此以外，全部該模塊使用的資源，包括 class 文件、配置文件等，只須要可以被容器的類加載器鏈加載的路徑上，好比 classes 目錄等。

如今，爲一個 Web 應用增長一個 Servlet 配置有以下三種方式 ( 過濾器、監聽器與 Servlet 三者的配置都是等價的，故在此以 Servlet 配置爲例進行講述，過濾器和監聽器具備與之很是相似的特性 )：

• 編寫一個類繼承自 HttpServlet，將該類放在 classes 目錄下的對應包結構中，修改 web.xml，在其中增長一個 Servlet 聲明。這是最原始的方式；

• 編寫一個類繼承自 HttpServlet，而且在該類上使用 @WebServlet 註解將該類聲明爲 Servlet，將該類放在 classes 目錄下的對應包結構中，無需修改 web.xml 文件。

• 編寫一個類繼承自 HttpServlet，將該類打成 JAR 包，而且在 JAR 包的 META-INF 目錄下放置一個 web-fragment.xml 文件，該文件中聲明瞭相應的 Servlet 配置。web-fragment.xml 文件示例以下：

<?xml version="1.0" encoding="UTF-8"?>
<web-fragment 
    xmlns=http://java.sun.com/xml/ns/javaee
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="3.0"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
    http://java.sun.com/xml/ns/javaee/web-fragment_3_0.xsd"
    metadata-complete="true">
    <servlet>
        <servlet-name>fragment</servlet-name>
        <servlet-class>footmark.servlet.FragmentServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>fragment</servlet-name>
        <url-pattern>/fragment</url-pattern>
    </servlet-mapping>
</web-fragment>

從上面的示例能夠看出，web-fragment.xml 與 web.xml 除了在頭部聲明的 XSD 引用不一樣以外，其主體配置與 web.xml 是徹底一致的。

因爲一個 Web 應用中能夠出現多個 web-fragment.xml 聲明文件，加上一個 web.xml 文件，加載順序問題便成了不起不面對的問題。Servlet 規範的專家組在設計的時候已經考慮到了這個問題，並定義了加載順序的規則。

web-fragment.xml 包含了兩個可選的頂層標籤，<name> 和 <ordering>，若是但願爲當前的文件指定明確的加載順序，一般須要使用這兩個標籤，<name> 主要用於標識當前的文件，而 <ordering> 則用於指定前後順序。一個簡單的示例以下：

<web-fragment...>
    <name>FragmentA</name>
    <ordering>
        <after>
            <name>FragmentB</name>
            <name>FragmentC</name>
        </after>
    <before>
        <others/>
    </before>
    </ordering>
    ...
</web-fragment>

如上所示， <name> 標籤的取值一般是被其它 web-fragment.xml 文件在定義前後順序時引用的，在當前文件中通常用不着，它起着標識當前文件的做用。

在 <ordering> 標籤內部，咱們能夠定義當前 web-fragment.xml 文件與其餘文件的相對位置關係，這主要經過 <ordering> 的 <after> 和 <before> 子標籤來實現的。在這兩個子標籤內部能夠經過 <name> 標籤來指定相對應的文件。好比：

<after> 
    <name>FragmentB</name> 
    <name>FragmentC</name> 
</after>

以上片斷則表示當前文件必須在 FragmentB 和 FragmentC 以後解析。<before> 的使用於此相同，它所表示的是當前文件必須早於 <before> 標籤裏所列出的 web-fragment.xml 文件。

除 了將所比較的文件經過 <name> 在 <after> 和 <begin> 中列出以外，Servlet 還提供了一個簡化的標籤 <others/>。它表示除了當前文件以外的其餘全部的 web-fragment.xml 文件。該標籤的優先級要低於使用 <name> 明確指定的相對位置關係。

ServletContext 的性能加強

除了以上的新特性以外，ServletContext 對象的功能在新版本中也獲得了加強。如今，該對象支持在運行時動態部署 Servlet、過濾器、監聽器，以及爲 Servlet 和過濾器增長 URL 映射等。以 Servlet 爲例，過濾器與監聽器與之相似。ServletContext 爲動態配置 Servlet 增長了以下方法：

• ServletRegistration.Dynamic addServlet(String servletName,Class<? extends Servlet> servletClass)

• ServletRegistration.Dynamic addServlet(String servletName, Servlet servlet)

• ServletRegistration.Dynamic addServlet(String servletName, String className)

• <T extends Servlet> T createServlet(Class<T> clazz)

• ServletRegistration getServletRegistration(String servletName)

• Map<String,? extends ServletRegistration> getServletRegistrations()

其 中前三個方法的做用是相同的，只是參數類型不一樣而已；經過 createServlet() 方法建立的 Servlet，一般須要作一些自定義的配置，而後使用 addServlet() 方法來將其動態註冊爲一個能夠用於服務的 Servlet。兩個 getServletRegistration() 方法主要用於動態爲 Servlet 增長映射信息，這等價於在 web.xml( 抑或 web-fragment.xml) 中使用 <servlet-mapping> 標籤爲存在的 Servlet 增長映射信息。

以 上 ServletContext 新增的方法要麼是在 ServletContextListener 的 contexInitialized 方法中調用，要麼是在 ServletContainerInitializer 的 onStartup() 方法中調用。

ServletContainerInitializer 也是 Servlet 3.0 新增的一個接口，容器在啓動時使用 JAR 服務 API(JAR Service API) 來發現 ServletContainerInitializer 的實現類，而且容器將 WEB-INF/lib 目錄下 JAR 包中的類都交給該類的 onStartup() 方法處理，咱們一般須要在該實現類上使用 @HandlesTypes 註解來指定但願被處理的類，過濾掉不但願給 onStartup() 處理的類。

HttpServletRequest 對文件上傳的支持

此前，對於處理上傳文件的操做一直是讓開發者 頭疼的問題，由於 Servlet 自己沒有對此提供直接的支持，須要使用第三方框架來實現，並且使用起來也不夠簡單。現在這都成爲了歷史，Servlet 3.0 已經提供了這個功能，並且使用也很是簡單。爲此，HttpServletRequest 提供了兩個方法用於從請求中解析出上傳的文件：

• Part getPart(String name)

• Collection<Part> getParts()

前 者用於獲取請求中給定 name 的文件，後者用於獲取全部的文件。每個文件用一個 javax.servlet.http.Part 對象來表示。該接口提供了處理文件的簡易方法，好比 write()、delete() 等。至此，結合 HttpServletRequest 和 Part 來保存上傳的文件變得很是簡單，以下所示：

Part photo = request.getPart("photo"); 
photo.write("/tmp/photo.jpg"); 
// 能夠將兩行代碼簡化爲 request.getPart("photo").write("/tmp/photo.jpg") 一行。

另外，開發者能夠配合前面提到的 @MultipartConfig 註解來對上傳操做進行一些自定義的配置，好比限制上傳文件的大小，以及保存文件的路徑等。其用法很是簡單，故不在此贅述了。

須要注意的是，若是請求的 MIME 類型不是 multipart/form-data，則不能使用上面的兩個方法，不然將拋異常。

原文地址：http://www.ibm.com/developerworks/cn/java/j-lo-servlet30/