Servlet 3.0介绍

注意:Servlet3.0的项目一定要使用Tomcat7.0才能看到效果!!

一、Servlet3.0概述

Servlet 3.0 作为 Java EE 6 规范体系中一员,随着 Java EE 6 规范一起发布。该版本在前一版本(Servlet 2.5)的基础上提供了若干新特性用于简化 Web 应用的开发和部署。其中有几项特性的引入让开发者感到非常兴奋。

  1. 新增的注解支持:该版本新增了若干注解,用于简化 Servlet、过滤器(Filter)和监听器(Listener)的声明,这使得 web.xml 部署描述文件从该版本开始不再是必选的了。
  2. 异步处理支持:有了该特性,Servlet 线程不再需要一直阻塞,直到业务处理完毕才能再输出响应,最后才结束该 Servlet 线程。在接收到请求之后,Servlet 线程可以将耗时的操作委派给另一个线程来完成,自己在不生成响应的情况下返回至容器。针对业务处理较耗时的情况,这将大大减少服务器资源的占用,并且提高并发处理速度。
  3. 可插性支持:熟悉 Struts2 的开发者一定会对其通过插件的方式与包括 Spring 在内的各种常用框架的整合特性记忆犹新。将相应的插件封装成 JAR 包并放在类路径下,Struts2 运行时便能自动加载这些插件。现在 Servlet 3.0 提供了类似的特性,开发者可以通过插件的方式很方便的扩充已有 Web 应用的功能,而不需要修改原有的应用。

二、新增的注解支持

Servlet 3.0 的部署描述文件 web.xml 的顶层标签 <web-app> 有一个 metadata-complete 属性,该属性指定当前的部署描述文件是否是完全的。如果设置为 true,则容器在部署时将只依赖部署描述文件,忽略所有的注解(同时也会跳过 web-fragment.xml 的扫描,亦即禁用可插性支持);如果不配置该属性,或者将其设置为 false,则表示启用注解支持(和可插性支持)。

@WebServlet

@WebServlet 用于将一个类声明为 Servlet,该注解将会在部署时被容器处理,容器将根据具体的属性配置将相应的类部署为 Servlet。该注解具有下表给出的一些常用属性(以下所有属性均为可选属性,但是 vlaue 或者 urlPatterns 通常是必需的,且二者不能共存,如果同时指定,通常是忽略 value 的取值):

属性名类型描述
nameString指定 Servlet 的 name 属性,等价于 <servlet-name>。如果没有显式指定,则该 Servlet 的取值即为类的全限定名。
valueString[]该属性等价于 urlPatterns 属性。两个属性不能同时使用。
urlPatternsString[]指定一组 Servlet 的 URL 匹配模式。等价于 <url-pattern> 标签。
loadOnStartupint指定 Servlet 的加载顺序,等价于 <load-on-startup> 标签。
initParamsWebInitParam[]指定一组 Servlet 初始化参数,等价于 <init-param> 标签。
asyncSupportedboolean声明 Servlet 是否支持异步操作模式,等价于 <async-supported> 标签。
descriptionString该 Servlet 的描述信息,等价于 <description> 标签。
displayNameString该 Servlet 的显示名,通常配合工具使用,等价于 <display-name> 标签。

@WebInitParam

该注解通常不单独使用,而是配合 @WebServlet 或者 @WebFilter 使用。它的作用是为 Servlet 或者过滤器指定初始化参数,这等价于 web.xml 中 <servlet> 和 <filter> 的 <init-param> 子标签。@WebInitParam 具有下表给出的一些常用属性:

属性名类型是否可选描述
nameString指定参数的名字,等价于 <param-name>。
valueString指定参数的值,等价于 <param-value>。
descriptionString关于参数的描述,等价于 <description>。

@WebFilter

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

