springboot项目用ResponseBodyAdvice统一包装返回体-笔记

最新推荐文章于 2026-04-14 15:45:34 发布

原创

最新推荐文章于 2026-04-14 15:45:34 发布 · 1.9k 阅读

标签

#spring boot #笔记 #java

文章介绍了如何在SpringBoot项目中利用ResponseBodyAdvice接口来统一包装RESTAPI的返回数据，这样可以简化后端工作，方便数据结构的变更。通过定义一个实现了ResponseBodyAdvice接口的类，并在Controller中应用，可以自动对所有返回体进行增强处理，确保返回的数据结构一致，同时也便于处理异常和日志记录。

springboot项目用ResponseBodyAdvice统一包装返回体-笔记

在使用springboot开发rest api接口时,往往需要和前端对接定义返回的数据结构，这时使用ResponseBodyAdvice统一包装返回体给前端，可以大大减轻后端的工作量，同时也方便对返回体的数据结构做灵活变更。
使用ResponseBodyAdvice封装好统一的返回体后，Controller中就可以专心处理业务模型和业务数据了。

定义1个ResponseBodyAdvice接口的实现类

/**
 * 实现 ResponseBodyAdvice接口，并重写其中的方法，即可对我们的controller进行增强操作
 *
 * 不管Controller中 是否使用ResultVO<T>对返回结果包装，
 * 均可被 ResponseBodyAdvice接口 处理返回数据，以使系统 统一结果，统一异常，统一日志
 */
// 注意哦，这里要加上需要扫描的包
@RestControllerAdvice(basePackages = {
   
   "cn.ath.knowwikibackend.rest"})
public class SysRestBodyAdvice implements ResponseBodyAdvice<Object> {
   
   
    /**
     * Whether this component supports the given controller method return type
     * and the selected {@code HttpMessageConverter} type.
     *
     * supports方法要返回为true才会执行beforeBodyWrite方法，
     * 所以如果有些情况不需要进行增强操作可以在supports方法里进行判断
     *
     * @param returnType    the return type
     * @param converterType the selected converter type
     * @return {@code true} if {@link #beforeBodyWrite} should be invoked;
     * {@code false} otherwise
     */
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
   
   
        // 如果接口返回的类型本身就是ResultVO那就没有必要进行额外的操作，返回false
        return !returnType.getGenericParameterType().equals(ResultVO.class);
    }

    /**
     * Invoked after an {@code HttpMessageConverter} is selected and just before
     * its write method is invoked.
     *
     * 对返回数据进行真正的操作还是在beforeBodyWrite方法中，
     * 我们可以直接在该方法里包装数据，这样就不需要每个接口都进行数据包装了，省去了很多麻烦
     *
     * @param body                  the body to be written
     * @param returnType            the return type of the controller method
     * @param selectedContentType   the content type selected through content negotiation
     * @param selectedConverterType the converter type selected to write to the response
     * @param request               the current request
     * @param response              the current response
     * @return the body that was passed in or a modified (possibly new) instance
     */
    @SneakyThrows
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
   
   

        // String类型不能直接包装，所以要进行些特别的处理
        if (returnType.getGenericParameterType().equals(String.class)) {
   
   
            ObjectMapper