servlet異步請求的實現(xiàn)

更新時間：2022年07月25日 10:34:36 作者：liushangzaibeijing

本文主要介紹了servlet異步請求的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

1、什么是servlet異步請求

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

（1）、Servlet 接收到請求之后，可能需要對請求攜帶的數(shù)據(jù)進行一些預(yù)處理；

（2）、調(diào)用業(yè)務(wù)接口的某些方法，以完成業(yè)務(wù)處理；

（3）、根據(jù)處理的結(jié)果提交響應(yīng)，Servlet 線程結(jié)束。

其中第二步處理業(yè)務(wù)邏輯時候很可以碰到比較耗時的任務(wù)，此時servlet主線程會阻塞等待完成業(yè)務(wù)處理，對于并發(fā)比較大的請求可能會產(chǎn)生性能瓶頸，則servlet3.0之后再此處做了調(diào)整，引入了異步的概念。

（1）、Servlet 接收到請求之后，可能需要對請求攜帶的數(shù)據(jù)進行一些預(yù)處理；

（2）、調(diào)用業(yè)務(wù)接口的某些方法過程中request.startAsync()請求，獲取一個AsyncContext

（3）、緊接著servlet線程退出(回收到線程池)，但是響應(yīng)response對象仍舊保持打開狀態(tài)，新增線程會使用AsyncContext處理并響應(yīng)結(jié)果。

（4）、AsyncContext處理完成觸發(fā)某些監(jiān)聽通知結(jié)果

2、Servlet異步請求示例

2.1、示例準備

本示例采用web.xml配置的形式，模擬場景為:筆者所在的it公司每周的工作內(nèi)容，首先研發(fā)總監(jiān)分配給產(chǎn)品、研發(fā)、測試相關(guān)的任務(wù)，布置完任務(wù)就出差(模擬請求響應(yīng))，余下的各個小組進行自己任務(wù)操作（模擬的耗時操作），最終出周報完成任務(wù)（異步任務(wù)處理完成的通知）

git地址：https://github.com/liushangzaibeijing/spsm.git 分支：dev_async

2.2、實現(xiàn)自定義的Servlet

/**
 * @ClassName AsyncServlet
 * @Desc 自定義異步Servlet處理器
 * @Author xieqx
 * @Date 2020/12/9 15:38
 **/
//通過注解的形式開始異步
@WebServlet(urlPatterns = "*.async",asyncSupported = true)
public class AsyncServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
       doPost(req,resp);
    }
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //開啟異步支持
        //異步管理上下文
        resp.setCharacterEncoding("GBK");
        PrintWriter writer = resp.getWriter();
        writer.println("周工作任務(wù)布置開始");
        AsyncContext asyncContext = req.startAsync();
        asyncContext.start(new WeekTask(asyncContext));
        //添加監(jiān)聽器 處理完成監(jiān)聽
        asyncContext.addListener(new AsyncListener() {
            @Override
            public void onComplete(AsyncEvent asyncEvent) throws IOException {
                System.out.println("工作在"+new Date()+"處理完成");
            }
            @Override
            public void onTimeout(AsyncEvent asyncEvent) throws IOException {
                System.out.println("工作在"+new Date()+"處理超時");
            }
            @Override
            public void onError(AsyncEvent asyncEvent) throws IOException {
                System.out.println("工作在"+new Date()+"處理出錯");
            }
            @Override
            public void onStartAsync(AsyncEvent asyncEvent) throws IOException {
                System.out.println("工作在"+new Date()+"處理開始");
            }
        });
        writer.println("周工作任務(wù)布置完成");
        writer.flush();
    }
}

開啟異步支持（默認異步支持不開啟）有兩種方式：

使用注解

web.xml配置

	<servlet>
		<servlet-name>asyncServlet</servlet-name>
		<servlet-class>com.xiu.async.servlet.AsyncServlet</servlet-class>
		<!-- 開啟servlet的異步請求操作 -->
		<async-supported>true</async-supported>
	</servlet>
	<servlet-mapping>
		<servlet-name>asyncServlet</servlet-name>
		<url-pattern>*.async</url-pattern>
	</servlet-mapping>

