Spring：spring-web中DeferredResult执行过程分析

Bertha 。 2024-03-16 10:38 10阅读 0赞

对于HTTP请求的处理，有时处理请求的时间较长，可能会采用异步处理方式来处理。一般常用的异步处理方式是采用DeferredResult，本文会简单分析一下spring-web的整个处理过程。

首先，提供一个简单的DeferredResult例子：

@RestController
    public class TestController {
    
    	@PostMapping("/test/doRequest")
    	public DeferredResult<String> doRequest(@RequestBody(required = false) String body, HttpServletRequest request) {
    		System.out.println("======================" + request.getDispatcherType());
    		String ret = "ok:" + System.currentTimeMillis();
    
    		DeferredResult<String> dr = new DeferredResult<String>(10000L);
    		Executors.newSingleThreadExecutor().execute(new Runnable() {
    
    			public void run() {
    				try {
    					Thread.sleep(5000);
    				} catch (InterruptedException e) {}
    				dr.setResult(ret);
    			}
    		});
    
    		return dr;
    	}
    }

DeferredResult的内部实际上是使用servlet3.0规范中异步servlet实现的。

以下对版本spring-web-5.2.10.Release的代码进行分析。

HTTP主要是由org.springframework.web.servlet.DispatcherServlet的doDispatch(...)处理的，其中的主要处理方法如下：

![f39c638fdc3748d39b899ee1f270b8c1.png][]

(1)、(4)会分别调用org.springframework.web.servlet.HandlerInterceptor中的对应方法：

public interface HandlerInterceptor {
    
    	default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
    			throws Exception {
    		return true;
    	}
    
    	default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
    			@Nullable ModelAndView modelAndView) throws Exception {
    	}
    
    	default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
    			@Nullable Exception ex) throws Exception {
    	}
    }

(6)会调用org.springframework.web.servlet.AsyncHandlerInterceptor中的对应方法：

public interface AsyncHandlerInterceptor extends HandlerInterceptor {
    
    	default void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response,
    			Object handler) throws Exception {
    	}
    }

从(2)进入后，会调用到org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod的如下方法：

![7e7537245f6c42c2926963391afc88b7.png][]

(7)会调用到TestController.doRequest方法，返回的returnValue就是DeferredResult对象。

(8)中会调用org.springframework.web.servlet.mvc.method.annotation.DeferredResultMethodReturnValueHandler的如下方法：

![491e378aca5a4bd893f123987b800c72.png][]

其中最后一行调用的是org.springframework.web.context.request.async.WebAsyncManager如下方法：

![ccc98a0703d24b33b554457e783feda5.png][]

![1487885026d043b0b23fb09c31dae0a4.png][]

(9)会调用如下方法

![c129e5386c8e45368a381ee7b87ba19e.png][]

其中483行会实际调用javax.servlet.ServletRequest.startAsync(ServletRequest servletRequest,ServletResponse servletResponse)的一个实现，从而开启一个异步处理流程。

(10)调用的是org.springframework.web.context.request.async.DeferredResult如下方法：

![47098bbe80254177b1b60e3149a28c9e.png][]

这里需要特别关注(11)，它分2种情况：  
**\#1**.如果DeferredResult.setResult(...)在此之前未被调用过，则直接返回  
**\#2**.如果DeferredResult.setResult(...)在此之前已被调用过，则执行(12)

其中(12)会调用(13)，(13)会调用(14)，(14)实际会调用javax.servlet.ServletRequest.dispatch()的实现。若此方法被调用，实际会在servlet容器内部再发起一个针对/test/doRequest的请求。

然后返回到(2)后继续向下执行到(3)，(3)最终调用的是org.springframework.web.context.request.async.StandardServletAsyncWebRequest如下方法：

![c6baf97c73044e0b81ec1b331831d91b.png][]

本质上是调用javax.servlet.ServletRequest.isAsyncStarted()的实现。

此时(3)的值为false，程序直接返回。

这里有一个可疑的地方，如果TestController的代码为：

即测试代码中如上直接给DeferredResult设置值，执行javax.servlet.ServletRequest.dispatch()后，根据servlet3.0规范，此时javax.servlet.ServletRequest.isAsyncStarted()应该返回false。但实际用tomcat、jetty都试过，都是返回true，整个流程执行的没有问题。可放到webloigc中执行时，则是返回false，执行整个流程的会报错。

![84f2846f63604b7b8d75c82ae6e31cf3.png][]

无论是\#1还是\#2，最终都会调用到(13)，从而在servlet容器内部再发起一个针对/test/doRequest的请求，此时程序会再次执行到(2)，然后会在org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter的(15)中获取到DeferredResult中设置的值

![cb0b1d436dcf4572a1eaf16ed579ce43.png][]

最终由org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcesso的handleReturnValue方法将返回写回给客户端。

参考文档

[The Java EE Tutorial：17.12 Asynchronous Processing][The Java EE Tutorial_17.12 Asynchronous Processing]  
[spring-framework-docs：1.6. Asynchronous Requests][spring-framework-docs_1.6. Asynchronous Requests]

[f39c638fdc3748d39b899ee1f270b8c1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/d87fe320598349c2b7d2f29beb67aea5.png
[7e7537245f6c42c2926963391afc88b7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/0d720942a857455497f7d44539b4f426.png
[491e378aca5a4bd893f123987b800c72.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/1c261ae8df19453e9cfc17bd821ce71a.png
[ccc98a0703d24b33b554457e783feda5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/1a0a403f18d84b1aa0bbb53a765ce7e9.png
[1487885026d043b0b23fb09c31dae0a4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/6023d42746864263a2f226d7050c44ee.png
[c129e5386c8e45368a381ee7b87ba19e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/3ac76f097c1047d9999e196a2ce198bd.png
[47098bbe80254177b1b60e3149a28c9e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/49cfeb7dc3d8448fa62072acf4aad4de.png
[c6baf97c73044e0b81ec1b331831d91b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/7062eb5a2b8f47228243ab80d28bd810.png
[84f2846f63604b7b8d75c82ae6e31cf3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/75464e44504c403d870dea72c3d7b33e.png
[cb0b1d436dcf4572a1eaf16ed579ce43.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/16/9a404418090844099ed7145e1e0b11c4.png
[The Java EE Tutorial_17.12 Asynchronous Processing]: https://docs.oracle.com/javaee/7/tutorial/servlets012.htm#BEIGCFDF
[spring-framework-docs_1.6. Asynchronous Requests]: https://docs.spring.io/spring-framework/docs/5.3.27/reference/html/web.html#mvc-ann-async