属性名类型描述
filterNameString指定过滤器的 name 属性,等价于 <filter-name>
valueString[]该属性等价于 urlPatterns 属性。但是两者不应该同时使用。
urlPatternsString[]指定一组过滤器的 URL 匹配模式。等价于 <url-pattern> 标签。
servletNamesString[]指定过滤器将应用于哪些 Servlet。取值是 @WebServlet 中的 name 属性的取值,或者是 web.xml 中 <servlet-name> 的取值。
dispatcherTypesDispatcherType指定过滤器的转发模式。具体取值包括:
ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。
initParamsWebInitParam[]指定一组过滤器初始化参数,等价于 <init-param> 标签。
asyncSupportedboolean声明过滤器是否支持异步操作模式,等价于 <async-supported> 标签。
descriptionString该过滤器的描述信息,等价于 <description> 标签。
displayNameString该过滤器的显示名,通常配合工具使用,等价于 <display-name> 标签。

@WebListener

该注解用于将类声明为监听器,被 @WebListener 标注的类必须实现以下至少一个接口:

  • ServletContextListener
  • ServletContextAttributeListener
  • ServletRequestListener
  • ServletRequestAttributeListener
  • HttpSessionListener
  • HttpSessionAttributeListener
属性名类型是否可选描述
valueString该监听器的描述信息。

@MultipartConfig

该注解主要是为了辅助 Servlet 3.0 中 HttpServletRequest 提供的对上传文件的支持。该注解标注在 Servlet 上面,以表示该 Servlet 希望处理的请求的 MIME 类型是 multipart/form-data。另外,它还提供了若干属性用于简化对上传文件的处理。

常用属性:

属性名类型是否可选描述
fileSizeThresholdint当数据量大于该值时,内容将被写入文件。
locationString存放生成的文件地址。
maxFileSizelong允许上传的文件最大值。默认值为 -1,表示没有限制。
maxRequestSizelong针对该 multipart/form-data 请求的最大数量,默认值为 -1,表示没有限制。

三、异步处理支持

在Servlet 3.0 之前,一个普通 Servlet 的主要工作流程大致如下:

Servlet ç主è¦å·¥ä½æµç¨

其中黄色阶段通常是最耗时的,因为业务处理一般涉及数据库操作,还会受到网络等的影响,而在此过程中,Servlet 线程一直处于阻塞状态,直到业务处理完毕。在处理业务的过程中,Servlet 资源一直被占用而得不到释放,对于并发较大的应用,这有可能造成性能的瓶颈。对此,在以前通常是采用私有解决方案来提前结束 Servlet 线程,并及时释放资源。

为解决这个问题,Servlet 3.0 就开始支持异步处理了,之前的 Servlet 处理流程可以调整为如下的过程:

Servlet3.0 å¤çæµç¨

首先,Servlet 接收到请求之后,可能首先需要对请求携带的数据进行一些预处理;接着,Servlet 线程将请求转交给一个异步线程来执行业务处理,线程本身返回至容器,此时 Servlet 还没有生成响应数据,异步线程处理完业务以后,可以直接生成响应数据(异步线程拥有 ServletRequest 和 ServletResponse 对象的引用),或者将请求继续转发给其它 Servlet。如此一来, Servlet 线程不再是一直处于阻塞状态以等待业务逻辑的处理,而是启动异步线程之后可以立即返回。

启用异步处理

异步处理特性可以应用于 Servlet 和过滤器两种组件。在默认情况下,Servlet 和过滤器并没有开启异步处理特性,因为异步处理的工作模式和普通工作模式在实现上有着本质的区别,因此如果希望使用该特性,则必须按照如下的方式启用:

1、在 web.xml 文件中启动

Servlet3.0 默认是没有 web.xml 文件的,但 Servlet3.0 也是支持 web.xml 文件的,较 Servlet之前的版本,Servlet 3.0 在 <servlet>和 <filter> 标签中增加了 <async-supported> 子标签,该标签默认是 false 。如果想启用异步支持,只需要置为 true 即可。例如:

<!-- servlet -->
<servlet> 
    <servlet-name>asynServlet</servlet-name> 
    <servlet-class>com.servlet.AsynServlet</servlet-class> 
    <async-supported>true</async-supported> 
</servlet>
<!-- Filter -->
<filter>
	<filter-name>asynFilter</filter-name>
	<filter-class>com.filter.AsynFilter</filter-class>
	<async-supported>true</async-supported>
</filter>

2、通过注解开启异步支持