上述代碼中通過request.startAsync()啟動異步處理返回一個異步上下文對象AsyncContext最終是使用該上下文對象來進行異步業(yè)務(wù)邏輯處理，其中有兩個核心方法

asyncContext.start(new WeekTask(asyncContext)); 添加一個異步任務(wù)該任務(wù)是一個Runnable線程接口，這里就清晰了其實是servlet線程將處理任務(wù)交給另一個子線程，servlet直接返回從而達到提高系統(tǒng)吞吐量的作用。
對于異步請求可以我們需要獲取其中的結(jié)果，所有這里提供了監(jiān)聽器模式添加事件監(jiān)聽AsyncListener

onComplete	異步請求處理完成觸發(fā) 前提示需要調(diào)用 asyncContext.complete()方法（因為程序也不知道什么時候任務(wù)算是調(diào)用完畢了）
onTimeout	異步請求處理超時觸發(fā)，一般來說采用異步請求的任務(wù)都是比較耗時的任務(wù)，所以需要修改servlet默認的超時時間（修改的長一點）
onError	異步處理錯誤的時候觸發(fā)
onStartAsync	異步處理開始的時候觸發(fā)即為request.startAsync(),因為添加監(jiān)聽器在startAsync()方法后，所以第一個啟動是無法觸發(fā)該監(jiān)聽的

這里異步處理只是簡單的打印了相關(guān)日志，不過真實的業(yè)務(wù)場景中可以寫復(fù)雜的業(yè)務(wù)處理邏輯。

2.3、異步任務(wù)

這里提供相關(guān)的異步操作是實現(xiàn)runnable的線程實現(xiàn)類，同時這里提供了相關(guān)Job,PmJob（產(chǎn)品任務(wù)）,RDJob（研發(fā)任務(wù)），TestJob(測試任務(wù))，每個任務(wù)模擬了10秒的耗時任務(wù)。

/**
 * @ClassName WeekTask
 * @Desc 每周任務(wù) 
 * @Author xieqx
 * @Date 2020/12/10 9:36
 **/
public class WeekTask implements Runnable {
 
    private List<Job> jobs = null;
 
    private AsyncContext asyncContext = null;
    //這里初始化產(chǎn)品任務(wù)PmJob、研發(fā)任務(wù)RDJob  測試任務(wù)TestJob
    public WeekTask(AsyncContext asyncContext) {
       this.asyncContext = asyncContext;
       jobs = new ArrayList<>();
       PmJob pmJob = new PmJob();
       RDJob rdJob = new RDJob();
       TestJob testJob = new TestJob();
       jobs.add(pmJob);
       jobs.add(rdJob);
       jobs.add(testJob);
    }
 
    @Override
    public void run() {
        for(Job job:jobs){
            job.execute();
        }
        System.out.println("周任務(wù)工作完成");
        //job執(zhí)行完成后通知
      asyncContext.complete();
    }
}

PmJob

/**
 * @ClassName PmTask
 * @Desc 產(chǎn)品經(jīng)理任務(wù)
 * @Author xieqx
 * @Date 2020/12/9 16:03
 **/
public class PmJob implements Job {
    @Override
    public void execute() {
        System.out.println("產(chǎn)品經(jīng)理開評審會議");
        try {
            Thread.sleep(10);
            System.out.println("模擬需求評審會議...");
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

RDJob

/**
 * @ClassName PmTask
 * @Desc 研發(fā)任務(wù)
 * @Author xieqx
 * @Date 2020/12/9 16:03
 **/
public class RDJob implements Job {
    @Override
    public void execute() {
        System.out.println("程序猿開始開發(fā)");
        try {
            Thread.sleep(10);
            System.out.println("程序猿哼哧哼哧干活中...");
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

TestJob

/**
 * @ClassName TestJob
 * @Desc 測試任務(wù)
 * @Author xieqx
 * @Date 2020/12/9 16:03
 **/
public class TestJob implements Job {
    @Override
    public void execute()  {
        System.out.println("測試開始測試");
        try {
            Thread.sleep(10);
            System.out.println("測試用例測試...");
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}