servlet3新特性——异步请求处理

Servlet3.0 新特性：

Servlet 3.0 作为 Java EE 6 规范体系中一员，随着 Java EE 6 规范一起发布。该版本在前一版本（Servlet 2.5）的基础上提供了若干新特性用于简化 Web 应用的开发和部署（Tomcat7提供了对Java EE6规范的支持。）。如下：

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

注解

servlet3.0中使用注解方式来简化web.xml中对Servlet（Filter，Listener）的配置，当然不仅仅是对Servlet进行配置。同样，也可以使用web.xml，在标签下有一属性metadata-complete=”true” 在设置true时，Servlet中的注解会失效，默认值为false。

注：在注解和web.xml中同时对一个url-pattern进行设置时，我实验的结果是注解会覆盖web.xml中的设置。

异步请求处理

Servlet 3.0 之前，一个普通 Servlet 的主要工作流程大致如下：

1. 首先，Servlet 接收到请求之后，可能需要对请求携带的数据进行一些预处理；
2. 接着，调用业务接口的某些方法，以完成业务处理；
3. 最后，根据处理的结果提交响应，Servlet 线程结束。

其中第二步的业务处理通常是最耗时的，这主要体现在数据库操作，以及其它的跨网络调用等，在此过程中，Servlet 线程一直处于阻塞状态，直到业务方法执行完毕。在处理业务的过程中，Servlet 资源一直被占用而得不到释放，对于并发较大的应用，这有可能造成性能的瓶颈。即使在业务类中开启一个线程，线程处理后的结果是无法返回给页面的，因为servlet执行完毕后，response就关闭了，无法将后台更新数据即时更新到页面端。

注：servlet3.0 以前通常是采用私有解决方案来提前结束 Servlet 线程，并及时释放资源。

Servlet 3.0 针对这个问题做了开创性的工作，现在通过使用 Servlet 3.0 的异步处理支持，之前的 Servlet 处理流程可以调整为如下的过程：

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

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

1）对于使用传统的部署描述文件 (web.xml) 配置 Servlet 和过滤器的情况，Servlet 3.0 为 和 标签增加了 子标签，该标签的默认取值为 false，要启用异步处理支持，则将其设为 true 即可。以 Servlet 为例，其配置方式如下所示：

<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，要启用异步处理支持，只需将该属性设置为 true 即可。以 @WebFilter 为例，其配置方式如下所示：
@WebFilter(urlPatterns = “/demo”,asyncSupported = true)
public class DemoFilter implements Filter{…}

2、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 ctx = req.startAsync(); 
ctx.addListener(new AsyncListener() { 
    public void onComplete(AsyncEvent asyncEvent) throws IOException { 
        // 做一些清理工作或者其他
    } 
    ... 
});

3、为什么web应用中支持异步：

推出异步，主要是针对那些比较耗时的请求：比如一次缓慢的数据库查询，一次外部REST API调用, 或者是其他一些I/O密集型操作。这种耗时的请求会很快的耗光Servlet容器的线程池，继而影响可扩展性。

1）一些情况下，你可以立即返回客户端，而由服务器后台程序完成处理。比如在service层通过起一个线程：发送一封电子邮件，完成一个数据库作业等，而主线程立即返回到web层，关闭这次请求。
2）在另一些情况下，必须要返回处理结果，那么我们就需要把处理过程从Servlet容器中解耦出来，否则我们将耗光线程池。Servlet 3提供了这种支持，Servlet (或者Spring MVC的控制器) 能够指示response在Servlet容器的线程退出之后保持开放状态。
要实现这种效果, Servlet 3 web应用可以调用request.startAsync()，然后在其他独立的线程中使用返回的AsyncContext来继续向response写入信息。同时，从客户端的角度来看，request仍然像任何其他的HTTP的request-response交互一样，只是耗费了更长的时间而已。下面是事件的顺序:

1. 客户端发送一个请求
2. Servlet容器分配一个线程来处理容器中的一个servlet
3. servlet调用request.startAsync()，保存AsyncContext, 然后返回
4. 任何方式存在的容器线程都将退出，但是response仍然保持开放
5. 其他线程使用保存的AsyncContext来完成响应
6. 客户端收到响应

实例

1、servlet：

import java.io.IOException;
import java.io.PrintWriter;
import java.util.Date;
import javax.servlet.AsyncContext;
import javax.servlet.AsyncEvent;
import javax.servlet.AsyncListener;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;


/** * servlet3.0默认是不支持异步的通过asyncSupported=true,打开 *  */
 * servlet3.0默认是不支持异步的通过asyncSupported=true,打开
 * 
 */
@WebServlet(name="SecondServlet",urlPatterns={"/secondServlet"},asyncSupported=true)
public class SecondServlet extends HttpServlet {

	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp)		throws ServletException, IOException {
		throws ServletException, IOException 
		PrintWriter out = null;
		
		resp.setContentType("text/html");
		try {
			out = resp.getWriter();
			out.print("servlets starts:"+new Date()+"<br>");
			out.flush();
			
			AsyncContext asyncContext = req.startAsync();
			
			asyncContext.addListener(new AsyncListener(){

	                               public void onComplete(AsyncEvent asyncEvent) throws IOException {
		                             //将流在这里关闭
		                             asyncEvent.getSuppliedResponse().getWriter().close();
		                             System.out.println("asynContext finished....");
	                               }

	                               public void onError(AsyncEvent arg0) throws IOException {
		                             // TODO Auto-generated method stub
	                               }

	                               public void onStartAsync(AsyncEvent arg0) throws IOException {
		                            // TODO Auto-generated method stub
	                               }

	                               public void onTimeout(AsyncEvent arg0) throws IOException {
		                           // TODO Auto-generated method stub
	                               }
	                    });
	
	                   new Thread(new MyThread(asyncContext)).start();//线程
	
	                   out.print("servlets ends:"+new Date()+"<br>");
	                   out.flush();
	
	} finally {
	//一开是在这里关闭了,关了,后面就用不成了 :）
	/*if(null != out){		out.close();		out = null;	}*/
		out.close();
		out = null;
	}*/
	}
	}
}

2、线程：

import java.io.IOException;
import java.io.PrintWriter;
import java.util.Date;
import javax.servlet.AsyncContext;

public class MyThread implements Runnable {

	private AsyncContext asyncContext;
	
	public MyThread(AsyncContext asyncContext) {
		this.asyncContext = asyncContext;
	}

	public void run() {
		PrintWriter out = null;
		
		try {
			try {
				Thread.sleep(10000);
			} catch (InterruptedException e) {
				e.printStackTrace();
			}
			out = asyncContext.getResponse().getWriter();
			out.println("myTask starts:"+new Date()+"<br>");
			out.flush();
			
			
			out.print("myTask ends:"+new Date()+"<br>");
			out.flush();
			asyncContext.complete();
			
		} catch (IOException e) {
			e.printStackTrace();
		}finally{
			
			/*if(null != out){				out.close();				out = null;			}*/
				out.close();
				out = null;
			}*/
		}
	}
}