Servlet 3.0 作為 Java EE 6 規範體系中一員,随着 java EE 6 規範一起釋出。該版本在前一版本(Servlet 2.5)的基礎上提供了若幹新特性用于簡化 Web 應用的開發和部署。其中有幾項特性的引入讓開發者感到非常興奮,同時也獲得了 Java 社群的一片贊譽之聲:
- 異步處理支援:有了該特性,Servlet 線程不再需要一直阻塞,直到業務處理完畢才能再輸出響應,最後才結束該 Servlet 線程。在接收到請求之後,Servlet 線程可以将耗時的操作委派給另一個線程來完成,自己在不生成響應的情況下傳回至容器。針對業務處理較耗時的情況,這将大大減少伺服器資源的占用,并且提高并發處理速度。
- 新增的注解支援:該版本新增了若幹注解,用于簡化 Servlet、過濾器(Filter)和監聽器(Listener)的聲明,這使得 web.xml 部署描述檔案從該版本開始不再是必選的了。
- 可插性支援:熟悉 Struts2 的開發者一定會對其通過插件的方式與包括 Spring 在内的各種常用架構的整合特性記憶猶新。将相應的插件封裝成 JAR 包并放在類路徑下,Struts2 運作時便能自動加載這些插件。現在 Servlet 3.0 提供了類似的特性,開發者可以通過插件的方式很友善的擴充已有 Web 應用的功能,而不需要修改原有的應用。
下面我們将逐一講解這些新特性,通過下面的學習,讀者将能夠明晰了解 Servlet 3.0 的變化,并能夠順利使用它進行日常的開發工作。
一、異步處理支援
見《Servlet3.0之二:異步特性》
二、新增的注解支援
Servlet 3.0 的部署描述檔案 web.xml 的頂層标簽 <web-app> 有一個 metadata-complete 屬性,該屬性指定目前的部署描述檔案是否是完全的。如果設定為 true,則容器在部署時将隻依賴部署描述檔案,忽略所有的注解(同時也會跳過 web-fragment.xml 的掃描,亦即禁用可插性支援,具體請看後文關于 可插性支援的講解);如果不配置該屬性,或者将其設定為 false,則表示啟用注解支援(和可插性支援)。
2.1、@WebServlet
見《Servlet3.0之六:@WebServlet Servlet注解》
2.2、@WebFilter
@WebFilter 用于将一個類聲明為過濾器,該注解将會在部署時被容器處理,容器将根據具體的屬性配置将相應的類部署為過濾器。該注解具有下表給出的一些常用屬性 ( 以下所有屬性均為可選屬性,但是 value、urlPatterns、servletNames 三者必需至少包含一個,且 value 和 urlPatterns 不能共存,如果同時指定,通常忽略 value 的取值 ):
見《Servlet3.0之七:@WebFilter申明該類為過濾器》
2.3、@WebListener
該注解用于将類聲明為監聽器,被 @WebListener 标注的類必須實作以下至少一個接口:
- ServletContextListener
- ServletContextAttributeListener
- ServletRequestListener
- ServletRequestAttributeListener
- HttpSessionListener
- HttpSessionAttributeListener
見《Servlet3.0之四:@WebListener監聽器注解》
2.4、@MultipartConfig
該注解主要是為了輔助 Servlet 3.0 中 HttpServletRequest 提供的對上傳檔案的支援。該注解标注在 Servlet 上面,以表示該 Servlet 希望處理的請求的 MIME 類型是 multipart/form-data。另外,它還提供了若幹屬性用于簡化對上傳檔案的處理。具體如下:
表 5. @MultipartConfig 的常用屬性
屬性名 | 類型 | 是否可選 | 描述 |
fileSizeThreshold | int | 是 | 當資料量大于該值時,内容将被寫入檔案。 |
location | String | 存放生成的檔案位址。 | |
maxFileSize | long | 允許上傳的檔案最大值。預設值為 -1,表示沒有限制。 | |
maxRequestSize | 針對該 multipart/form-data 請求的最大數量,預設值為 -1,表示沒有限制。 |
見《Servlet3.0之八:基于Servlet3.0的檔案上傳@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 檔案示例如下:
|
從上面的示例可以看出,web-fragment.xml 與 web.xml 除了在頭部聲明的 XSD 引用不同之外,其主體配置與 web.xml 是完全一緻的。
由于一個 Web 應用中可以出現多個 web-fragment.xml 聲明檔案,加上一個 web.xml 檔案,加載順序問題便成了不得不面對的問題。Servlet 規範的專家組在設計的時候已經考慮到了這個問題,并定義了加載順序的規則。
web-fragment.xml 包含了兩個可選的頂層标簽,<name> 和 <ordering>,如果希望為目前的檔案指定明确的加載順序,通常需要使用這兩個标簽,<name> 主要用于辨別目前的檔案,而 <ordering> 則用于指定先後順序。一個簡單的示例如下:
|
如上所示, <name> 标簽的取值通常是被其它 web-fragment.xml 檔案在定義先後順序時引用的,在目前檔案中一般用不着,它起着辨別目前檔案的作用。
在 <ordering> 标簽内部,我們可以定義目前 web-fragment.xml 檔案與其他檔案的相對位置關系,這主要通過 <ordering> 的 <after> 和 <before> 子标簽來實作的。在這兩個子标簽内部可以通過 <name> 标簽來指定相對應的檔案。比如:
|
以上片段則表示目前檔案必須在 FragmentB 和 FragmentC 之後解析。<before> 的使用于此相同,它所表示的是目前檔案必須早于 <before> 标簽裡所列出的 web-fragment.xml 檔案。
除了将所比較的檔案通過 <name> 在 <after> 和 <begin> 中列出之外,Servlet 還提供了一個簡化的标簽 <others/>。它表示除了目前檔案之外的其他所有的 web-fragment.xml 檔案。該标簽的優先級要低于使用 <name> 明确指定的相對位置關系。
四、ServletContext 的性能增強(動态配置 Servlet)
見《Servlet3.0之四:動态注冊和Servlet容器初始化》
五、HttpServletRequest 對檔案上傳的支援
見《Servlet3.0之八:基于Servlet3.0的檔案上傳@MultipartConfig》