Servlet 3.0 提供的 @WebServlet 和 @WebFilter 进行 Servlet 或 Filter 配置的情况,这两个注解都提供了 asyncSupported 属性,默认该属性的取值为 false。如果想启用异步支持,只需要置为 true 即可。例如:

@WebServlet(value="/asyn-servlet",asyncSupported=true)
public class ServletAsyn extends HttpServlet {...}

@WebFilter(value="/*",asyncSupported=true)
public class FilterAsyn implements Filter {...}

异步处理的代码实现方式

Servlet 和 Filter 使用异步支持的实现方式是一模一样的操作。这里只以 Servlet 的实现方式为例。

模拟注册发信息到邮件的简单的异步处理 Servlet 示例代码:

package com.servlet;

import java.io.IOException;

import javax.servlet.AsyncContext;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@WebServlet(value="/asyn-servlet",asyncSupported=true)
public class ServletAsyn extends HttpServlet {
	private static final long serialVersionUID = 1L;

	protected void doGet(HttpServletRequest request, HttpServletResponse response) 
			throws ServletException, IOException {
		System.out.println("Servlet is start");
		
		//1.获得异步上下文对象
		AsyncContext ac = request.startAsync();
		//2.启动一个耗时的子线程
		ThreadTask tt = new ThreadTask(ac);
		//3.可设置异步超时对象,需在启动异步上下文对象前设置
		/*
		 * 设置超时后,在超时时间内子线程没有结束,主线程则会停止等待,继续往下执行
		 */
		ac.setTimeout(3000);
		//4.开启异步上下文对象
		ac.start(tt);
		
		//主线程结束向客户端发送消息
		System.out.println("Servlet is end");
		response.setContentType("text/html;charset=utf-8");
		response.getWriter().append("信息已发送到邮箱");
	}

	protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
		doGet(request, response);
	}

}

异步线程的执行类

package com.servlet;

import java.util.Date;

import javax.servlet.AsyncContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

public class ThreadTask implements Runnable{
	private AsyncContext ac;  //定义一个异步上下文
	
	public ThreadTask(AsyncContext ac) {
		super();
		this.ac = ac;
	}

	@Override
	public void run() {
		/*
		 * 服务端异步典型应用是注册时向邮箱发送验证码
		 */
		try {
			//进行异步的一些处理
			HttpServletRequest requst = (HttpServletRequest) ac.getRequest();
			HttpSession session = requst.getSession();
			System.out.println("asyn-task start" + new Date());
			for(int i=5;i>0; i--) {
				System.out.println(i);
				Thread.sleep(1000);
			}
			//将结果放到session等方式
			session.setAttribute("message", "This is the result of asyn");
			System.out.println("asyn-task end" + new Date());
			
			//通知主线程已经处理完成
			/* 
			 * 除了使用 ac.complete() 方法通知主线程已经处理外
			 * 还可以使用 ac.dispatch() 方法重定向到一个页面
			 */
			ac.dispatch("/show.jsp");
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
	
}

这里的 show.jsp 模拟为指定邮箱。show.jsp页面body标签内代码为:<p>邮箱内容:${message }</p>

对异步处理过程的监听

除此之外,Servlet 3.0 还为异步处理提供了一个监听器,使用 AsyncListener 接口表示。它可以监控如下四种事件:

  • 异步线程开始时,调用 AsyncListener 的 onStartAsync(AsyncEvent event) 方法;
  • 异步线程出错时,调用 AsyncListener 的 onError(AsyncEvent event) 方法;
  • 异步线程执行超时,则调用 AsyncListener 的 onTimeout(AsyncEvent event) 方法;
  • 异步执行完毕时,调用 AsyncListener 的 onComplete(AsyncEvent event) 方法。

如果要注册一个 AsyncListener,只需将准备好的 AsyncListener 对象传递给 AsyncContext 对象的 addListener() 方法即可,如下所示:

AsyncContext ac = request.startAsync();
ac.addListener(new AsyncListener() {
			@Override
			public void onComplete(AsyncEvent arg0) 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
			}
			
		});

四、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,则不能使用上面的两个方法,否则将抛异常。

六、参考

https://blog.csdn.net/qq_24598601/article/details/82824937

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

codedot

你的鼓励是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值