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

最新推荐文章于 2025-09-23 15:39:20 发布

原创最新推荐文章于 2025-09-23 15:39:20 发布 · 479 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#java #前端 #javascript

程序员专栏收录该内容

242 篇文章

订阅专栏

本文介绍SpringMVC4.2中的RequestBodyAdvice接口，用于自动处理请求体数据，将参数转换为ApiRequest对象并传递给业务逻辑，同时概述了ResponseBodyAdvice的功能。作者提供了一个实例，展示了如何使用这两个接口来简化API接口的开发过程。

复制代码

一般传统的做法是在 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

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

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

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