在与同事的一次学习交流中，交流主题为springmvc相关内部原理，同事提出ResponseBody注解的解释类是什么？？即为何加入该注解后返回的是JSON串，与返回ModelAndView的内部处理逻辑有何不同？？于是带着疑问开始了springmvc内部源码的跟踪过程。
在阅读以下内容之前希望大家对springmvc的核心处理逻辑已经有所了解。

编写测试代码

 1@RestController
 2@EnableAutoConfiguration
 3@ComponentScan
 4@SpringBootApplication
 5@EnableAsync
 6public class BasicApplication {
 7
 8  private static final Logger logger = LoggerFactory.getLogger(BasicApplication.class);
 9
10  public static void main(String[] args) {
11    SpringApplication application = new SpringApplication(BasicApplication.class);
12    application.run(args);
13  }
14  @RequestMapping("/")
15  public String index() {
16    return "Welcome!";
17  }
18}

源码跟踪

浏览器访问IP:端口号/

在一步一步介绍源码之前，先来一张springmvc处理返回json的UML序列图：

springmvc返回json处理流程

springmvc核心处理类DispatcherServlet

该类的入口方法是doService，该方法调用doDispatch方法，该方法主要完成以下四件事情：

得到Handler，方法getHandler
得到HandlerAdapter，方法getHandlerAdapter
具体请求处理，方法handle
结果处理及异常处理，方法processDispatchResult

 1protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
 2    //省略部分代码......
 3    // 1.从handlerMappings获得HandlerExecutionChain.
 4    mappedHandler = getHandler(processedRequest);
 5    // 2.获得HandlerAdapter
 6    HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
 7    //省略部分代码......
 8    // 3. 进行具体的请求处理.
 9    mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
10    //省略部分代码......
11
12    // 4.结果处理及异常处理
13    processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
14     //省略部分代码......
15}

方法doDispatch中的handlerMappings和handlerAdapters又是怎么来的呢？？发现是DispatcherServlet继承了FrameworkServlet，覆写了其中onRefresh方法，进行handlerMappings和handlerAdapters的初始化。

 1public class DispatcherServlet extends FrameworkServlet {
 2    //DispatcherServlet继承了FrameworkServlet，在系统启动的时候初始化了相关的参数
 3        @Override
 4    protected void onRefresh(ApplicationContext context) {
 5        initStrategies(context);
 6    }
 7
 8        protected void initStrategies(ApplicationContext context) {
 9            initMultipartResolver(context);
10            initLocaleResolver(context);
11            initThemeResolver(context);
12            //初始化handlerMappings
13            initHandlerMappings(context);
14            //初始化handlerAdapters
15            initHandlerAdapters(context);
16            initHandlerExceptionResolvers(context);
17            initRequestToViewNameTranslator(context);
18            initViewResolvers(context);
19            initFlashMapManager(context);
20        }
21}

在调用getHandler()和getHandlerAdapter时，都进行了相关的判断，如getHandlerAdapter的核心判断逻辑如下：

1//得到HandlerAdapter的核心判断方法
2@Override
3public final boolean supports(Object handler) {
4    return (handler instanceof HandlerMethod && supportsInternal(HandlerMethod)handler));
5}

handlerMappings初始化值（图中颜色较深的为本例中的Handler）：

HandlerMappings

handlerAdapters初始化值（图中颜色较深的为本例中的HandlerAdapter）：

HandlerAdapters

在跟踪完handlerMappings和handlerAdapters之后，我们来查看该方法中的第三步。

AbstractHandlerMethodAdapter

DispatcherServlet中的handle方法调用了该类，该类子类实现了handleInternal方法。
PS.该类使用了模板设计模式（该模式在spring体系中经常使用）

1@Override
2public final ModelAndView handle(HttpServletRequest request, HttpServletResponse response, Object handler)
3            throws Exception {
4    return handleInternal(request, response, (HandlerMethod) handler);
5}

RequestMappingHandlerAdapter

RequestMappingHandlerAdapter继承AbstractHandlerMethodAdapter，主要包含两个方法：

