Spring MVC @RequestBody @ResponseBody 序列化反序列化实现

前言

Spring MVC 中，标注了 @RequestBody 注解的 Controller 方法参数可以用来接收请求体，标注了 @ResponseBody 注解的 Controller 方法则会将返回值作为响应体。请求体和响应体还可能具有不同的内容类型，例如 json、xml 等等。本篇尝试分析 Spring MVC 如何将请求体反序列化为 Controller 方法参数，以及如何将 Controller 方法返回值序列化为响应体。

Spring MVC @RequestBody 参数解析

Spring MVC 中，Controller 方法参数的解析统一使用 HandlerMethodArgumentResolver，对于 @RequestBody 注解标注的参数同样如此，回顾下这个接口的定义。

public interface HandlerMethodArgumentResolver {

	// 是否支持给定的方法参数
	boolean supportsParameter(MethodParameter parameter);

	// 解析方法参数
	@Nullable
	Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
						   NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception;

}

Spring MVC 内部有很多 HandlerMethodArgumentResolver 接口的实现，默认的实现及能够处理的方法参数见下图。
可以看到，处理 @RequestBody 注解标注参数的实现类为 RequestResponseBodyMethodProcessor，简单看下这个类如何将请求体反序列化为 @RequestBody 参数的。

public class RequestResponseBodyMethodProcessor extends AbstractMessageConverterMethodProcessor {

	@Override
	public boolean supportsParameter(MethodParameter parameter) {
		return parameter.hasParameterAnnotation(RequestBody.class);
	}

	@Override
	public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
								  NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {

		parameter = parameter.nestedIfOptional();
		// 从请求中读取请求体
		Object arg = readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType());
		
		... 省略数据绑定、参数校验代码

		return adaptArgumentIfNecessary(arg, parameter);
	}

	@Override
	protected <T> Object readWithMessageConverters(NativeWebRequest webRequest, MethodParameter parameter,
												   Type paramType) throws IOException, HttpMediaTypeNotSupportedException, HttpMessageNotReadableException {

		HttpServletRequest servletRequest = webRequest.getNativeRequest(HttpServletRequest.class);
		Assert.state(servletRequest != null, "No HttpServletRequest");
		ServletServerHttpRequest inputMessage = new ServletServerHttpRequest(servletRequest);
		// 调用父类方法从请求中读取请求体
		Object arg = readWithMessageConverters(inputMessage, parameter, paramType);
		if (arg == null && checkRequired(parameter)) {
			throw new HttpMessageNotReadableException("Required request body is missing: " +
					parameter.getExecutable().toGenericString(), inputMessage);
		}
		return arg;
	}
}

RequestResponseBodyMethodProcessor 反序列化请求体时将 HttpServletRequest 转换为 HttpInputMessage，最终调用了父类中的 #readWithMessageConverters 方法，从方法名也可以看出，实现是从 MessageConverter 读取请求体的，这个 MessageConverter 又是什么呢？先留个悬念，稍后再进行分析。

Spring MVC @ResponseBody 返回值处理

Spring MVC 对 Controller 方法返回值处理的设计思路与对方法参数解析的设计思路类似，提出了一个名为 HandlerMethodReturnValueHandler 的接口，所有的 Controller 方法返回值都由这个接口的实现处理，对于 @ResponseBody 标注方法也是如此，接口定义如下。

public interface HandlerMethodReturnValueHandler {

	// 是否支持返回类型
	boolean supportsReturnType(MethodParameter returnType);

	// 处理返回值
	void handleReturnValue(@Nullable Object returnValue, MethodParameter returnType,
						   ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception;

}

默认的 HandlerMethodReturnValueHandler 实现及能够处理的返回值如下图所示。
Spring 将 @RequestBody 和 @ResponseBody 注解的处理合并到一个类，处理 @ResponseBody 返回值同样使用的 RequestResponseBodyMethodProcessor，与序列化 Controller 方法返回值有关的代码如下。

public class RequestResponseBodyMethodProcessor extends AbstractMessageConverterMethodProcessor {

