learn-tech/专栏/深入拆解TomcatJetty/27新特性:Tomcat如何支持异步Servlet?.md
2024-10-16 09:22:22 +08:00

11 KiB
Raw Permalink Blame History

                        因收到Google相关通知网站将会择期关闭。相关通知内容
                        
                        
                        27 新特性Tomcat如何支持异步Servlet
                        通过专栏前面的学习我们知道当一个新的请求到达时Tomcat和Jetty会从线程池里拿出一个线程来处理请求这个线程会调用你的Web应用Web应用在处理请求的过程中Tomcat线程会一直阻塞直到Web应用处理完毕才能再输出响应最后Tomcat才回收这个线程。

我们来思考这样一个问题假如你的Web应用需要较长的时间来处理请求比如数据库查询或者等待下游的服务调用返回那么Tomcat线程一直不回收会占用系统资源在极端情况下会导致“线程饥饿”也就是说Tomcat和Jetty没有更多的线程来处理新的请求。

那该如何解决这个问题呢方案是Servlet 3.0中引入的异步Servlet。主要是在Web应用里启动一个单独的线程来执行这些比较耗时的请求而Tomcat线程立即返回不再等待Web应用将请求处理完这样Tomcat线程可以立即被回收到线程池用来响应其他请求降低了系统的资源消耗同时还能提高系统的吞吐量。

今天我们就来学习一下如何开发一个异步Servlet以及异步Servlet的工作原理也就是Tomcat是如何支持异步Servlet的让你彻底理解它的来龙去脉。

异步Servlet示例

我们先通过一个简单的示例来了解一下异步Servlet的实现。

@WebServlet(urlPatterns = {"/async"}, asyncSupported = true) public class AsyncServlet extends HttpServlet {

//Web应用线程池用来处理异步Servlet
ExecutorService executor = Executors.newSingleThreadExecutor();

public void service(HttpServletRequest req, HttpServletResponse resp) {
    //1. 调用startAsync或者异步上下文
    final AsyncContext ctx = req.startAsync();

   //用线程池来执行耗时操作
    executor.execute(new Runnable() {

        @Override
        public void run() {

            //在这里做耗时的操作
            try {
                ctx.getResponse().getWriter().println("Handling Async Servlet");
            } catch (IOException e) {}

            //3. 异步Servlet处理完了调用异步上下文的complete方法
            ctx.complete();
        }

    });
}

}

上面的代码有三个要点:

通过注解的方式来注册Servlet除了@WebServlet注解还需要加上asyncSupported=true的属性表明当前的Servlet是一个异步Servlet。 Web应用程序需要调用Request对象的startAsync方法来拿到一个异步上下文AsyncContext。这个上下文保存了请求和响应对象。 Web应用需要开启一个新线程来处理耗时的操作处理完成后需要调用AsyncContext的complete方法。目的是告诉Tomcat请求已经处理完成。

这里请你注意虽然异步Servlet允许用更长的时间来处理请求但是也有超时限制的默认是30秒如果30秒内请求还没处理完Tomcat会触发超时机制向浏览器返回超时错误如果这个时候你的Web应用再调用ctx.complete方法会得到一个IllegalStateException异常。

异步Servlet原理

通过上面的例子相信你对Servlet的异步实现有了基本的理解。要理解Tomcat在这个过程都做了什么事情关键就是要弄清楚req.startAsync方法和ctx.complete方法都做了什么。

startAsync方法

startAsync方法其实就是创建了一个异步上下文AsyncContext对象AsyncContext对象的作用是保存请求的中间信息比如Request和Response对象等上下文信息。你来思考一下为什么需要保存这些信息呢

这是因为Tomcat的工作线程在request.startAsync调用之后就直接结束回到线程池中了线程本身不会保存任何信息。也就是说一个请求到服务端执行到一半你的Web应用正在处理这个时候Tomcat的工作线程没了这就需要有个缓存能够保存原始的Request和Response对象而这个缓存就是AsyncContext。

有了AsyncContext你的Web应用通过它拿到Request和Response对象拿到Request对象后就可以读取请求信息请求处理完了还需要通过Response对象将HTTP响应发送给浏览器。

除了创建AsyncContext对象startAsync还需要完成一个关键任务那就是告诉Tomcat当前的Servlet处理方法返回时不要把响应发到浏览器因为这个时候响应还没生成呢并且不能把Request对象和Response对象销毁因为后面Web应用还要用呢。

在Tomcat中负责flush响应数据的是CoyoteAdapter它还会销毁Request对象和Response对象因此需要通过某种机制通知CoyoteAdapter具体来说是通过下面这行代码

this.request.getCoyoteRequest().action(ActionCode.ASYNC_START, this);

你可以把它理解为一个Callback在这个action方法里设置了Request对象的状态设置它为一个异步Servlet请求。

我们知道连接器是调用CoyoteAdapter的service方法来处理请求的而CoyoteAdapter会调用容器的service方法当容器的service方法返回时CoyoteAdapter判断当前的请求是不是异步Servlet请求如果是就不会销毁Request和Response对象也不会把响应信息发到浏览器。你可以通过下面的代码理解一下这是CoyoteAdapter的service方法我对它进行了简化

