這篇文章主要為大家詳細介紹了servlet3新功能的相關資料,具有一定的參考價值,有興趣的小夥伴們可以參考一下
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 為46309ed845064fdb06e746051efff9e0 和1d24e586ca31f4bd05eca427459d98c7 標籤增加了614385e6a121bc5f88fc4b71e028d816 子標籤,該標籤的預設取值為false,要啟用非同步處理支持,則將其設為true 即可。以Servlet 為例,其設定
方式如下:
<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 為例,其配置方式如下所示:
@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(); //在子线程中执行业务调用,并由其负责输出响应,主线程退出 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() 方法即可,如下所示:
AsyncContext ctx = req.startAsync(); ctx.addListener(new AsyncListener() { public void onComplete(AsyncEvent asyncEvent) throws IOException { // 做一些清理工作或者其他 } ... });
新增的注解支持
Servlet 3.0 的部署描述文件 web.xml 的顶层标签 8459cedd22f378aa35db2cd2b63decac 有一个 metadata-complete 属性,该属性指定当前的部署描述文件是否是完全的。如果设置为 true,则容器在部署时将只依赖部署描述文件,忽略所有的注解(同时也会跳过 web-fragment.xml 的扫描,亦即禁用可插性支持);如果不配置该属性,或者将其设置为 false,则表示启用注解支持(和可插性支持)。
@WebServlet
@WebServlet 用于将一个类声明为 Servlet,该注解将会在部署时被容器处理,容器将根据具体的属性配置将相应的类部署为 Servlet。该注解具有下表给出的一些常用属性(以下所有属性均为可选属性,但是 vlaue 或者 urlPatterns 通常是必需的,且二者不能共存,如果同时指定,通常是忽略 value 的取值):
表 1. @WebServlet 主要属性列表
下面是一个简单的示例:
@WebServlet(urlPatterns = {"/simple"}, asyncSupported = true, loadOnStartup = -1, name = "SimpleServlet", displayName = "ss", initParams = {@WebInitParam(name = "username", value = "tom")} ) public class SimpleServlet extends HttpServlet{ … }
如此配置之后,就可以不必在 web.xml 中配置相应的 46309ed845064fdb06e746051efff9e0 和 870ae7edaa11700bcea972d006efb06e 元素了,容器会在部署时根据指定的属性将该类发布为 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 中 46309ed845064fdb06e746051efff9e0 和 1d24e586ca31f4bd05eca427459d98c7 的 380fae52cc7d04565d26dd4bbf4b5460 子标签。@WebInitParam 具有下表给出的一些常用属性:
表 2. @WebInitParam 的常用属性
@WebFilter
@WebFilter 用于将一个类声明为过滤器,该注解将会在部署时被容器处理,容器将根据具体的属性配置将相应的类部署为过滤器。该注解具有下表给出的一些常用属性 ( 以下所有属性均为可选属性,但是 value、urlPatterns、servletNames 三者必需至少包含一个,且 value 和 urlPatterns 不能共存,如果同时指定,通常忽略 value 的取值 ):
表 3. @WebFilter 的常用属性
下面是一个简单的示例:
@WebFilter(servletNames = {"SimpleServlet"},filterName="SimpleFilter") public class LessThanSixFilter implements Filter{...}
如此配置之后,就可以不必在 web.xml 中配置相应的 1d24e586ca31f4bd05eca427459d98c7 和 dd0dfb26ea66647667f179a739921d33 元素了,容器会在部署时根据指定的属性将该类发布为过滤器。它等价的 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
该注解使用非常简单,其属性如下:
表 4. @WebListener 的常用属性
一个简单示例如下:
@WebListener("This is only a demo listener") public class SimpleListener implements ServletContextListener{...}
如此,则不需要在 web.xml 中配置 eae7f28921fa176b20e23abb843be090 标签了。它等价的 web.xml 中的配置形式如下:
<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 文件示例如下:
<?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 包含了两个可选的顶层标签,8a11bc632ea32a57b3e3693c7987c420 和 792ac9b21a68bcc1f9ef5893f6dde014,如果希望为当前的文件指定明确的加载顺序,通常需要使用这两个标签,8a11bc632ea32a57b3e3693c7987c420 主要用于标识当前的文件,而 792ac9b21a68bcc1f9ef5893f6dde014 则用于指定先后顺序。一个简单的示例如下:
<web-fragment...> <name>FragmentA</name> <ordering> <after> <name>FragmentB</name> <name>FragmentC</name> </after> <before> <others/> </before> </ordering> ... </web-fragment>
如上所示, 8a11bc632ea32a57b3e3693c7987c420 标签的取值通常是被其它 web-fragment.xml 文件在定义先后顺序时引用的,在当前文件中一般用不着,它起着标识当前文件的作用。
在 792ac9b21a68bcc1f9ef5893f6dde014 标签内部,我们可以定义当前 web-fragment.xml 文件与其他文件的相对位置关系,这主要通过 792ac9b21a68bcc1f9ef5893f6dde014 的 cbc918db1beed770b0e53b074ad87b15 和 963388cc8d4734180f4322c2b988d8a2 子标签来实现的。在这两个子标签内部可以通过 8a11bc632ea32a57b3e3693c7987c420 标签来指定相对应的文件。比如:
<after> <name>FragmentB</name> <name>FragmentC</name> </after>
以上片段则表示当前文件必须在 FragmentB 和 FragmentC 之后解析。963388cc8d4734180f4322c2b988d8a2 的使用于此相同,它所表示的是当前文件必须早于 963388cc8d4734180f4322c2b988d8a2 标签里所列出的 web-fragment.xml 文件。
除了将所比较的文件通过 8a11bc632ea32a57b3e3693c7987c420 在 cbc918db1beed770b0e53b074ad87b15 和 c15bac5f29418fadf3ed61a82491f55a 中列出之外,Servlet 还提供了一个简化的标签 97a887bdc94bec64e0472c45c3e63cd4。它表示除了当前文件之外的其他所有的 web-fragment.xml 文件。该标签的优先级要低于使用 8a11bc632ea32a57b3e3693c7987c420 明确指定的相对位置关系。
ServletContext 的性能增强
除了以上的新特性之外,ServletContext 对象的功能在新版本中也得到了增强。现在,该对象支持在运行时动态部署 Servlet、过滤器、监听器,以及为 Servlet 和过滤器增加 URL 映射等。以 Servlet 为例,过滤器与监听器与之类似。ServletContext 为动态配置 Servlet 增加了如下方法:
ServletRegistration.Dynamic addServlet(String servletName,Class67a2363d32a9733943a65b9e6b37ecfb servletClass)
ServletRegistration.Dynamic addServlet(String servletName, Servlet servlet)
ServletRegistration.Dynamic addServlet(String servletName, String className)
fd2e4e87782626871a925874e70a40e2 T createServlet(Class8742468051c85b06f0a0af9e3e506b5c clazz)
ServletRegistration getServletRegistration(String servletName)
Map5701e386b66809fdf022d23cec5ee5b2 getServletRegistrations()
其中前三个方法的作用是相同的,只是参数类型不同而已;通过 createServlet() 方法创建的 Servlet,通常需要做一些自定义的配置,然后使用 addServlet() 方法来将其动态注册为一个可以用于服务的 Servlet。两个 getServletRegistration() 方法主要用于动态为 Servlet 增加映射信息,这等价于在 web.xml( 抑或 web-fragment.xml) 中使用 870ae7edaa11700bcea972d006efb06e 标签为存在的 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 提供了两个方法用于从请求中解析出上传的文件:
Part getPart(String name) Collection<Part> getParts()
前者用于获取请求中给定 name 的文件,后者用于获取所有的文件。每一个文件用一个 javax.servlet.http.Part 对象来表示。该接口提供了处理文件的简易方法,比如 write()、delete() 等。至此,结合 HttpServletRequest 和 Part 来保存上传的文件变得非常简单,如下所示:
Part photo = request.getPart("photo"); photo.write("/tmp/photo.jpg"); // 可以将两行代码简化为 request.getPart("photo").write("/tmp/photo.jpg") 一行。
另外,开发者可以配合前面提到的 @MultipartConfig 注解来对上传操作进行一些自定义的配置,比如限制上传文件的大小,以及保存文件的路径等。其用法非常简单,故不在此赘述了。
需要注意的是,如果请求的 MIME 类型不是 multipart/form-data,则不能使用上面的两个方法,否则将抛异常。
以上是Java servlet3新特性的具體分析的詳細內容。更多資訊請關注PHP中文網其他相關文章!