博文参考地址:http://www.cnblogs.com/D-xxm/archive/2013/03/01/2939210.html
一、介绍
Servlet 3.0 作为 Java EE 6 规范体系中一员,随着 Java EE 6 规范一起发布。该版本在前一版本(Servlet 2.5)的基础上提供了若干新特性用于简化 Web 应用的开发和部署。
(1)Servlet、Filter、Listener无需在web.xml中进行配置,可以通过Annotation进行配置;
(2)模块化编程,即将各个Servlet模块化,将配置文件也分开配置。
(3)Servlet异步处理,应对复杂业务处理;
(4)异步Listener,对于异步处理的创建、完成等进行监听;
(5)文件上传API简化;
新增的注解支持:该版本新增了若干注解,用于简化 Servlet、过滤器(Filter)和监听器(Listener)的声明,这使得 web.xml 部署描述文件从该版本开始不再是必选的了。
可插性支持:熟悉 Struts2 的开发者一定会对其通过插件的方式与包括 spring 在内的各种常用框架的整合特性记忆犹新。将相应的插件封装成 JAR 包并放在类路径下,Struts2 运行时便能自动加载这些插件。现在 Servlet 3.0 提供了类似的特性,开发者可以通过插件的方式很方便的扩充已有 Web 应用的功能,而不需要修改原有的应用。
注:tomcat 7.0.X 支持Servlet 3.0
二、异步处理支持
异步处理支持:有了该特性,Servlet 线程不再需要一直阻塞,直到业务处理完毕才能再输出响应,最后才结束该 Servlet 线程。在接收到请求之后,Servlet 线程可以将耗时的操作委派给另一个线程来完成,自己在不生成响应的情况下返回至容器。针对业务处理较耗时的情况,这将大大减少服务器资源的占用,并且提高并发处理速度。
在处理业务的过程中,Servlet 资源一直被占用而得不到释放,对于并发较大的应用,这有可能造成性能的瓶颈。对此,在以前通常是采用私有解决方案来提前结束 Servlet 线程,并及时释放资源。
Servlet3.0通过引入异步处理解决了这个问题。异步处理允许线程调用资源的时候不被阻塞,而是直接返回。AsyncContext负责管理从资源来的回应。AsyncContext决定该回应是应该被原来的线程处理还是应该分发给容器中其他的资源。AsyncContext有一些方法如start,dispatch和complete来执行异步处理。 要想使用Servlet3.0的异步处理,我们需要设置@Webservlet和@WebFilter注解的asyncSupport属性。这个属性是布尔值,缺省值是false。
(1)对于使用传统的部署描述文件 (web.xml) 配置 Servlet 和过滤器的情况,Servlet 3.0 为
(2)对于使用 Servlet 3.0 提供的 @WebServlet 和 @WebFilter 进行 Servlet 或过滤器配置的情况,这两个注解都提供了 asyncSupported 属性,默认该属性的取值为 false,要启用异步处理支持,只需将该属性设置为 true 即可。以 @WebFilter 为例,其配置方式如下所示:
@WebFilter(urlPatterns = "/ServletTest",asyncSupported = true) public class ServletTest extends HttpServlet{...}
一个简单的模拟异步处理的 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 = request.startAsync();
ctx.addListener(new AsyncListener() {
public void onComplete(AsyncEvent asyncEvent) throws IOException {
// TODO Auto-generated method stub
}
@Override
public void onError(AsyncEvent arg0) throws IOException {
// TODO Auto-generated method stub
}
@Override
public void onStartAsync(AsyncEvent arg0) throws IOException {
// TODO Auto-generated method stub
}
@Override
public void onTimeout(AsyncEvent arg0) throws IOException {
// TODO Auto-generated method stub
}
});
三、注解支持
对于原来在web.xml定义的servlet,filter,listener,InitParam都可以通过注解来配置了,而不需要在web.xml中定义。
1 @WebServlet
Servlet3.0之前开发,必须在web.xml中配置如下代码:
现在可以通过@WebServlet注解的形式来配置,省略了xml配置文件。
@WebServlet 用于将一个类声明为 Servlet,该注解将会在部署时被容器处理,容器将根据具体的属性配置将相应的类部署为 Servlet。该注解具有下表给出的一些常用属性(以下所有属性均为可选属性,但是 vlaue 或者 urlPatterns 通常是必需的,且二者不能共存,如果同时指定,通常是忽略 value 的取值)。
@WebServlet 主要属性列表
属性名 |
类型 |
描述 |
name |
String |
指定 Servlet 的 name 属性,等价于 |
value |
String[] |
该属性等价于 urlPatterns 属性。两个属性不能同时使用。 |
urlPatterns |
String[] |
指定一组 Servlet 的 URL 匹配模式。等价于 |
loadOnStartup |
int |
指定 Servlet 的加载顺序,等价于 |
initParams |
WebInitParam[] |
指定一组 Servlet 初始化参数,等价于 |
asyncSupported |
boolean |
声明 Servlet 是否支持异步操作模式,等价于 |
description |
String |
该 Servlet 的描述信息,等价于 |
displayName |
String |
该 Servlet 的显示名,通常配合工具使用,等价于 |
简单示例:
@WebServlet(urlPatterns = {"/servletTest"}, asyncSupported = true,
loadOnStartup = -1, name = "ServletName", displayName = "sn",
initParams = {@WebInitParam(name = "username", value = "wangql")}
) public class ServletTest extends HttpServlet{ … }
对应web.xml配置
<servlet>
<display-name>sn</display-name>
<servlet-name>ServletName</servlet-name>
<servlet-class>com.test.servlet.ServletTest</servlet-class>
<load-on-startup>-1</load-on-startup>
<async-supported>true</async-supported>
<init-param>
<param-name>username</param-name>
<param-value>wangql</param-value>
</init-param></servlet><servlet-mapping>
<servlet-name>ServletTest</servlet-name>
<url-pattern>/servletTest</url-pattern>
</servlet-mapping>
2 @WebInitParam
该注解通常不单独使用,而是配合 @WebServlet 或者 @WebFilter 使用。它的作用是为 Servlet 或者过滤器指定初始化参数,这等价于 web.xml 中
@WebInitParam 具有下表给出的一些常用属性:
属性名 |
类型 |
是否可选 |
描述 |
name |
String |
否 |
指定参数的名字,等价于 |
value |
String |
否 |
指定参数的值,等价于 |
description |
String |
是 |
关于参数的描述,等价于 |
3 @WebFilter
@WebFilter 用于将一个类声明为过滤器,该注解将会在部署时被容器处理,容器将根据具体的属性配置将相应的类部署为过滤器。该注解具有下表给出的一些常用属性 ( 以下所有属性均为可选属性,但是 value、urlPatterns、servletNames 三者必需至少包含一个,且 value 和 urlPatterns 不能共存,如果同时指定,通常忽略 value 的取值 )。
@WebFilter 的常用属性:
属性名 |
类型 |
描述 |
filterName |
String |
指定过滤器的 name 属性,等价于 |
value |
String[] |
该属性等价于 urlPatterns 属性。但是两者不应该同时使用。 |
urlPatterns |
String[] |
指定一组过滤器的 URL 匹配模式。等价于 |
servletNames |
String[] |
指定过滤器将应用于哪些 Servlet。取值是 @WebServlet 中的 name 属性的取值,或者是 web.xml 中 |
dispatcherTypes |
DispatcherType |
指定过滤器的转发模式。具体取值包括:ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。 |
initParams |
WebInitParam[] |
指定一组过滤器初始化参数,等价于 |
asyncSupported |
boolean |
声明过滤器是否支持异步操作模式,等价于 |
description |
String |
该过滤器的描述信息,等价于 |
displayName |
String |
该过滤器的显示名,通常配合工具使用,等价于 |
简单示例:
@WebFilter(servletNames = {"ServletTest"},filterName="WebFilterName") public class WebFilterTest implements Filter{...}
如此配置之后,就可以不必在 web.xml 中配置相应的
4 @WebListener
该注解用于将类声明为监听器,被 @WebListener 标注的类必须实现以下至少一个接口:
(1)ServletContextListener
(2)ServletContextAttributeListener
(3)ServletRequestListener
(4)ServletRequestAttributeListener
(5)HttpSessionListener
(6)HttpSessionAttributeListener
@WebListener 的常用属性
属性名 |
类型 |
是否可选 |
描述 |
value |
String |
是 |
该监听器的描述信息。 |
简单示例:
@WebListener("This is only a demo listener") public class ServletListener implements ServletContextListener{...}
等价的 web.xml 中的配置形式如下:
5 @MultipartConfig
该注解主要是为了辅助 Servlet 3.0 中 HttpServletRequest 提供的对上传文件的支持。该注解标注在 Servlet 上面,以表示该 Servlet 希望处理的请求的 MIME 类型是 multipart/form-data。另外,它还提供了若干属性用于简化对上传文件的处理。具体如下:
属性名 |
类型 |
是否可选 |
描述 |
fileSizeThreshold |
int |
是 |
当数据量大于该值时,内容将被写入文件。 |
location |
String |
是 |
存放生成的文件地址。 |
maxFileSize |
long |
是 |
允许上传的文件最大值。默认值为 -1,表示没有限制。 |
maxRequestSize |
long |
是 |
针对该 multipart/form-data 请求的最大数量,默认值为 -1,表示没有限制。 |
四、可插性(web模块化)支持
如果说 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 文件示例如下:
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">
从上面的示例可以看出,web-fragment.xml 与 web.xml 除了在头部声明的 XSD 引用不同之外,其主体配置与 web.xml 是完全一致的。
由于一个 Web 应用中可以出现多个 web-fragment.xml 声明文件,加上一个 web.xml 文件,需要定义配置文件的加载顺序。
web-fragment.xml 包含了两个可选的顶层标签,
...
如上所示,
在
以上片段则表示当前文件必须在 FragmentB 和 FragmentC 之后解析。
除了将所比较的文件通过
web-fragment.xml注意点:
(1)根元素为
(2)
(3)
(4)
(5)
(6)可以在里面部署listener、filter、servlet
当然可以不设置任何的模块加载顺序;
五、ServletContext 的性能增强
除了以上的新特性之外,ServletContext 对象的功能在新版本中也得到了增强。现在,该对象支持在运行时动态部署 Servlet、过滤器、监听器,以及为 Servlet 和过滤器增加 URL 映射等。
六、HttpServletRequest 对文件上传的支持
Servlet 本身没有对此提供直接的支持,需要使用第三方框架来实现。如今Servlet 3.0 已经提供了这个功能,而且使用也非常简单。为此,HttpServletRequest 提供了两个方法用于从请求中解析出上传的文件:
(1)Part getPart(String name)
获取请求中给定 name 的文件
(2)Collection
获取所有的文件
每一个文件用一个 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 注解来对上传操作进行一些自定义的配置,比如限制上传文件的大小,以及保存文件的路径等。
注意点:
(1)html中 表示文件上传控件;
(2)form的 enctype=”multipart/form-data”;
(3)在Servlet类前加上 @MultipartConfig
(4)request.getPart()获得;
简单实例:
upload.html
UploadServlet.Java
import java.io.*; import javax.servlet.*; import javax.servlet.http.*; import javax.servlet.annotation.*;
@WebServlet(name="UploadServlet" ,urlPatterns={"/upload"}) @MultipartConfig public class UploadServlet extends HttpServlet{
public void init(ServletConfig config)throws ServletException{
super.init(config);
}
public void service(HttpServletRequest request,HttpServletRespons response)throws ServletException,IOException{
Part part = request.getPart("file");
PrintWriter out = response.getWriter();
out.println("此文件的大小:"+part.getSize()+"
");
out.println("此文件类型:"+part.getContentType()+"
");
out.println("文本框内容:"+request.getParameter("name")+"
");
out.println(UploadUtil.getFileName(part)+"
");
part.write("F:\\1."+UploadUtil.getFileType(part));
}
}