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，則不能使用上面的兩個方法，否則將拋異常。

回頁首

總結

Servlet 3.0 的眾多新特性使得 Servlet 開發變得更加簡單，尤其是異步處理特性和可插性支持的出現，必將對現有的 MVC 框架產生深遠影響。雖然我們通常不會自己去用 Servlet 編寫控制層代碼，但是也許在下一個版本的 Struts 中，您就能切實感受到這些新特性帶來的實質性改變。