从一种统一接口的封装方式到SpringMVC调用链的梳理

接口封装方式

接口封装一般是必不可少的，平常遇到的封装方式可能是下面这种，创建一个类ResponseResult，然后返回数据的时候统一返回ResponseResult类型的对象。

@Data
@Builder
public class ResponseResult<T> {
    private String status;
    private String message;
    private T data;

    public static <T> ResponseResult<T> success(String status, T data, String message) {
        ~~~~
    }

    public static <T> ResponseResult<T> fail(String status, T data, String message) {
       ~~~~~
    }

    ~~~~~~
}

然后我在我们项目里面返现，我们返回数据的时候并没有封装统一的返回类型，但是返回的结构却是这样的：

{
    "code": 2000,  
    "msg": "请求成功",
    "data": {}
}

这里肯定是做了一个统一的返回处理，于是我找到了这个文件（隐藏了部分真实代码）：

public class ResponseReturnValueHandler implements HandlerMethodReturnValueHandler {

    private HandlerMethodReturnValueHandler returnValueHandler;

    public ResponseReturnValueHandler(HandlerMethodReturnValueHandler returnValueHandler) {
        this.returnValueHandler = returnValueHandler;
    }

    @Override
    public boolean supportsReturnType(MethodParameter methodParameter) {
        return returnValueHandler.supportsReturnType(methodParameter);
    }

    @Override
    public void handleReturnValue(Object returnValue, MethodParameter methodParameter, ModelAndViewContainer modelAndViewContainer, NativeWebRequest nativeWebRequest) throws Exception {
            Map<String, Object> resultMap = new HashMap<>(3);
            resultMap.put("code", 2000);
            resultMap.put("msg", "");
            resultMap.put("data", returnValue);
            returnValueHandler.handleReturnValue(resultMap, methodParameter, modelAndViewContainer, nativeWebRequest);
    }
    
}

我们可以看到这里实现了 springweb 包下的 HandlerMethodReturnValueHandler 接口，重写 handleReturnValue方法，就实现了统一封装功能（数据正常的情况下）。

springMVC的调用链

通过 handleReturnValue 方法，我一路往上查找，一直找到了 springMVC 最重要的 DispatcherServlet 类。

我们知道 DispatcherServlet 是实现了 Servlet 接口的，而 Servlet 对请求的处理是从 service 方法开始的，所以我找到了 FrameworkServlet（DispatcherServlet 的父类） 的 service 方法。

最后总结出他的调用链大概是这样的。

//FrameworkServlet 中还重写了各种请求对应的方法，如 doPost、doGet,都是调用了processRequest方法去处理。
FrameworkServlet#service()
FrameworkServlet#processRequest()
//主要是设置一些变量，主要处理还是靠doDispatch方法
DispatcherServlet#doService()
//DispatcherServlet 最核心的方法，网上的SpringMVC的工作流程图中的主要步骤都来自这个方法。
DispatcherServlet#doDispatch()
AbstractHandlerMethodAdapter#handle()
RequestMappingHandlerAdapter#handleInternal()
RequestMappingHandlerAdapter#invokeHandlerMethod()
ServletInvocableHandlerMethod#invokeAndHandle()
HandlerMethodReturnValueHandlerComposite#handleReturnValue()
HandlerMethodReturnValueHandlerComposite#selectHandler()
//最后能调用到这，所以能实现统一封装的功能
HandlerMethodReturnValueHandler#handleReturnValue()

最后贴一下 DispatcherServlet#doDispatch() 的源码（部分）：

/**
	 * Process the actual dispatching to the handler.
	 * <p>The handler will be obtained by applying the servlet's HandlerMappings in order.
	 * The HandlerAdapter will be obtained by querying the servlet's installed HandlerAdapters
	 * to find the first that supports the handler class.
	 * <p>All HTTP methods are handled by this method. It's up to HandlerAdapters or handlers
	 * themselves to decide which methods are acceptable.
	 * @param request current HTTP request
	 * @param response current HTTP response
	 * @throws Exception in case of any kind of processing failure
	 */
	protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
		HttpServletRequest processedRequest = request;
		HandlerExecutionChain mappedHandler = null;
		boolean multipartRequestParsed = false;

		WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);

		try {
			ModelAndView mv = null;
			Exception dispatchException = null;

			try {
				processedRequest = checkMultipart(request);
				multipartRequestParsed = (processedRequest != request);

				// Determine handler for the current request.
				mappedHandler = getHandler(processedRequest);
				if (mappedHandler == null || mappedHandler.getHandler() == null) {
					noHandlerFound(processedRequest, response);
					return;
				}

				// Determine handler adapter for the current request.
				HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());

				// Process last-modified header, if supported by the handler.
				String method = request.getMethod();
				boolean isGet = "GET".equals(method);
				if (isGet || "HEAD".equals(method)) {
					long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
					if (logger.isDebugEnabled()) {
						logger.debug("Last-Modified value for [" + getRequestUri(request) + "] is: " + lastModified);
					}
					if (new ServletWebRequest(request, response).checkNotModified(lastModified) && isGet) {
						return;
					}
				}

				if (!mappedHandler.applyPreHandle(processedRequest, response)) {
					return;
				}

				// Actually invoke the handler.
				mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

				if (asyncManager.isConcurrentHandlingStarted()) {
					return;
				}

				applyDefaultViewName(processedRequest, mv);
				mappedHandler.applyPostHandle(processedRequest, response, mv);
			}
			~~~~~~~
	}

然后你会发现这个图的每一步都是在上面这个方法里面（图片实在网上随便找的，基本上都类似）。