public void service(org.apache.coyote.Request req, org.apache.coyote.Response res) {

//调用容器的service方法处理请求 connector.getService().getContainer().getPipeline(). getFirst().invoke(request, response);

//如果是异步Servlet请求仅仅设置一个标志 //否则说明是同步Servlet请求就将响应数据刷到浏览器 if (request.isAsync()) { async = true; } else { request.finishRequest(); response.finishResponse(); }

//如果不是异步Servlet请求就销毁Request对象和Response对象 if (!async) { request.recycle(); response.recycle(); } }

接下来当CoyoteAdapter的service方法返回到ProtocolHandler组件时ProtocolHandler判断返回值如果当前请求是一个异步Servlet请求它会把当前Socket的协议处理者Processor缓存起来将SocketWrapper对象和相应的Processor存到一个Map数据结构里。

private final Map<S,Processor> connections = new ConcurrentHashMap<>();

之所以要缓存是因为这个请求接下来还要接着处理还是由原来的Processor来处理通过SocketWrapper就能从Map里找到相应的Processor。

complete方法

接着我们再来看关键的ctx.complete方法当请求处理完成时Web应用调用这个方法。那么这个方法做了些什么事情呢最重要的就是把响应数据发送到浏览器。

这件事情不能由Web应用线程来做也就是说ctx.complete方法不能直接把响应数据发送到浏览器因为这件事情应该由Tomcat线程来做但具体怎么做呢

我们知道连接器中的Endpoint组件检测到有请求数据达到时会创建一个SocketProcessor对象交给线程池去处理因此Endpoint的通信处理和具体请求处理在两个线程里运行。

在异步Servlet的场景里Web应用通过调用ctx.complete方法时也可以生成一个新的SocketProcessor任务类交给线程池处理。对于异步Servlet请求来说相应的Socket和协议处理组件Processor都被缓存起来了并且这些对象都可以通过Request对象拿到。

讲到这里你可能已经猜到ctx.complete是如何实现的了

public void complete() { //检查状态合法性,我们先忽略这句 check();

//调用Request对象的action方法其实就是通知连接器这个异步请求处理完了

request.getCoyoteRequest().action(ActionCode.ASYNC_COMPLETE, null);

}

我们可以看到complete方法调用了Request对象的action方法。而在action方法里则是调用了Processor的processSocketEvent方法并且传入了操作码OPEN_READ。

case ASYNC_COMPLETE: { clearDispatches(); if (asyncStateMachine.asyncComplete()) { processSocketEvent(SocketEvent.OPEN_READ, true); } break; }

我们接着看processSocketEvent方法它调用SocketWrapper的processSocket方法

protected void processSocketEvent(SocketEvent event, boolean dispatch) { SocketWrapperBase socketWrapper = getSocketWrapper(); if (socketWrapper != null) { socketWrapper.processSocket(event, dispatch); } }

而SocketWrapper的processSocket方法会创建SocketProcessor任务类并通过Tomcat线程池来处理

public boolean processSocket(SocketWrapperBase socketWrapper, SocketEvent event, boolean dispatch) {

  if (socketWrapper == null) {
      return false;
  }
  
  SocketProcessorBase<S> sc = processorCache.pop();
  if (sc == null) {
      sc = createSocketProcessor(socketWrapper, event);
  } else {
      sc.reset(socketWrapper, event);
  }
  //线程池运行
  Executor executor = getExecutor();
  if (dispatch && executor != null) {
      executor.execute(sc);
  } else {
      sc.run();
  }

}

请你注意createSocketProcessor函数的第二个参数是SocketEvent这里我们传入的是OPEN_READ。通过这个参数我们就能控制SocketProcessor的行为因为我们不需要再把请求发送到容器进行处理只需要向浏览器端发送数据并且重新在这个Socket上监听新的请求就行了。

最后我通过一张在帮你理解一下整个过程:

本期精华

非阻塞I/O模型可以利用很少的线程处理大量的连接提高了并发度本质就是通过一个Selector线程查询多个Socket的I/O事件减少了线程的阻塞等待。

同样异步Servlet机制也是减少了线程的阻塞等待将Tomcat线程和业务线程分开Tomcat线程不再等待业务代码的执行。

那什么样的场景适合异步Servlet呢适合的场景有很多最主要的还是根据你的实际情况如果你拿不准是否适合异步Servlet就看一条如果你发现Tomcat的线程不够了大量线程阻塞在等待Web应用的处理上而Web应用又没有优化的空间了确实需要长时间处理这个时候你不妨尝试一下异步Servlet。

课后思考

异步Servlet将Tomcat线程和Web应用线程分开体现了隔离的思想也就是把不同的业务处理所使用的资源隔离开使得它们互不干扰尤其是低优先级的业务不能影响高优先级的业务。你可以思考一下在你的Web应用内部是不是也可以运用这种设计思想呢

不知道今天的内容你消化得如何?如果还有疑问,请大胆的在留言区提问,也欢迎你把你的课后思考和心得记录下来,与我和其他同学一起讨论。如果你觉得今天有所收获,欢迎你把它分享给你的朋友。