异步处理

共计 5272 个字符，预计需要花费 14 分钟才能阅读完成。

在 Servlet 模型中，每个请求都是由某个线程处理，然后，将响应写入 IO 流，发送给客户端。从开始处理请求，到写入响应完成，都是在同一个线程中处理的。

实现 Servlet 容器的时候，只要每处理一个请求，就创建一个新线程处理它，就能保证正确实现了 Servlet 线程模型。在实际产品中，例如 Tomcat，总是通过线程池来处理请求，它仍然符合一个请求从头到尾都由某一个线程处理。

这种线程模型非常重要，因为 Spring 的 JDBC 事务是基于 ThreadLocal 实现的，如果在处理过程中，一会由线程 A 处理，一会又由线程 B 处理，那事务就全乱套了。此外，很多安全认证，也是基于 ThreadLocal 实现的，可以保证在处理请求的过程中，各个线程互不影响。

但是，如果一个请求处理的时间较长，例如几秒钟甚至更长，那么，这种基于线程池的同步模型很快就会把所有线程耗尽，导致服务器无法响应新的请求。如果把长时间处理的请求改为异步处理，那么线程池的利用率就会大大提高。Servlet 从 3.0 规范开始添加了异步支持，允许对一个请求进行异步处理。

我们先来看看在 Spring MVC 中如何实现对请求进行异步处理的逻辑。首先建立一个 Web 工程，然后编辑 web.xml 文件如下：

