開發十年，就只剩下這套架構體系了！ >>>   

一、Servlet 3.0 新特性詳解

1.1 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 的變化，並能夠順利使用它進行日常的開發工作。

1.2 非同步處理支援

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 示例如下： ```JAVA @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 { 
        // 做一些清理工作或者其他
    }
    ...
});

1.3 新增的註解支援

Servlet 3.0 的部署描述檔案 web.xml 的頂層標籤 <web-app> 有一個 metadata-complete 屬性，該屬性指定當前的部署描述檔案是否是完全的。如果設定為 true，則容器在部署時將只依賴部署描述檔案，忽略所有的註解（同時也會跳過 web-fragment.xml 的掃描，亦即禁用可插性支援，具體請看後文關於 可插性支援的講解）；如果不配置該屬性，或者將其設定為 false，則表示啟用註解支援（和可插性支援）。

1.3.1 @WebServlet

@WebServlet 用於將一個類宣告為 Servlet，該註解將會在部署時被容器處理，容器將根據具體的屬性配置將相應的類部署為 Servlet。該註解具有下表給出的一些常用屬性（以下所有屬性均為可選屬性，但是 vlaue 或者 urlPatterns 通常是必需的，且二者不能共存，如果同時指定，通常是忽略 value 的取值）：

表 1. @WebServlet 主要屬性列表

下面是一個簡單的示例：

@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>

1.3.2 @WebInitParam

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

表 2. @WebInitParam 的常用屬性

1.3.3 @WebFilter

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

表 3. @WebFilter 的常用屬性

下面是一個簡單的示例：

@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>

1.3.4 @WebListener

該註解用於將類宣告為監聽器，被 @WebListener 標註的類必須實現以下至少一個介面：

• ServletContextListener
• ServletContextAttributeListener
• ServletRequestListener
• ServletRequestAttributeListener
• HttpSessionListener
• HttpSessionAttributeListener

該註解使用非常簡單，其屬性如下：

表 4. @WebListener 的常用屬性

一個簡單示例如下：

@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>

1.3.5 @MultipartConfig

該註解主要是為了輔助 Servlet 3.0 中 HttpServletRequest 提供的對上傳檔案的支援。該註解標註在 Servlet 上面，以表示該 Servlet 希望處理的請求的 MIME 型別是 multipart/form-data。另外，它還提供了若干屬性用於簡化對上傳檔案的處理。具體如下：

表 5. @MultipartConfig 的常用屬性

1.4 可插性支援

如果說 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> 明確指定的相對位置關係。

1.5 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() 處理的類。

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

1.7 總結

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

1.7.1 相關主題

• JSR-000315 Java Servlet 3.0 規範：這裡除了可以下載 Servlet 3.0 的規範文件，還可以瞭解關於與該規範相關的一些其他資訊。
• GlassFish 專案主頁：可以在這裡現在 GlassFish V3 版本，這是 SUN 提供的 Java EE 6 規範的參考實現。
• “Servlet 2.2 的新特徵”（developerWorks，2000 年 12 月）：討論 Servlet 2.2 一些新的比較重要的特徵，並給出了一些簡單的例子來演示這些特徵的用途及用法。
• developerWorks Java 技術專區：數百篇關於 Java 程式設計各個方面的文章。

轉自：https://www.ibm.com/developerworks/cn/java/j-lo-servlet30/index.ht