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 為例，其配置
方式如下所示：
|
1
2
3
4
5
|
<servlet> <servlet-name>demoservlet</servlet-name> <servlet-class>footmark.servlet.demo servlet</servlet-class> <async-supported>true</async-supported> </servlet> |
對于使用 servlet 3.0 提供的 @webservlet 和 @webfilter 進行 servlet 或過濾器配置的情況，這兩個注解都提供了 asyncsupported 屬性，默認該屬性的取值為 false，要啟用異步處理支持，只需將該屬性設置為 true 即可。以 @webfilter 為例，其配置方式如下所示：
|
1
2
|
@webfilter(urlpatterns = "/demo",asyncsupported = true) public class demofilter implements filter{...} |
一個簡單的模擬異步處理的 servlet 示例如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
@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() 方法即可，如下所示：
|
1
2
3
4
5
6
7
|
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 主要屬性列表
下面是一個簡單的示例：
|
1
2
3
4
5
|
@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 配置形式如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
<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 的常用屬性
@webfilter
@webfilter 用于將一個類聲明為過濾器，該注解將會在部署時被容器處理，容器將根據具體的屬性配置將相應的類部署為過濾器。該注解具有下表給出的一些常用屬性 ( 以下所有屬性均為可選屬性，但是 value、urlpatterns、servletnames 三者必需至少包含一個，且 value 和 urlpatterns 不能共存，如果同時指定，通常忽略 value 的取值 )：
表 3. @webfilter 的常用屬性
下面是一個簡單的示例：
|
1
2
|
@webfilter(servletnames = {"simpleservlet"},filtername="simplefilter") public class lessthansixfilter implements filter{...} |
如此配置之后，就可以不必在 web.xml 中配置相應的 <filter> 和 <filter-mapping> 元素了，容器會在部署時根據指定的屬性將該類發布為過濾器。它等價的 web.xml 中的配置形式為：
|
1
2
3
4
5
6
7
8
|
<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 的常用屬性
一個簡單示例如下：
|
1
2
|
@weblistener("this is only a demo listener") public class simplelistener implements servletcontextlistener{...} |
如此，則不需要在 web.xml 中配置 <listener> 標簽了。它等價的 web.xml 中的配置形式如下：
|
1
2
3
|
<listener> <listener-class>footmark.servlet.simplelistener</listener-class> </listener> |
@multipartconfig
該注解主要是為了輔助 servlet 3.0 中 httpservletrequest 提供的對上傳文件的支持。該注解標注在 servlet 上面，以表示該 servlet 希望處理的請求的 mime 類型是 multipart/form-data。另外，它還提供了若干屬性用于簡化對上傳文件的處理。具體如下：
表 5. @multipartconfig 的常用屬性
可插性支持
如果說 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 文件示例如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
<?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> 則用于指定先后順序。一個簡單的示例如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
<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> 標簽來指定相對應的文件。比如：
|
1
2
3
4
|
<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 提供了兩個方法用于從請求中解析出上傳的文件：
|
1
2
|
?part getpart(string name)?collection<part> getparts() |
前者用于獲取請求中給定 name 的文件，后者用于獲取所有的文件。每一個文件用一個 javax.servlet.http.part 對象來表示。該接口提供了處理文件的簡易方法，比如 write()、delete() 等。至此，結合 httpservletrequest 和 part 來保存上傳的文件變得非常簡單，如下所示：
|
1
2
3
|
part photo = request.getpart("photo"); photo.write("/tmp/photo.jpg"); // 可以將兩行代碼簡化為 request.getpart("photo").write("/tmp/photo.jpg") 一行。 |
另外，開發者可以配合前面提到的 @multipartconfig 注解來對上傳操作進行一些自定義的配置，比如限制上傳文件的大小，以及保存文件的路徑等。其用法非常簡單，故不在此贅述了。
需要注意的是，如果請求的 mime 類型不是 multipart/form-data，則不能使用上面的兩個方法，否則將拋異常。