handleInternal
invokeHandlerMethod
getModelAndView

 1public class RequestMappingHandlerAdapter extends AbstractHandlerMethodAdapter
 2        implements BeanFactoryAware, InitializingBean {
 3
 4        protected ModelAndView handleInternal(HttpServletRequest request,
 5            HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
 6        //省略部分代码......
 7        mav = invokeHandlerMethod(request, response, handlerMethod);
 8        //省略部分代码......
 9            return mav;//最终返回的为null
10    }
11    //数据绑定、创建模型和视图容器mavContainer、初始化模型等
12        protected ModelAndView invokeHandlerMethod(HttpServletRequest request,
13            HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
14                //省略部分代码......
15        invocableMethod.invokeAndHandle(webRequest, mavContainer);
16                 //省略部分代码......
17        return getModelAndView(mavContainer, modelFactory, webRequest);
18
19    }
20
21        private ModelAndView getModelAndView(ModelAndViewContainer mavContainer,
22            ModelFactory modelFactory, NativeWebRequest webRequest) throws Exception {
23
24        //省略部分代码......
25        //返回的ModelAndView为null
26        if (mavContainer.isRequestHandled()) {
27            return null;
28        }
29        //省略部分代码......
30 }
31
32}

方法handleInternal调用invokeHandlerMethod，完成mavContainer的初始化。

ServletInvocableHandlerMethod

RequestMappingHandlerAdapter调用了invokeAndHandle方法。

1public void invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer mavContainer,Object... providedArgs) throws Exception {
2    //省略部分代码......
3    //设置RequestHandled=false
4    mavContainer.setRequestHandled(false);
5    //省略部分代码......
6    this.returnValueHandlers.handleReturnValue(
7                    returnValue, getReturnValueType(returnValue), mavContainer, webRequest);
8}
9            //省略部分代码......

HandlerMethodReturnValueHandlerComposite

从HandlerMethodReturnValueHandlerComposite中得到HandlerMethodReturnValueHandler，本例中为RequestResponseBodyMethodProcessor

 1@Override
 2public void handleReturnValue(Object returnValue, MethodParameter returnType,ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {
 3
 4    HandlerMethodReturnValueHandler handler = selectHandler(returnValue, returnType);
 5    //省略部分代码......
 6    //调用RequestResponseBodyMethodProcessor中的handleReturnValue
 7    handler.handleReturnValue(returnValue, returnType, mavContainer, webRequest);
 8}
 9private HandlerMethodReturnValueHandler selectHandler(Object value, MethodParameter returnType) {
10    //省略部分代码......
11    for (HandlerMethodReturnValueHandler handler : this.returnValueHandlers) {
12        //省略部分代码......
13        if (handler.supportsReturnType(returnType)) {
14                return handler;
15        }
16    }
17        return null;
18}

returnValueHandlers的值（颜色较深的为本例中的returnValueHandler）：

returnValueHandlers

RequestResponseBodyMethodProcessor的supportsReturnType方法：

1@Override
2public boolean supportsReturnType(MethodParameter returnType) {
3        //RequestResponseBodyMethodProcessor处理注解ResponseBody
4    return (AnnotatedElementUtils.hasAnnotation(returnType.getContainingClass(), ResponseBody.class) ||
5            returnType.hasMethodAnnotation(ResponseBody.class));
6}

RequestResponseBodyMethodProcessor

1public void handleReturnValue(Object returnValue, MethodParameter returnType,
2            ModelAndViewContainer mavContainer, NativeWebRequest webRequest)
3            throws IOException, HttpMediaTypeNotAcceptableException, HttpMessageNotWritableException {
4//省略部分代码......
5         //重新设置RequestHandled=true，RequestMappingHandlerAdapter中的getModelAndView使用该参数
6        mavContainer.setRequestHandled(true);
7        //省略部分代码......
8        writeWithMessageConverters(returnValue, returnType, inputMessage, outputMessage);
9    }

AbstractMessageConverterMethodProcessor

 1protected <T> void writeWithMessageConverters(T value, MethodParameter returnType,
 2            ServletServerHttpRequest inputMessage, ServletServerHttpResponse outputMessage)
 3            throws IOException, HttpMediaTypeNotAcceptableException, HttpMessageNotWritableException {
 4    //省略部分代码......
 5    if (outputValue != null) {
 6        addContentDispositionHeader(inputMessage, outputMessage);
 7        ((HttpMessageConverter) messageConverter).write(outputValue, selectedMediaType, outputMessage);
 8                //省略部分代码......
 9    }
10}

ssageConverters

结束语

好了，至此已经结束了springmvc的源码跟踪，个人认为最终要的环节在于returnValueHandlers的选择，此外spring中的模板模式、责任链模式是值得学习借鉴的地方，非常感谢大家的阅读。

作者介绍：
作者天禄（企业代号名），目前负责贝壳找房java后台开发的相关工作。

本文转载自公众号贝壳产品技术（ID：gh_9afeb423f390）。

原文链接：

https://mp.weixin.qq.com/s/BuWVxIY7eB4-5Hp_HwQ7qg

创作场景

springmvc 返回 json 内部处理流程