<web-app>
    <display-name>Archetype Created Web Application</display-name>
 
    <servlet>
        <servlet-name>dispatcher</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextClass</param-name>
            <param-value>org.springframework.web.context.support.AnnotationConfigWebApplicationContext</param-value>
        </init-param>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>com.itranswarp.learnjava.AppConfig</param-value>
        </init-param>
        <load-on-startup>0</load-on-startup>
        <async-supported>true</async-supported>
    </servlet>
 
    <servlet-mapping>
        <servlet-name>dispatcher</servlet-name>
        <url-pattern>/*</url-pattern>
    </servlet-mapping>
</web-app>

和前面普通的 MVC 程序相比，这个 web.xml 主要对 DispatcherServlet 的配置多了一个<async-supported>，默认值是false，必须明确写成true，这样 Servlet 容器才会支持 async 处理。

下一步就是在 Controller 中编写 async 处理逻辑。我们以 ApiController 为例，演示如何异步处理请求。

第一种 async 处理方式是返回一个 Callable，Spring MVC 自动把返回的Callable 放入线程池执行，等待结果返回后再写入响应：

@GetMapping("/users")
public Callable<List<User>> users() {return () -> {// 模拟 3 秒耗时:
        try {Thread.sleep(3000);
        } catch (InterruptedException e) { }
        return userService.getUsers();};
}

第二种 async 处理方式是返回一个 DeferredResult 对象，然后在另一个线程中，设置此对象的值并写入响应：

@GetMapping("/users/{id}")
public DeferredResult<User> user(@PathVariable("id") long id) {DeferredResult<User> result = new DeferredResult<>(3000L); // 3 秒超时
    new Thread(() -> {// 等待 1 秒:
        try {Thread.sleep(1000);
        } catch (InterruptedException e) { }
        try {User user = userService.getUserById(id);
            // 设置正常结果并由 Spring MVC 写入 Response:
            result.setResult(user);
        } catch (Exception e) {// 设置错误结果并由 Spring MVC 写入 Response:
            result.setErrorResult(Map.of("error", e.getClass().getSimpleName(), "message", e.getMessage()));
        }
    }).start();
    return result;
}

使用 DeferredResult 时，可以设置超时，超时会自动返回超时错误响应。在另一个线程中，可以调用 setResult() 写入结果，也可以调用 setErrorResult() 写入一个错误结果。

运行程序，当我们访问 http://localhost:8080/api/users/1 时，假定用户存在，则浏览器在 1 秒后返回结果：

访问一个不存在的 User ID，则等待 1 秒后返回错误结果：

使用 Filter

当我们使用 async 模式处理请求时，原有的 Filter 也可以工作，但我们必须在 web.xml 中添加 <async-supported> 并设置为true。我们用两个 Filter：SyncFilter 和 AsyncFilter 分别测试：

<web-app ...>
    ...
    <filter>
        <filter-name>sync-filter</filter-name>
        <filter-class>com.itranswarp.learnjava.web.SyncFilter</filter-class>
    </filter>
 
    <filter>
        <filter-name>async-filter</filter-name>
        <filter-class>com.itranswarp.learnjava.web.AsyncFilter</filter-class>
        <async-supported>true</async-supported>
    </filter>
 
    <filter-mapping>
        <filter-name>sync-filter</filter-name>
        <url-pattern>/api/version</url-pattern>
    </filter-mapping>
 
    <filter-mapping>
        <filter-name>async-filter</filter-name>
        <url-pattern>/api/*</url-pattern>
    </filter-mapping>
    ...
</web-app>

一个声明为支持 <async-supported> 的 Filter 既可以过滤 async 处理请求，也可以过滤正常的同步处理请求，而未声明 <async-supported> 的 Filter 无法支持 async 请求，如果一个普通的 Filter 遇到 async 请求时，会直接报错，因此，务必注意普通 Filter 的 <url-pattern> 不要匹配 async 请求路径。

在 logback.xml 配置文件中，我们把输出格式加上[%thread]，可以输出当前线程的名称：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</Pattern>
        </layout>
    </appender>
    ...
</configuration>

对于同步请求，例如/api/version，我们可以看到如下输出：

2020-05-16 11:22:40 [http-nio-8080-exec-1] INFO  c.i.learnjava.web.SyncFilter - start SyncFilter...
2020-05-16 11:22:40 [http-nio-8080-exec-1] INFO  c.i.learnjava.web.AsyncFilter - start AsyncFilter...
2020-05-16 11:22:40 [http-nio-8080-exec-1] INFO  c.i.learnjava.web.ApiController - get version...
2020-05-16 11:22:40 [http-nio-8080-exec-1] INFO  c.i.learnjava.web.AsyncFilter - end AsyncFilter.
2020-05-16 11:22:40 [http-nio-8080-exec-1] INFO  c.i.learnjava.web.SyncFilter - end SyncFilter.

可见，每个 Filter 和 ApiController 都是由同一个线程执行。

对于异步请求，例如/api/users，我们可以看到如下输出：

2020-05-16 11:23:49 [http-nio-8080-exec-4] INFO  c.i.learnjava.web.AsyncFilter - start AsyncFilter...
2020-05-16 11:23:49 [http-nio-8080-exec-4] INFO  c.i.learnjava.web.ApiController - get users...
2020-05-16 11:23:49 [http-nio-8080-exec-4] INFO  c.i.learnjava.web.AsyncFilter - end AsyncFilter.
2020-05-16 11:23:52 [MvcAsync1] INFO  c.i.learnjava.web.ApiController - return users...

可见，AsyncFilter和 ApiController 是由同一个线程执行的，但是，返回响应的是另一个线程。

对 DeferredResult 测试，可以看到如下输出：

2020-05-16 11:25:24 [http-nio-8080-exec-8] INFO  c.i.learnjava.web.AsyncFilter - start AsyncFilter...
2020-05-16 11:25:24 [http-nio-8080-exec-8] INFO  c.i.learnjava.web.AsyncFilter - end AsyncFilter.
2020-05-16 11:25:25 [Thread-2] INFO  c.i.learnjava.web.ApiController - deferred result is set.

同样，返回响应的是另一个线程。

在实际使用时，经常用到的就是 DeferredResult，因为返回DeferredResult 时，可以设置超时、正常结果和错误结果，易于编写比较灵活的逻辑。

使用 async 异步处理响应时，要时刻牢记，在另一个异步线程中的事务和 Controller 方法中执行的事务不是同一个事务，在 Controller 中绑定的 ThreadLocal 信息也无法在异步线程中获取。

此外，Servlet 3.0 规范添加的异步支持是针对同步模型打了一个“补丁”，虽然可以异步处理请求，但高并发异步请求时，它的处理效率并不高，因为这种异步模型并没有用到真正的“原生”异步。Java 标准库提供了封装操作系统的异步 IO 包java.nio，是真正的多路复用 IO 模型，可以用少量线程支持大量并发。使用 NIO 编程复杂度比同步 IO 高很多，因此我们很少直接使用 NIO。相反，大部分需要高性能异步 IO 的应用程序会选择 Netty 这样的框架，它基于 NIO 提供了更易于使用的 API，方便开发异步应用程序。

练习

使用 Spring MVC 实现异步处理请求。

下载练习

小结

在 Spring MVC 中异步处理请求需要正确配置 web.xml，并返回Callable 或DeferredResult对象。