servlet 3.0 新特性概述
servlet 3.0 作為 java ee 6 規(guī)范體系中一員，隨著 java ee 6 規(guī)范一起發(fā)布。該版本在前一版本（servlet 2.5）的基礎(chǔ)上提供了若干新特性用于簡化 web 應(yīng)用的開發(fā)和部署。其中有幾項(xiàng)特性的引入讓開發(fā)者感到非常興奮，同時(shí)也獲得了 java 社區(qū)的一片贊譽(yù)之聲：
1.異步處理支持：有了該特性，servlet 線程不再需要一直阻塞，直到業(yè)務(wù)處理完畢才能再輸出響應(yīng)，最后才結(jié)束該 servlet 線程。在接收到請求之后，servlet 線程可以將耗時(shí)的操作委派給另一個(gè)線程來完成，自己在不生成響應(yīng)的情況下返回至容器。針對業(yè)務(wù)處理較耗時(shí)的情況，這將大大減少服務(wù)器資源的占用，并且提高并發(fā)處理速度。
2.新增的注解支持：該版本新增了若干注解，用于簡化 servlet、過濾器（filter）和監(jiān)聽器（listener）的聲明，這使得 web.xml 部署描述文件從該版本開始不再是必選的了。
3.可插性支持：熟悉 struts2 的開發(fā)者一定會(huì)對其通過插件的方式與包括 spring 在內(nèi)的各種常用框架的整合特性記憶猶新。將相應(yīng)的插件封裝成 jar 包并放在類路徑下，struts2 運(yùn)行時(shí)便能自動(dòng)加載這些插件。現(xiàn)在 servlet 3.0 提供了類似的特性，開發(fā)者可以通過插件的方式很方便的擴(kuò)充已有 web 應(yīng)用的功能，而不需要修改原有的應(yīng)用。
下面我們將逐一講解這些新特性，通過下面的學(xué)習(xí)，讀者將能夠明晰了解 servlet 3.0 的變化，并能夠順利使用它進(jìn)行日常的開發(fā)工作。
異步處理支持
servlet 3.0 之前，一個(gè)普通 servlet 的主要工作流程大致如下：首先，servlet 接收到請求之后，可能需要對請求攜帶的數(shù)據(jù)進(jìn)行一些預(yù)處理；接著，調(diào)用業(yè)務(wù)接口的某些方法，以完成業(yè)務(wù)處理；最后，根據(jù)處理的結(jié)果提交響應(yīng)，servlet 線程結(jié)束。其中第二步的業(yè)務(wù)處理通常是最耗時(shí)的，這主要體現(xiàn)在數(shù)據(jù)庫操作，以及其它的跨網(wǎng)絡(luò)調(diào)用等，在此過程中，servlet 線程一直處于阻塞狀態(tài)，直到業(yè)務(wù)方法執(zhí)行完畢。在處理業(yè)務(wù)的過程中，servlet 資源一直被占用而得不到釋放，對于并發(fā)較大的應(yīng)用，這有可能造成性能的瓶頸。對此，在以前通常是采用私有解決方案來提前結(jié)束 servlet 線程，并及時(shí)釋放資源。
servlet 3.0 針對這個(gè)問題做了開創(chuàng)性的工作，現(xiàn)在通過使用 servlet 3.0 的異步處理支持，之前的 servlet 處理流程可以調(diào)整為如下的過程：首先，servlet 接收到請求之后，可能首先需要對請求攜帶的數(shù)據(jù)進(jìn)行一些預(yù)處理；接著，servlet 線程將請求轉(zhuǎn)交給一個(gè)異步線程來執(zhí)行業(yè)務(wù)處理，線程本身返回至容器，此時(shí) servlet 還沒有生成響應(yīng)數(shù)據(jù)，異步線程處理完業(yè)務(wù)以后，可以直接生成響應(yīng)數(shù)據(jù)（異步線程擁有 servletrequest 和 servletresponse 對象的引用），或者將請求繼續(xù)轉(zhuǎn)發(fā)給其它 servlet。如此一來， servlet 線程不再是一直處于阻塞狀態(tài)以等待業(yè)務(wù)邏輯的處理，而是啟動(dòng)異步線程之后可以立即返回。
異步處理特性可以應(yīng)用于 servlet 和過濾器兩種組件，由于異步處理的工作模式和普通工作模式在實(shí)現(xiàn)上有著本質(zhì)的區(qū)別，因此默認(rèn)情況下，servlet 和過濾器并沒有開啟異步處理特性，如果希望使用該特性，則必須按照如下的方式啟用：
1.對于使用傳統(tǒng)的部署描述文件 (web.xml) 配置 servlet 和過濾器的情況，servlet 3.0 為 <servlet> 和 <filter> 標(biāo)簽增加了 <async-supported> 子標(biāo)簽，該標(biāo)簽的默認(rèn)取值為 false，要啟用異步處理支持，則將其設(shè)為 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 進(jìn)行 servlet 或過濾器配置的情況，這兩個(gè)注解都提供了 asyncsupported 屬性，默認(rèn)該屬性的取值為 false，要啟用異步處理支持，只需將該屬性設(shè)置為 true 即可。以 @webfilter 為例，其配置方式如下所示：
|
1
2
|
@webfilter(urlpatterns = "/demo",asyncsupported = true) public class demofilter implements filter{...} |
一個(gè)簡單的模擬異步處理的 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("進(jìn)入servlet的時(shí)間：" + new date() + "."); out.flush(); //在子線程中執(zhí)行業(yè)務(wù)調(diào)用，并由其負(fù)責(zé)輸出響應(yīng)，主線程退出 asynccontext ctx = req.startasync(); new thread(new executor(ctx)).start(); out.println("結(jié)束servlet的時(shí)間：" + 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è)務(wù)方法的執(zhí)行 thread.sleep(10000); printwriter out = ctx.getresponse().getwriter(); out.println("業(yè)務(wù)處理完畢的時(shí)間：" + new date() + "."); out.flush(); ctx.complete(); } catch (exception e) { e.printstacktrace(); } }} |
除此之外，servlet 3.0 還為異步處理提供了一個(gè)監(jiān)聽器，使用 asynclistener 接口表示。它可以監(jiān)控如下四種事件：
1.異步線程開始時(shí)，調(diào)用 asynclistener 的 onstartasync(asyncevent event) 方法；
2.異步線程出錯(cuò)時(shí)，調(diào)用 asynclistener 的 onerror(asyncevent event) 方法；
3.異步線程執(zhí)行超時(shí)，則調(diào)用 asynclistener 的 ontimeout(asyncevent event) 方法；
4.異步執(zhí)行完畢時(shí)，調(diào)用 asynclistener 的 oncomplete(asyncevent event) 方法；
要注冊一個(gè) asynclistener，只需將準(zhǔn)備好的 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 的頂層標(biāo)簽 <web-app> 有一個(gè) metadata-complete 屬性，該屬性指定當(dāng)前的部署描述文件是否是完全的。如果設(shè)置為 true，則容器在部署時(shí)將只依賴部署描述文件，忽略所有的注解（同時(shí)也會(huì)跳過 web-fragment.xml 的掃描，亦即禁用可插性支持）；如果不配置該屬性，或者將其設(shè)置為 false，則表示啟用注解支持（和可插性支持）。
@webservlet
@webservlet 用于將一個(gè)類聲明為 servlet，該注解將會(huì)在部署時(shí)被容器處理，容器將根據(jù)具體的屬性配置將相應(yīng)的類部署為 servlet。該注解具有下表給出的一些常用屬性（以下所有屬性均為可選屬性，但是 vlaue 或者 urlpatterns 通常是必需的，且二者不能共存，如果同時(shí)指定，通常是忽略 value 的取值）：
表 1. @webservlet 主要屬性列表
下面是一個(gè)簡單的示例：
|
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 中配置相應(yīng)的 <servlet> 和 <servlet-mapping> 元素了，容器會(huì)在部署時(shí)根據(jù)指定的屬性將該類發(fā)布為 servlet。它的等價(jià)的 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 |
該注解通常不單獨(dú)使用，而是配合 @webservlet 或者 @webfilter 使用。它的作用是為 servlet 或者過濾器指定初始化參數(shù)，這等價(jià)于 web.xml 中 <servlet> 和 <filter> 的 <init-param> 子標(biāo)簽。@webinitparam 具有下表給出的一些常用屬性：
表 2. @webinitparam 的常用屬性
@webfilter
@webfilter 用于將一個(gè)類聲明為過濾器，該注解將會(huì)在部署時(shí)被容器處理，容器將根據(jù)具體的屬性配置將相應(yīng)的類部署為過濾器。該注解具有下表給出的一些常用屬性 ( 以下所有屬性均為可選屬性，但是 value、urlpatterns、servletnames 三者必需至少包含一個(gè)，且 value 和 urlpatterns 不能共存，如果同時(shí)指定，通常忽略 value 的取值 )：
表 3. @webfilter 的常用屬性
下面是一個(gè)簡單的示例：
|
1
2
|
@webfilter(servletnames = {"simpleservlet"},filtername="simplefilter") public class lessthansixfilter implements filter{...} |
如此配置之后，就可以不必在 web.xml 中配置相應(yīng)的 <filter> 和 <filter-mapping> 元素了，容器會(huì)在部署時(shí)根據(jù)指定的屬性將該類發(fā)布為過濾器。它等價(jià)的 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
該注解用于將類聲明為監(jiān)聽器，被 @weblistener 標(biāo)注的類必須實(shí)現(xiàn)以下至少一個(gè)接口：
?servletcontextlistener
?servletcontextattributelistener
?servletrequestlistener
?servletrequestattributelistener
?httpsessionlistener
?httpsessionattributelistener
該注解使用非常簡單，其屬性如下：
表 4. @weblistener 的常用屬性
一個(gè)簡單示例如下：
|
1
2
|
@weblistener("this is only a demo listener") public class simplelistener implements servletcontextlistener{...} |
如此，則不需要在 web.xml 中配置 <listener> 標(biāo)簽了。它等價(jià)的 web.xml 中的配置形式如下：
|
1
2
3
|
<listener> <listener-class>footmark.servlet.simplelistener</listener-class> </listener> |
@multipartconfig
該注解主要是為了輔助 servlet 3.0 中 httpservletrequest 提供的對上傳文件的支持。該注解標(biāo)注在 servlet 上面，以表示該 servlet 希望處理的請求的 mime 類型是 multipart/form-data。另外，它還提供了若干屬性用于簡化對上傳文件的處理。具體如下：
表 5. @multipartconfig 的常用屬性
可插性支持
如果說 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 應(yīng)用的前提下，只需將按照一定格式打成的 jar 包放到 web-inf/lib 目錄下，即可實(shí)現(xiàn)新功能的擴(kuò)充，不需要額外的配置。
servlet 3.0 引入了稱之為“web 模塊部署描述符片段”的 web-fragment.xml 部署描述文件，該文件必須存放在 jar 文件的 meta-inf 目錄下，該部署描述文件可以包含一切可以在 web.xml 中定義的內(nèi)容。jar 包通常放在 web-inf/lib 目錄下，除此之外，所有該模塊使用的資源，包括 class 文件、配置文件等，只需要能夠被容器的類加載器鏈加載的路徑上，比如 classes 目錄等。
現(xiàn)在，為一個(gè) web 應(yīng)用增加一個(gè) servlet 配置有如下三種方式 ( 過濾器、監(jiān)聽器與 servlet 三者的配置都是等價(jià)的，故在此以 servlet 配置為例進(jìn)行講述，過濾器和監(jiān)聽器具有與之非常類似的特性 )：
?編寫一個(gè)類繼承自 httpservlet，將該類放在 classes 目錄下的對應(yīng)包結(jié)構(gòu)中，修改 web.xml，在其中增加一個(gè) servlet 聲明。這是最原始的方式；
?編寫一個(gè)類繼承自 httpservlet，并且在該類上使用 @webservlet 注解將該類聲明為 servlet，將該類放在 classes 目錄下的對應(yīng)包結(jié)構(gòu)中，無需修改 web.xml 文件。
?編寫一個(gè)類繼承自 httpservlet，將該類打成 jar 包，并且在 jar 包的 meta-inf 目錄下放置一個(gè) web-fragment.xml 文件，該文件中聲明了相應(yīng)的 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 是完全一致的。
由于一個(gè) web 應(yīng)用中可以出現(xiàn)多個(gè) web-fragment.xml 聲明文件，加上一個(gè) web.xml 文件，加載順序問題便成了不得不面對的問題。servlet 規(guī)范的專家組在設(shè)計(jì)的時(shí)候已經(jīng)考慮到了這個(gè)問題，并定義了加載順序的規(guī)則。
web-fragment.xml 包含了兩個(gè)可選的頂層標(biāo)簽，<name> 和 <ordering>，如果希望為當(dāng)前的文件指定明確的加載順序，通常需要使用這兩個(gè)標(biāo)簽，<name> 主要用于標(biāo)識(shí)當(dāng)前的文件，而 <ordering> 則用于指定先后順序。一個(gè)簡單的示例如下：
|
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> 標(biāo)簽的取值通常是被其它 web-fragment.xml 文件在定義先后順序時(shí)引用的，在當(dāng)前文件中一般用不著，它起著標(biāo)識(shí)當(dāng)前文件的作用。
在 <ordering> 標(biāo)簽內(nèi)部，我們可以定義當(dāng)前 web-fragment.xml 文件與其他文件的相對位置關(guān)系，這主要通過 <ordering> 的 <after> 和 <before> 子標(biāo)簽來實(shí)現(xiàn)的。在這兩個(gè)子標(biāo)簽內(nèi)部可以通過 <name> 標(biāo)簽來指定相對應(yīng)的文件。比如：
|
1
2
3
4
|
<after> <name>fragmentb</name> <name>fragmentc</name> </after> |
以上片段則表示當(dāng)前文件必須在 fragmentb 和 fragmentc 之后解析。<before> 的使用于此相同，它所表示的是當(dāng)前文件必須早于 <before> 標(biāo)簽里所列出的 web-fragment.xml 文件。
除了將所比較的文件通過 <name> 在 <after> 和 <begin> 中列出之外，servlet 還提供了一個(gè)簡化的標(biāo)簽 <others/>。它表示除了當(dāng)前文件之外的其他所有的 web-fragment.xml 文件。該標(biāo)簽的優(yōu)先級(jí)要低于使用 <name> 明確指定的相對位置關(guān)系。
servletcontext 的性能增強(qiáng)
除了以上的新特性之外，servletcontext 對象的功能在新版本中也得到了增強(qiáng)。現(xiàn)在，該對象支持在運(yùn)行時(shí)動(dòng)態(tài)部署 servlet、過濾器、監(jiān)聽器，以及為 servlet 和過濾器增加 url 映射等。以 servlet 為例，過濾器與監(jiān)聽器與之類似。servletcontext 為動(dòng)態(tài)配置 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()
其中前三個(gè)方法的作用是相同的，只是參數(shù)類型不同而已；通過 createservlet() 方法創(chuàng)建的 servlet，通常需要做一些自定義的配置，然后使用 addservlet() 方法來將其動(dòng)態(tài)注冊為一個(gè)可以用于服務(wù)的 servlet。兩個(gè) getservletregistration() 方法主要用于動(dòng)態(tài)為 servlet 增加映射信息，這等價(jià)于在 web.xml( 抑或 web-fragment.xml) 中使用 <servlet-mapping> 標(biāo)簽為存在的 servlet 增加映射信息。
以上 servletcontext 新增的方法要么是在 servletcontextlistener 的 contexinitialized 方法中調(diào)用，要么是在 servletcontainerinitializer 的 onstartup() 方法中調(diào)用。
servletcontainerinitializer 也是 servlet 3.0 新增的一個(gè)接口，容器在啟動(dòng)時(shí)使用 jar 服務(wù) api(jar service api) 來發(fā)現(xiàn) servletcontainerinitializer 的實(shí)現(xiàn)類，并且容器將 web-inf/lib 目錄下 jar 包中的類都交給該類的 onstartup() 方法處理，我們通常需要在該實(shí)現(xiàn)類上使用 @handlestypes 注解來指定希望被處理的類，過濾掉不希望給 onstartup() 處理的類。
httpservletrequest 對文件上傳的支持
此前，對于處理上傳文件的操作一直是讓開發(fā)者頭疼的問題，因?yàn)?servlet 本身沒有對此提供直接的支持，需要使用第三方框架來實(shí)現(xiàn)，而且使用起來也不夠簡單。如今這都成為了歷史，servlet 3.0 已經(jīng)提供了這個(gè)功能，而且使用也非常簡單。為此，httpservletrequest 提供了兩個(gè)方法用于從請求中解析出上傳的文件：
|
1
2
|
?part getpart(string name)?collection<part> getparts() |
前者用于獲取請求中給定 name 的文件，后者用于獲取所有的文件。每一個(gè)文件用一個(gè) javax.servlet.http.part 對象來表示。該接口提供了處理文件的簡易方法，比如 write()、delete() 等。至此，結(jié)合 httpservletrequest 和 part 來保存上傳的文件變得非常簡單，如下所示：
|
1
2
3
|
part photo = request.getpart("photo"); photo.write("/tmp/photo.jpg"); // 可以將兩行代碼簡化為 request.getpart("photo").write("/tmp/photo.jpg") 一行。 |
另外，開發(fā)者可以配合前面提到的 @multipartconfig 注解來對上傳操作進(jìn)行一些自定義的配置，比如限制上傳文件的大小，以及保存文件的路徑等。其用法非常簡單，故不在此贅述了。
需要注意的是，如果請求的 mime 類型不是 multipart/form-data，則不能使用上面的兩個(gè)方法，否則將拋異常。
