@RestController和@Controller注解
我们都知道RestController默认都只提供Rest风格接口返回值，针对不需要返回页面的Controller都采用RestController进行注解，下面根据源码简单分析一下两者处理上的区别。
@RestController源码如下。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
/**
* The value may indicate a suggestion for a logical component name,
* to be turned into a Spring bean in case of an autodetected component.
* @return the suggested component name, if any
* @since 4.0.1
*/
String value() default "";
}
@RestController的编写方式依赖注解组合，@RestController被@Controller和@ResponseBody标注，表示@RestController具有两者的注解语义，因此在注解处理时@RestController比@Controller多具有一个@ResponseBody语义，这就是@RestController和@Controller的区别，也是@RestController的返回值为何都是经过转换的json的原因。
所以小结就是：@RestController = @Controller + @ResponseBody；
@ResponseBody注解的处理过程
既然知道@RestController与@Controller的区别是多了一个@ResponseBody语义，我们不妨了解一下@ResponseBody的处理过程。
首先，可以知道，@ResponseBody是一个针对方法返回值进行处理的注解。如果熟悉Spring MVC处理过程的话，可以知道在根据requesturl映射获取到HandlerMethod之后，根据HandlerMethod调度请求方法的对象是HandlerAdapter，方法调用结束，返回值处理的调度对象也是HandlerAdapter。所以，@ResponseBody注解的处理应该也是在HandlerAdapter中完成。（ps：不清楚Spring MVC可以看深入分析Spring MVC）
在RequestMappingHandlerAdapter#invokeHandlerMethod方法里面，有下面几句比较重要的代码
//创建方法调用对象
ServletInvocableHandlerMethod invocableMethod = createInvocableHandlerMethod(handlerMethod);
//......
//设置返回值处理器
invocableMethod.setHandlerMethodReturnValueHandlers(this.returnValueHandlers);
//......
//调用方法
invocableMethod.invokeAndHandle(webRequest, mavContainer);
returnValueHandlers这个变量听名字就像返回值处理，实际上也是对返回值处理的处理器集合。首先创建一个调用方法的对象，然后注入处理器，最后调用方法，这就是完整的一个流程。
我们可以再分析一下这里面的处理器初始化时有没有我们的针对@ResponseBody注解的处理器。
@ResponseBody注解处理器初始化
搜索一下returnValueHandlers初始化的地方，可以看到是这么个调用链：
所以是在RequestMappingHandlerAdapter的bean初始化完成时，就会进行返回值处理器的初始化，在RequestMappingHandlerAdapter#getDefaultReturnValueHandlers方法内部执行，代码如下。
private List<HandlerMethodReturnValueHandler> getDefaultReturnValueHandlers() {
List<HandlerMethodReturnValueHandler> handlers = new ArrayList<HandlerMethodReturnValueHandler>();
// Single-purpose return value types
handlers.add(new ModelAndViewMethodReturnValueHandler());
handlers.add(new ModelMethodProcessor());
handlers.add(new ViewMethodReturnValueHandler());
handlers.add(new ResponseBodyEmitterReturnValueHandler(getMessageConverters()));
handlers.add(new StreamingResponseBodyReturnValueHandler());
handlers.add(new HttpEntityMethodProcessor(getMessageConverters(),
this.contentNegotiationManager, this.requestResponseBodyAdvice));
handlers.add(new HttpHeadersReturnValueHandler());
handlers.add(new CallableMethodReturnValueHandler());
handlers.add(new DeferredResultMethodReturnValueHandler());
handlers.add(new AsyncTaskMethodReturnValueHandler(this.beanFactory));
// Annotation-based return value types
handlers.add(new ModelAttributeMethodProcessor(false));
//@ResponseBody注解处理器
handlers.add(new RequestResponseBodyMethodProcessor(getMessageConverters(),
this.contentNegotiationManager, this.requestResponseBodyAdvice));
// Multi-purpose return value types
handlers.add(new ViewNameMethodReturnValueHandler());
handlers.add(new MapMethodProcessor());
// Custom return value types
if (getCustomReturnValueHandlers() != null) {
handlers.addAll(getCustomReturnValueHandlers());
}
// Catch-all
if (!CollectionUtils.isEmpty(getModelAndViewResolvers())) {
handlers.add(new ModelAndViewResolverMethodReturnValueHandler(getModelAndViewResolvers()));
}
else {
handlers.add(new ModelAttributeMethodProcessor(true));
}
return handlers;
}
可以看到非常对处理器，RequestResponseBodyMethodProcessor就是@ResponseBody的处理器。
@ResponseBody注解处理器调用
进入调用方法invocableMethod.invokeAndHandle(webRequest, mavContainer)/ServletInvocableHandlerMethod#invokeAndHandle,继续进行调用，跟踪调用链如下。
- ServletInvocableHandlerMethod#invokeAndHandle
- this.returnValueHandlers.handleReturnValue/HandlerMethodReturnValueHandlerComposite#handleReturnValue
HandlerMethodReturnValueHandlerComposite#handleReturnValue代码如下所示。
public void handleReturnValue(Object returnValue, MethodParameter returnType,
ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {
//选择一个合适的处理器
HandlerMethodReturnValueHandler handler = selectHandler(returnValue, returnType);
if (handler == null) {
throw new IllegalArgumentException("Unknown return value type: " + returnType.getParameterType().getName());
}
//处理返回值
handler.handleReturnValue(returnValue, returnType, mavContainer, webRequest);
}
so，基本就是从所有处理器中选出目标处理器，处理返回值。进入HandlerMethodReturnValueHandlerComposite#selectHandler
private HandlerMethodReturnValueHandler selectHandler(Object value, MethodParameter returnType) {
boolean isAsyncValue = isAsyncReturnValue(value, returnType);
for (HandlerMethodReturnValueHandler handler : this.returnValueHandlers) {
if (isAsyncValue && !(handler instanceof AsyncHandlerMethodReturnValueHandler)) {
continue;
}
//判断处理器是否支持
if (handler.supportsReturnType(returnType)) {
return handler;
}
}
return null;
}
RequestResponseBodyMethodProcessor#supportsReturnType，代码如下。
public boolean supportsReturnType(MethodParameter returnType) {
return (AnnotatedElementUtils.hasAnnotation(returnType.getContainingClass(), ResponseBody.class) ||
returnType.hasMethodAnnotation(ResponseBody.class));
}
明显如果类上有@ResponseBody或者方法上有的话，就能适配处理器，@RestController具有@ResponseBody语义能够适配，所以进行RequestResponseBodyMethodProcessor#handleReturnValue进行返回值处理。