	@Override
	public boolean supportsReturnType(MethodParameter returnType) {
		return (AnnotatedElementUtils.hasAnnotation(returnType.getContainingClass(), ResponseBody.class) ||
				returnType.hasMethodAnnotation(ResponseBody.class));
	}

	@Override
	public void handleReturnValue(@Nullable Object returnValue, MethodParameter returnType,
								  ModelAndViewContainer mavContainer, NativeWebRequest webRequest)
			throws IOException, HttpMediaTypeNotAcceptableException, HttpMessageNotWritableException {

		mavContainer.setRequestHandled(true);
		ServletServerHttpRequest inputMessage = createInputMessage(webRequest);
		ServletServerHttpResponse outputMessage = createOutputMessage(webRequest);

		// 调用父类方法写响应
		writeWithMessageConverters(returnValue, returnType, inputMessage, outputMessage);
	}
}

可以看出，RequestResponseBodyMethodProcessor 不仅支持处理方法上存在 @ResponseBody 的注解，还支持类上存在 @ResponseBody 注解或元注解的方法，这也是为何在类上添加 @RestController 就可以在方法上省略 @ResponseBody 注解的原因。

RequestResponseBodyMethodProcessor 处理返回值时，调用了 #writeWithMessageConverters 方法，根据方法名可知，这个方法使用 MessageConverter 写响应。

Spring MVC HttpMessageConverter

不管是将请求体转换为 Controller 方法参数还是将 Controller 方法返回值转换为响应体，都使用到了 MessageConverter，这个 MessageConverter 实际上是一个名为 HttpMessageConverter 的接口，定义如下。

public interface HttpMessageConverter<T> {

	// 是否能将请求体转换为给定的类对象
	boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);

	// 是否能将给定的类对象转换为响应体
	boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);

	// 获取所有支持的内容类型
	List<MediaType> getSupportedMediaTypes();

	// 将响应体转换为类对象
	T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
			throws IOException, HttpMessageNotReadableException;

	// 将类对象转换为响应体
	void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage)
			throws IOException, HttpMessageNotWritableException;

}

HttpMessageConverter 同时支持请求体转换为类对象，以及将类对象转换为响应体，因此 RequestResponseBodyMethodProcessor 不管处理参数还是返回值都用到了它。

看下 RequestResponseBodyMethodProcessor 如何将请求体转换为 Controller 方法参数的，继续跟踪上面没有分析的 #readWithMessageConverters 方法，核心代码如下。
RequestResponseBodyMethodProcessor 的父类 AbstractMessageConverterMethodArgumentResolver 中维护了一个 HttpMessageConverter 列表，如果其中某个 HttpMessageConverter 支持给定内容类型的请求体转换为类对象，就使用它读取请求体转换为类对象。

RequestResponseBodyMethodProcessor 将 Controller 方法返回值转换为响应体的 #writeWithMessageConverters 方法核心代码如下。

同样循环 HttpMessageConverter 列表，如果列表中的某个 HttpMessageConverter 支持将类对象转换为给定内容类型的响应体，则使用它输出响应。

自定义 HttpMessageConverter

基于注解的 Spring MVC 实现 WebMvcConfigurer 接口即可自定义 HttpMessageConverter。

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    }

    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
    }
}

#configureMessageConverters 方法将会被先调用，如果没有向列表中添加 HttpMessageConverter，Spring MVC 会使用默认的实现，然后调用 #extendMessageConverters 方法再添加 HttpMessageConverter。

所以如果想要覆盖 Spring MVC 中默认的 HttpMessageConverter，可以重写 #configureMessageConverters 方法，如果只是想在默认列表中添加自定义的 HttpMessageConverter 则可以重写 #extendMessageConverters 方法。

假定我们的项目中引入了 fastjson，如果我们想要配置 fastjson 自带的 HttpMessageConverter 处理 application/json 内容类型，可以使用如下的配置。

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
        converter.setSupportedMediaTypes(Collections.singletonList(MediaType.APPLICATION_JSON));
        converters.add(0, converter);
    }
}