servlet3新特性_动力节点Java学院整理

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 为 <servlet> 和 <filter> 标签增加了 <async-supported> 子标签，该标签的默认取值为 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 的顶层标签 <web-app> 有一个 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 中配置相应的 <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 具有下表给出的一些常用属性：

表 2. @webinitparam 的常用属性

@webfilter

@webfilter 用于将一个类声明为过滤器，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为过滤器。该注解具有下表给出的一些常用属性 ( 以下所有属性均为可选属性，但是 value、urlpatterns、servletnames 三者必需至少包含一个，且 value 和 urlpatterns 不能共存，如果同时指定，通常忽略 value 的取值 )：

表 3. @webfilter 的常用属性

下面是一个简单的示例：

@webfilter(servletnames = {"simpleservlet"},filtername="simplefilter")
public class lessthansixfilter implements filter{...}

如此配置之后，就可以不必在 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

该注解使用非常简单，其属性如下：

表 4. @weblistener 的常用属性

一个简单示例如下：

@weblistener("this is only a demo listener")
public class simplelistener implements servletcontextlistener{...}

如此，则不需要在 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。另外，它还提供了若干属性用于简化对上传文件的处理。具体如下：

表 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 包含了两个可选的顶层标签，<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> 明确指定的相对位置关系。

servletcontext 的性能增强

除了以上的新特性之外，servletcontext 对象的功能在新版本中也得到了增强。现在，该对象支持在运行时动态部署 servlet、过滤器、监听器，以及为 servlet 和过滤器增加 url 映射等。以 servlet 为例，过滤器与监听器与之类似。servletcontext 为动态配置 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()

其中前三个方法的作用是相同的，只是参数类型不同而已；通过 createservlet() 方法创建的 servlet，通常需要做一些自定义的配置，然后使用 addservlet() 方法来将其动态注册为一个可以用于服务的 servlet。两个 getservletregistration() 方法主要用于动态为 servlet 增加映射信息，这等价于在 web.xml( 抑或 web-fragment.xml) 中使用 <servlet-mapping> 标签为存在的 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，则不能使用上面的两个方法，否则将抛异常。