概述
Servlet 3.0 的眾多新特性使得 Servlet 開發(fā)變得更加簡單肆汹,尤其是異步處理特性和可插性支持的出現(xiàn)交胚,必將對現(xiàn)有的 MVC 框架產(chǎn)生深遠影響娄涩。
JSR-315
新特性詳解
要使用這些新特性除嘹,需要使用新版的servlet相關(guān)支持包
常見的web容器也推出了支持servlet3.0的新版本
Spring MVC 3.2開始支持Servlet3.0
<!-- servlet -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
</dependency>
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>jsp-api</artifactId>
<version>2.2</version>
</dependency>
新特性
1.注解支持
servlet 3.0中新增了若干注解,用于簡化 Servlet屿衅、Filter和Listener的聲明。
這使得web.xml 部署描述文件從該版本開始不再是必選的(666...)莹弊。
@WebServlet
@WebServlet 用于將一個類聲明為 Servlet涤久,該注解將會在部署時被容器處理,容器將根據(jù)具體的屬性配置將相應(yīng)的類部署為 Servlet忍弛。
@WebServlet(urlPatterns = {"/simple"}, asyncSupported = true,
loadOnStartup = -1, name = "SimpleServlet", displayName = "ss",
initParams = {@WebInitParam(name = "username", value = "tom")}
)
public class SimpleServlet extends HttpServlet{ … }
@WebInitParam
該注解通常不單獨使用响迂,而是配合 @WebServlet 或者 @WebFilter 使用。它的作用是為 Servlet 或者過濾器指定初始化參數(shù)细疚,這等價于 web.xml 中 <servlet> 和 <filter> 的 <init-param> 子標簽蔗彤。
@WebFilter
@WebFilter 用于將一個類聲明為過濾器,該注解將會在部署時被容器處理疯兼,容器將根據(jù)具體的屬性配置將相應(yīng)的類部署為過濾器然遏。
@WebFilter(servletNames = {"SimpleServlet"},filterName="SimpleFilter")
public class LessThanSixFilter implements Filter{...}
@WebListener
該注解用于將類聲明為監(jiān)聽器,被 @WebListener 標注的類必須實現(xiàn)以下至少一個接口:
ServletContextListener
ServletContextAttributeListener
ServletRequestListener
ServletRequestAttributeListener
HttpSessionListener
HttpSessionAttributeListener
@WebListener("This is only a demo listener")
public class SimpleListener implements ServletContextListener{...}
@MultipartConfig
該注解主要是為了輔助 Servlet 3.0 中 HttpServletRequest 提供的對上傳文件的支持镇防。該注解標注在 Servlet 上面啦鸣,以表示該 Servlet 希望處理的請求的 MIME 類型是 multipart/form-data。另外来氧,它還提供了若干屬性用于簡化對上傳文件的處理诫给。
2.異步處理支持
Servlet 3.0 之前,一個普通 Servlet 的主要工作流程大致如下:首先啦扬,Servlet 接收到請求之后中狂,可能需要對請求攜帶的數(shù)據(jù)進行一些預(yù)處理;接著扑毡,調(diào)用業(yè)務(wù)接口的某些方法胃榕,以完成業(yè)務(wù)處理;最后瞄摊,根據(jù)處理的結(jié)果提交響應(yīng)勋又,Servlet 線程結(jié)束苦掘。其中第二步的業(yè)務(wù)處理通常是最耗時的,這主要體現(xiàn)在數(shù)據(jù)庫操作楔壤,以及其它的跨網(wǎng)絡(luò)調(diào)用等鹤啡,在此過程中,Servlet 線程一直處于阻塞狀態(tài)蹲嚣,直到業(yè)務(wù)方法執(zhí)行完畢递瑰。在處理業(yè)務(wù)的過程中,Servlet 資源一直被占用而得不到釋放隙畜,對于并發(fā)較大的應(yīng)用抖部,這有可能造成性能的瓶頸。對此议惰,在以前通常是采用私有解決方案來提前結(jié)束 Servlet 線程慎颗,并及時釋放資源。
Servlet 3.0 針對這個問題做了開創(chuàng)性的工作换淆,現(xiàn)在通過使用 Servlet 3.0 的異步處理支持哗总,之前的 Servlet 處理流程可以調(diào)整為如下的過程:首先,Servlet 接收到請求之后倍试,可能首先需要對請求攜帶的數(shù)據(jù)進行一些預(yù)處理讯屈;接著,Servlet 線程將請求轉(zhuǎn)交給一個異步線程來執(zhí)行業(yè)務(wù)處理县习,線程本身返回至容器涮母,此時 Servlet 還沒有生成響應(yīng)數(shù)據(jù),異步線程處理完業(yè)務(wù)以后躁愿,可以直接生成響應(yīng)數(shù)據(jù)(異步線程擁有 ServletRequest 和 ServletResponse 對象的引用)叛本,或者將請求繼續(xù)轉(zhuǎn)發(fā)給其它 Servlet。如此一來彤钟, Servlet 線程不再是一直處于阻塞狀態(tài)以等待業(yè)務(wù)邏輯的處理来候,而是啟動異步線程之后可以立即返回。
異步處理特性可以應(yīng)用于 Servlet 和過濾器兩種組件逸雹,由于異步處理的工作模式和普通工作模式在實現(xiàn)上有著本質(zhì)的區(qū)別营搅,因此默認情況下,Servlet 和過濾器并沒有開啟異步處理特性梆砸,如果希望使用該特性转质,則必須按照如下的方式啟用:
1.對于使用傳統(tǒng)的部署描述文件 (web.xml) 配置 Servlet 和過濾器的情況,Servlet 3.0 為 <servlet> 和 <filter> 標簽增加了 <async-supported> 子標簽帖世,該標簽的默認取值為 false休蟹,要啟用異步處理支持,則將其設(shè)為 true 即可。
<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,要啟用異步處理支持盈魁,只需將該屬性設(shè)置為 true 即可彭沼。
@WebFilter(urlPatterns = "/demo",asyncSupported = true)
public class DemoFilter implements Filter{...}
一個簡單的模擬異步處理的 Servlet 示例:
@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();
//在子線程中執(zhí)行業(yè)務(wù)調(diào)用,并由其負責(zé)輸出響應(yīng)备埃,主線程退出
AsyncContext ctx = req.startAsync();
new Thread(new Executor(ctx)).start();
out.println("結(jié)束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 {
//等待十秒鐘,以模擬業(yè)務(wù)方法的執(zhí)行
Thread.sleep(10000);
PrintWriter out = ctx.getResponse().getWriter();
out.println("業(yè)務(wù)處理完畢的時間:" + new Date() + ".");
out.flush();
ctx.complete();
} catch (Exception e) {
e.printStackTrace();
}
}
}
除此之外褐奴,Servlet 3.0 還為異步處理提供了一個監(jiān)聽器按脚,使用 AsyncListener 接口表示。它可以監(jiān)控如下四種事件:
異步線程開始時敦冬,調(diào)用 AsyncListener 的 onStartAsync(AsyncEvent event) 方法辅搬;
異步線程出錯時,調(diào)用 AsyncListener 的 onError(AsyncEvent event) 方法脖旱;
異步線程執(zhí)行超時堪遂,則調(diào)用 AsyncListener 的 onTimeout(AsyncEvent event) 方法;
異步執(zhí)行完畢時萌庆,調(diào)用 AsyncListener 的 onComplete(AsyncEvent event) 方法溶褪;
要注冊一個 AsyncListener,只需將準備好的 AsyncListener 對象傳遞給 AsyncContext 對象的 addListener() 方法即可践险。
AsyncContext ctx = req.startAsync();
ctx.addListener(new AsyncListener() {
public void onComplete(AsyncEvent asyncEvent) throws IOException {
// 做一些清理工作或者其他
}
...
});
3.可插性支持
如果說 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 目錄下芬萍,即可實現(xiàn)新功能的擴充,不需要額外的配置凛捏。
Servlet 3.0 引入了稱之為“Web 模塊部署描述符片段”的 web-fragment.xml 部署描述文件担忧,該文件必須存放在 JAR 文件的 META-INF 目錄下,該部署描述文件可以包含一切可以在 web.xml 中定義的內(nèi)容坯癣。JAR 包通常放在 WEB-INF/lib 目錄下瓶盛,除此之外,所有該模塊使用的資源,包括 class 文件惩猫、配置文件等芝硬,只需要能夠被容器的類加載器鏈加載的路徑上,比如 classes 目錄等轧房。
現(xiàn)在拌阴,為一個 Web 應(yīng)用增加一個 Servlet 配置有如下三種方式 ( 過濾器、監(jiān)聽器與 Servlet 三者的配置都是等價的奶镶,故在此以 Servlet 配置為例進行講述迟赃,過濾器和監(jiān)聽器具有與之非常類似的特性 ):
編寫一個類繼承自 HttpServlet,將該類放在 classes 目錄下的對應(yīng)包結(jié)構(gòu)中厂镇,修改 web.xml纤壁,在其中增加一個 Servlet 聲明。這是最原始的方式酌媒;
編寫一個類繼承自 HttpServlet迄靠,并且在該類上使用 @WebServlet 注解將該類聲明為 Servlet掌挚,將該類放在 classes 目錄下的對應(yīng)包結(jié)構(gòu)中疫诽,無需修改 web.xml 文件奇徒。
編寫一個類繼承自 HttpServlet摩钙,將該類打成 JAR 包胖笛,并且在 JAR 包的 META-INF 目錄下放置一個 web-fragment.xml 文件长踊,該文件中聲明了相應(yīng)的 Servlet 配置身弊。web-fragment.xml 文件示例如下:
<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 應(yīng)用中可以出現(xiàn)多個 web-fragment.xml 聲明文件所意,加上一個 web.xml 文件催首,加載順序問題便成了不得不面對的問題。Servlet 規(guī)范的專家組在設(shè)計的時候已經(jīng)考慮到了這個問題姻檀,并定義了加載順序的規(guī)則涝滴。
web-fragment.xml 包含了兩個可選的頂層標簽歼疮,<name> 和 <ordering>韩脏,如果希望為當(dāng)前的文件指定明確的加載順序赡矢,通常需要使用這兩個標簽吹散,<name> 主要用于標識當(dāng)前的文件空民,而 <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 文件在定義先后順序時引用的,在當(dāng)前文件中一般用不著热鞍,它起著標識當(dāng)前文件的作用衔彻。
在 <ordering> 標簽內(nèi)部幅疼,我們可以定義當(dāng)前 web-fragment.xml 文件與其他文件的相對位置關(guān)系米奸,這主要通過 <ordering> 的 <after> 和 <before> 子標簽來實現(xiàn)的爽篷。在這兩個子標簽內(nèi)部可以通過 <name> 標簽來指定相對應(yīng)的文件悴晰。比如:
<after>
<name>FragmentB</name>
<name>FragmentC</name>
</after>
以上片段則表示當(dāng)前文件必須在 FragmentB 和 FragmentC 之后解析。<before> 的使用于此相同逐工,它所表示的是當(dāng)前文件必須早于 <before> 標簽里所列出的 web-fragment.xml 文件。
除了將所比較的文件通過 <name> 在 <after> 和 <begin> 中列出之外泪喊,Servlet 還提供了一個簡化的標簽 <others/>袒啼。它表示除了當(dāng)前文件之外的其他所有的 web-fragment.xml 文件。該標簽的優(yōu)先級要低于使用 <name> 明確指定的相對位置關(guān)系摘仅。
4.ServletContext 的性能增強
除了以上的新特性之外,ServletContext 對象的功能在新版本中也得到了增強。現(xiàn)在矾端,該對象支持在運行時動態(tài)部署 Servlet掏击、過濾器、監(jiān)聽器秩铆,以及為 Servlet 和過濾器增加 URL 映射等铐料。以 Servlet 為例,過濾器與監(jiān)聽器與之類似豺旬。ServletContext 為動態(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()
其中前三個方法的作用是相同的钠惩,只是參數(shù)類型不同而已;通過 createServlet() 方法創(chuàng)建的 Servlet族阅,通常需要做一些自定義的配置篓跛,然后使用 addServlet() 方法來將其動態(tài)注冊為一個可以用于服務(wù)的 Servlet。兩個 getServletRegistration() 方法主要用于動態(tài)為 Servlet 增加映射信息坦刀,這等價于在 web.xml( 抑或 web-fragment.xml) 中使用 <servlet-mapping> 標簽為存在的 Servlet 增加映射信息愧沟。
以上 ServletContext 新增的方法要么是在 ServletContextListener 的 contexInitialized 方法中調(diào)用蔬咬,要么是在 ServletContainerInitializer 的 onStartup() 方法中調(diào)用。
ServletContainerInitializer 也是 Servlet 3.0 新增的一個接口沐寺,容器在啟動時使用 JAR 服務(wù) API(JAR Service API) 來發(fā)現(xiàn) ServletContainerInitializer 的實現(xiàn)類林艘,并且容器將 WEB-INF/lib 目錄下 JAR 包中的類都交給該類的 onStartup() 方法處理,我們通常需要在該實現(xiàn)類上使用 @HandlesTypes 注解來指定希望被處理的類混坞,過濾掉不希望給 onStartup() 處理的類狐援。
5.HttpServletRequest 對文件上傳的支持
此前,對于處理上傳文件的操作一直是讓開發(fā)者頭疼的問題究孕,因為 Servlet 本身沒有對此提供直接的支持啥酱,需要使用第三方框架來實現(xiàn),而且使用起來也不夠簡單厨诸。如今這都成為了歷史镶殷,Servlet 3.0 已經(jīng)提供了這個功能,而且使用也非常簡單微酬。為此绘趋,HttpServletRequest 提供了兩個方法用于從請求中解析出上傳的文件:
Part getPart(String name)
Collection<Part> getParts()
前者用于獲取請求中給定 name 的文件,后者用于獲取所有的文件颗管。每一個文件用一個 javax.servlet.http.Part 對象來表示埋心。該接口提供了處理文件的簡易方法,比如 write()忙上、delete() 等。至此闲坎,結(jié)合 HttpServletRequest 和 Part 來保存上傳的文件變得非常簡單疫粥,如下所示:
Part photo = request.getPart("photo");
photo.write("/tmp/photo.jpg");
// 可以將兩行代碼簡化為 request.getPart("photo").write("/tmp/photo.jpg") 一行。
另外腰懂,開發(fā)者可以配合前面提到的 @MultipartConfig 注解來對上傳操作進行一些自定義的配置梗逮,比如限制上傳文件的大小,以及保存文件的路徑等绣溜。其用法非常簡單慷彤,故不在此贅述了。
需要注意的是怖喻,如果請求的 MIME 類型不是 multipart/form-data底哗,則不能使用上面的兩個方法,否則將拋異常锚沸。