簡化Web應用開發 Servlet 3.0特性詳解
Servlet 3.0作為Java EE6規范體系中一員，隨著Java EE6規范一起發布。之前51CTO也曾報導過《Java EE 6新特性之Servlet 3.0的異步處理》的相關內容，而本文將比較全面的、并結合代碼實例介紹Servlet 3.0的新特性。
關于Java EE 6平臺的更多內容，51CTO推薦閱讀：Java EE 6平臺指南
異步處理支持：有了該特性，Servlet線程不再需要一直阻塞，直到業務處理完畢才能再輸出響應，***才結束該Servlet線程。在接收到請求之后，Servlet線程可以將耗時的操作委派給另一個線程來完成，自己在不生成響應的情況下返回至容器。針對業務處理較耗時的情況，這將大大減少服務器資源的占用，并且提高并發處理速度。
新增的注解支持：該版本新增了若干注解，用于簡化Servlet、過濾器（Filter）和監聽器（Listener）的聲明，這使得web.xml部署描述文件從該版本開始不再是必選的了。可插性支持：熟悉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和過濾器并沒有開啟異步處理特性，如果希望使用該特性，則必須按照如下的方式啟用：
對于使用傳統的部署描述文件(web.xml)配置Servlet和過濾器的情況，Servlet 3.0為<servlet>和<filter>標簽增加了<async-supported>子標簽，該標簽的默認取值為false，要啟用異步處理支持，則將其設為true即可。以Servlet為例，其配置方式如下所示：
- <servlet>
- <servlet-name>DemoServlet</servlet-name>
- <servlet-class>footmark.servlet.DemoServlet</servlet-class>
- <async-supported>true</async-supported>
- </servlet>
對于使用Servlet 3.0提供的@WebServlet和@WebFilter進行Servlet或過濾器配置的情況，這兩個注解都提供了asyncSupported屬性，默認該屬性的取值為false，要啟用異步處理支持，只需將該屬性設置為true即可。以@WebFilter為例，其配置方式如下所示：
- @WebFilter(urlPatterns="/demo",asyncSupported=true)
- publicclassDemoFilterimplementsFilter{...}
一個簡單的模擬異步處理的Servlet示例如下：
- @WebServlet(urlPatterns="/demo",asyncSupported=true)
- publicclassAsyncDemoServletextendsHttpServlet{
- @Override
- publicvoiddoGet(HttpServletRequestreq,HttpServletResponseresp)
- throwsIOException,ServletException{
- resp.setContentType("text/html;charset=UTF-8");
- PrintWriterout=resp.getWriter();
- out.println("進入Servlet的時間："+newDate()+".");
- out.flush();
- //在子線程中執行業務調用，并由其負責輸出響應，主線程退出
- AsyncContextctx=req.startAsync();
- newThread(newExecutor(ctx)).start();
- out.println("結束Servlet的時間："+newDate()+".");
- out.flush();
- }
- }
- publicclassExecutorimplementsRunnable{
- privateAsyncContextctx=null;
- publicExecutor(AsyncContextctx){
- this.ctx=ctx;
- }
- publicvoidrun(){
- try{
- //等待十秒鐘，以模擬業務方法的執行
- Thread.sleep(10000);
- PrintWriterout=ctx.getResponse().getWriter();
- out.println("業務處理完畢的時間："+newDate()+".");
- out.flush();
- ctx.complete();
- }catch(Exceptione){
- e.printStackTrace();
- }
- }
- }
除此之外，Servlet 3.0還為異步處理提供了一個監聽器，使用AsyncListener接口表示。它可以監控如下四種事件：
1.異步線程開始時，調用AsyncListener的onStartAsync(AsyncEventevent)方法；
2.異步線程出錯時，調用AsyncListener的onError(AsyncEventevent)方法；
3.異步線程執行超時，則調用AsyncListener的onTimeout(AsyncEventevent)方法；
4.異步執行完畢時，調用AsyncListener的onComplete(AsyncEventevent)方法；
要注冊一個AsyncListener，只需將準備好的AsyncListener對象傳遞給AsyncContext對象的addListener()方法即可，如下所示：
- AsyncContextctx=req.startAsync();
- ctx.addListener(newAsyncListener(){
- publicvoidonComplete(AsyncEventasyncEvent)throwsIOException{
- //做一些清理工作或者其他
- }
- ...
- });
#p#
新增的注解支持
Servlet 3.0的部署描述文件web.xml的頂層標簽<web-app>有一個metadata-complete屬性，該屬性指定當前的部署描述文件是否是完全的。如果設置為true，則容器在部署時將只依賴部署描述文件，忽略所有的注解（同時也會跳過web-fragment.xml的掃描，亦即禁用可插性支持，具體請看后文關于可插性支持的講解）；如果不配置該屬性，或者將其設置為false，則表示啟用注解支持（和可插性支持）。
@WebServlet
@WebServlet用于將一個類聲明為Servlet，該注解將會在部署時被容器處理，容器將根據具體的屬性配置將相應的類部署為Servlet。該注解具有下表給出的一些常用屬性（以下所有屬性均為可選屬性，但是vlaue或者urlPatterns通常是必需的，且二者不能共存，如果同時指定，通常是忽略value的取值）：
屬性名類型描述
1.nameString指定Servlet的name屬性，等價于<servlet-name>。如果沒有顯式指定，則該Servlet的取值即為類的全限定名。
2.valueString[]該屬性等價于urlPatterns屬性。兩個屬性不能同時使用。
3.urlPatternsString[]指定一組Servlet的URL匹配模式。等價于<url-pattern>標簽。
4.loadOnStartupint指定Servlet的加載順序，等價于<load-on-startup>標簽。
5.initParamsWebInitParam[]指定一組Servlet初始化參數，等價于<init-param>標簽。
6.asyncSupportedboolean聲明Servlet是否支持異步操作模式，等價于<async-supported>標簽。
7.descriptionString該Servlet的描述信息，等價于<description>標簽。
8.displayNameString該Servlet的顯示名，通常配合工具使用，等價于<display-name>標簽。
下面是一個簡單的示例：
- @WebServlet(urlPatterns={"/simple"},asyncSupported=true,
- loadOnStartup=-1,name="SimpleServlet",displayName="ss",
- initParams={@WebInitParam(name="username",value="tom")}
- )
- publicclassSimpleServletextendsHttpServlet{…}
如此配置之后，就可以不必在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具有下表給出的一些常用屬性：
屬性名類型是否可選描述
◆nameString否指定參數的名字，等價于<param-name>。
◆valueString否指定參數的值，等價于<param-value>。
◆descriptionString是關于參數的描述，等價于<description>。
@WebFilter
@WebFilter用于將一個類聲明為過濾器，該注解將會在部署時被容器處理，容器將根據具體的屬性配置將相應的類部署為過濾器。該注解具有下表給出的一些常用屬性(以下所有屬性均為可選屬性，但是value、urlPatterns、servletNames三者必需至少包含一個，且value和urlPatterns不能共存，如果同時指定，通常忽略value的取值)：
#p#
屬性名類型描述
1.filterNameString指定過濾器的name屬性，等價于<filter-name>。
2.valueString[]該屬性等價于urlPatterns屬性。但是兩者不應該同時使用。
3.urlPatternsString[]指定一組過濾器的URL匹配模式。等價于<url-pattern>標簽。
4.servletNamesString[]指定過濾器將應用于哪些Servlet。取值是@WebServlet中的name屬性的取值，或者是web.xml中<servlet-name>的取值。
5.dispatcherTypesDispatcherType指定過濾器的轉發模式。具體取值包括：
◆ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。
◆initParamsWebInitParam[]指定一組過濾器初始化參數，等價于<init-param>標簽。
◆asyncSupportedboolean聲明過濾器是否支持異步操作模式，等價于<async-supported>標簽。
◆descriptionString該過濾器的描述信息，等價于<description>標簽。
◆displayNameString該過濾器的顯示名，通常配合工具使用，等價于<display-name>標簽。
下面是一個簡單的示例：
- @WebFilter(servletNames={"SimpleServlet"},filterName="SimpleFilter")
- publicclassLessThanSixFilterimplementsFilter{...}
如此配置之后，就可以不必在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
該注解使用非常簡單，其屬性如下：
屬性名類型是否可選描述
valueString是該監聽器的描述信息。
一個簡單示例如下：
- @WebListener("Thisisonlyademolistener")
- publicclassSimpleListenerimplementsServletContextListener{...}
如此，則不需要在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。另外，它還提供了若干屬性用于簡化對上傳文件的處理。具體如下：
屬性名類型是否可選描述
◆fileSizeThresholdint是當數據量大于該值時，內容將被寫入文件。
◆locationString是存放生成的文件地址。
◆maxFileSizelong是允許上傳的文件***值。默認值為-1，表示沒有限制。
◆maxRequestSizelong是針對該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配置為例進行講述，過濾器和監聽器具有與之非常類似的特性)：
1.編寫一個類繼承自HttpServlet，將該類放在classes目錄下的對應包結構中，修改web.xml，在其中增加一個Servlet聲明。這是最原始的方式；
2.編寫一個類繼承自HttpServlet，并且在該類上使用@WebServlet注解將該類聲明為Servlet，將該類放在classes目錄下的對應包結構中，無需修改web.xml文件。
3.編寫一個類繼承自HttpServlet，將該類打成JAR包，并且在JAR包的META-INF目錄下放置一個web-fragment.xml文件，該文件中聲明了相應的Servlet配置。web-fragment.xml文件示例如下：
- <?xmlversionxmlversion="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>明確指定的相對位置關系。
#p#
ServletContext的性能增強
除了以上的新特性之外，ServletContext對象的功能在新版本中也得到了增強。現在，該對象支持在運行時動態部署Servlet、過濾器、監聽器，以及為Servlet和過濾器增加URL映射等。以Servlet為例，過濾器與監聽器與之類似。ServletContext為動態配置Servlet增加了如下方法：
◆ServletRegistration.DynamicaddServlet(StringservletName,Class<?extendsServlet>servletClass)
◆ServletRegistration.DynamicaddServlet(StringservletName,Servletservlet)
◆ServletRegistration.DynamicaddServlet(StringservletName,StringclassName)
◆<TextendsServlet>TcreateServlet(Class<T>clazz)
◆ServletRegistrationgetServletRegistration(StringservletName)
◆Map<String,?extendsServletRegistration>getServletRegistrations()
其中前三個方法的作用是相同的，只是參數類型不同而已；通過createServlet()方法創建的Servlet，通常需要做一些自定義的配置，然后使用addServlet()方法來將其動態注冊為一個可以用于服務的Servlet。
兩個getServletRegistration()方法主要用于動態為Servlet增加映射信息，這等價于在web.xml(抑或web-fragment.xml)中使用<servlet-mapping>標簽為存在的Servlet增加映射信息。以上ServletContext新增的方法要么是在ServletContextListener的contexInitialized方法中調用，要么是在ServletContainerInitializer的onStartup()方法中調用。
ServletContainerInitializer也是Servlet3.0新增的一個接口，容器在啟動時使用JAR服務API(JARServiceAPI)來發現ServletContainerInitializer的實現類，并且容器將WEB-INF/lib目錄下JAR包中的類都交給該類的onStartup()方法處理，我們通常需要在該實現類上使用@HandlesTypes注解來指定希望被處理的類，過濾掉不希望給onStartup()處理的類。
HttpServletRequest對文件上傳的支持
此前，對于處理上傳文件的操作一直是讓開發者頭疼的問題，因為Servlet本身沒有對此提供直接的支持，需要使用第三方框架來實現，而且使用起來也不夠簡單。如今這都成為了歷史，Servlet 3.0已經提供了這個功能，而且使用也非常簡單。為此，HttpServletRequest提供了兩個方法用于從請求中解析出上傳的文件：
◆PartgetPart(Stringname)
◆Collection<Part>getParts()
前者用于獲取請求中給定name的文件，后者用于獲取所有的文件。每一個文件用一個javax.servlet.http.Part對象來表示。該接口提供了處理文件的簡易方法，比如write()、delete()等。至此，結合HttpServletRequest和Part來保存上傳的文件變得非常簡單，如下所示：
◆Partphoto=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中，您就能切實感受到這些新特性帶來的實質性改變。
【編輯推薦】
