使用RequestBodyAdvice、ResponseBodyAdvice优化程序请求与响应

前言

在前后端分离的项目中，前端与后台一般会约定好固定的参数和响应的数据结构，如：

参数：

public class ApiRequest<T> {

    private String token;
    
    private String version;

    /**
     * 业务参数
     */
    private T data;

}

复制代码

响应：

public class ApiResult<T> {

    /**
     * 编码，当code=0时代表成功，其他则为失败"
     */
    private Integer code;

    /**
     * 描述信息
     */
    private String msg;

    /**
     * 成功后返回的数据
     */
    private T data;

    ...

}
复制代码

一般传统的做法是在 Controller层方法直接接收ApiRequest参数和直接返回ApiResult的实例：

• 在参数中传入ApiRequest对象，然后手动获取业务参数data进行处理

• 每个接口手动生成ApiResult对象并返回。

这一部分工作其实是重复也无太多意义的，那么有没有一种方法可以自动做到 我们只关注 ApiRequest.data和 ApiResult.data，让程序自动将参数传入到 业务参数data中和 控制层方法只返回data，程序自动封装成ApiResult并返回呢？那么今天的主人公 RequestBodyAdvice,ResponseBodyAdvice就登场了。

RequestBodyAdvice

RequestBodyAdvice是SpringMVC4.2提供的一个接口，它允许请求体被读取并转换为对象，并将处理结果对象作为@RequestBody参数或者 @HttpEntity方法参数。由此可见，它的作用范围为：

• 使用@RequestBody进行标记的参数
• 参数为HttpEntity

提供的方法

boolean supports(MethodParameter methodParameter, Type targetType,
      Class<? extends HttpMessageConverter<?>> converterType);
复制代码

该方法返回true时，才会进去下面的系列方法

HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter,
      Type targetType, Class<? extends HttpMessageConverter<?>> converterType) throws IOException;
复制代码

body数据读取之前调用，一般在此方法中对body数据进行修改

Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter,
      Type targetType, Class<? extends HttpMessageConverter<?>> converterType);
复制代码

body读取之后操作，一般直接返回原实例

Object handleEmptyBody(@Nullable Object body, HttpInputMessage inputMessage, MethodParameter parameter,
      Type targetType, Class<? extends HttpMessageConverter<?>> converterType);
复制代码

当body问empty时操作

实现步骤

• 编写一个实现类实现RequestBodyAdvice接口
• 分别实现对应的方法
• 实现类上添加注解标记：ControllerAdvice

实例

@ControllerAdvice
public class RequestInterceptor implements RequestBodyAdvice {

    @Override
    public boolean supports(MethodParameter methodParameter, Type type, Class<? extends HttpMessageConverter<?>> aClass) {
        RequestAdvice requestAdvice = methodParameter.getMethodAnnotation(RequestAdvice.class);
        if (requestAdvice == null) {
            requestAdvice = methodParameter.getDeclaringClass().getAnnotation(RequestAdvice.class);
        }
        return requestAdvice != null;
    }

    @Override
    public HttpInputMessage beforeBodyRead(HttpInputMessage httpInputMessage, MethodParameter methodParameter, Type type, Class<? extends HttpMessageConverter<?>> aClass) throws IOException {
        String bodyStr = IOUtils.toString(httpInputMessage.getBody(), StandardCharsets.UTF_8);
        return new HttpInputMessage() {
            @Override
            public InputStream getBody() throws IOException {
                ApiRequest<Object> request = JsonUtils.json2Obj(bodyStr, new TypeReference<ApiRequest<Object>>() {
                });
                String body = bodyStr;
                if (request != null && request.getData() != null) {
                    body = JsonUtils.obj2Json(request.getData());
                }
                return new ByteArrayInputStream(body.getBytes(StandardCharsets.UTF_8));
            }

            @Override
            public HttpHeaders getHeaders() {
                return httpInputMessage.getHeaders();
            }
        };
    }

    @Override
    public Object afterBodyRead(Object body, HttpInputMessage httpInputMessage, MethodParameter methodParameter, Type type, Class<? extends HttpMessageConverter<?>> aClass) {
        return body;
    }

    @Override
    public Object handleEmptyBody(Object body, HttpInputMessage httpInputMessage, MethodParameter methodParameter, Type type, Class<? extends HttpMessageConverter<?>> aClass) {
        return body;
    }
复制代码

上面实例中，supports添加了支持条件：当控制层方法或者类上有标记注解 @RequestAdvice注解时，才会进入其他相关方法。当不需要任何限制时，supports直接返回true即可。

ResponseBodyAdvice

ResponseBodyAdvice是SpringMVC4.1提供的一个接口，它允许在 执行 @ResponseBody后自定义返回数据，或者将返回@ResponseEntity的 Controller Method在写入主体前使用 HttpMessageConverter进行自定义操作。由此可见，它的作用范围为：

• 使用@ResponseBody注解进行标记
• 返回@ResponseEntity

提供的方法

• boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType);
  复制代码

  该方法返回true时，才会进去下面的 beforeBodyWrite方法。该方法可以添加一些判断条件，比如 方法上有 xxx 注解的才会生效等等。

• T beforeBodyWrite(@Nullable T body, MethodParameter returnType, MediaType selectedContentType,
        Class<? extends HttpMessageConverter<?>> selectedConverterType,
        ServerHttpRequest request, ServerHttpResponse response);
  复制代码

  body写入前的操作。

实现步骤

• 编写一个实现类实现ResponseBodyAdvice接口
• 重写supports和boforeBodyWrite
• 实现类上添加注解标记：ControllerAdvice

实例

@ControllerAdvice
public class ResponseInterceptor implements ResponseBodyAdvice {

    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        ResponseAdvice responseAdvice = returnType.getMethodAnnotation(ResponseAdvice.class);
        if (responseAdvice == null) {
            responseAdvice = returnType.getDeclaringClass().getAnnotation(ResponseAdvice.class);
        }
        return responseAdvice != null;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        try {
            ApiResult<Object> result = new ApiResult<>();
            result.setCode(0);
            result.setMsg("success");
            result.setdData(body);
            return result;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return body;
    }
}
复制代码

上面实例中，supports添加了支持条件：当控制层方法或者类上有标记注解 @ResponseAdvice直接时，才会进入beforeBodyWrite方法。当不需要任何限制时，supports直接返回true即可。

其他

上述只是针对 公共参数、公共返回这一种情况对 RequestBodyAdvice、ResponseBodyAdvice进行了说明，当然这两种接口不止这一种应用场景，比如对参数或者返回进行加解密都可以使用这两种接口进行实现。具体使用场景用户可根据实际情况进行使用。