servlet3.0 新特性——异步处理

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

首先，Servlet 接收到请求之后，可能需要对请求携带的数据进行一些预处理；

接着，调用业务接口的某些方法，以完成业务处理；

最后，根据处理的结果提交响应，Servlet 线程结束。

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

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

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

首先，Servlet 接收到请求之后，可能首先需要对请求携带的数据进行一些预处理；

接着，Servlet 线程将请求转交给一个异步线程来执行业务处理，线程本身返回至容器，此时 Servlet 还没有生成响应数据，异步线程处理完业务以后，可以直接生成响应数据（异步线程拥有 ServletRequest 和 ServletResponse 对象的引用），或者将请求继续转发给其它 Servlet。

如此一来， Servlet 线程不再是一直处于阻塞状态以等待业务逻辑的处理，而是启动异步线程之后可以立即返回。

1、异步处理特性可以应用于 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>

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 接口表示。它可以监控如下四种事件：

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 { 
        // 做一些清理工作或者其他
    } 
    ... 
});

 

实例：

package com.darren.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,打开
 *
 */
@WebServlet(name="SecondServlet",urlPatterns={"/secondServlet"},asyncSupported=true)
public class SecondServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp)
            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();



            /**
             * AsyncListener为什么没有适配器呢？需要各个厂家实现？
             */
            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;
            }*/
        }

    }
}

MyThread.java：

package com.darren.servlet;

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;
            }*/
        }
    }

}