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

…

}

复制代码

一般传统的做法是在 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 request = JsonUtils.json2Obj(bodyStr, new TypeReference<ApiRequest>() {

});

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 {

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

总结

无论是哪家公司，都很重视高并发高可用的技术，重视基础，重视JVM。面试是一个双向选择的过程，不要抱着畏惧的心态去面试，不利于自己的发挥。同时看中的应该不止薪资，还要看你是不是真的喜欢这家公司，是不是能真的得到锻炼。其实我写了这么多，只是我自己的总结，并不一定适用于所有人，相信经过一些面试，大家都会有这些感触。

最后我整理了一些面试真题资料，技术知识点剖析教程，还有和广大同仁一起交流学习共同进步，还有一些职业经验的分享。

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
惧的心态去面试，不利于自己的发挥。同时看中的应该不止薪资，还要看你是不是真的喜欢这家公司，是不是能真的得到锻炼。其实我写了这么多，只是我自己的总结，并不一定适用于所有人，相信经过一些面试，大家都会有这些感触。

最后我整理了一些面试真题资料，技术知识点剖析教程，还有和广大同仁一起交流学习共同进步，还有一些职业经验的分享。

[外链图片转存中…(img-YHTlnGDp-1713524492404)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！