脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring MVC  ResponseBodyAdvice

Spring MVC 接口 ResponseBodyAdvice 及其应用最佳实践记录

 更新时间：2025年04月15日 09:56:37   作者：法天象地 日月同辉  
ResponseBodyAdvice 是 Spring MVC 提供的一个强大接口,允许你在响应体被写入 HTTP 响应之前对其进行全局处理,下面我将全面介绍它的工作原理、使用场景和最佳实践,感兴趣的朋友一起看看吧

ResponseBodyAdvice 是 Spring MVC 提供的一个强大接口，允许你在响应体被写入 HTTP 响应之前对其进行全局处理。

下面我将全面介绍它的工作原理、使用场景和最佳实践。

基本概念

接口定义

public interface ResponseBodyAdvice<T> {
    boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType);
    @Nullable
    T beforeBodyWrite(@Nullable T body, MethodParameter returnType, 
                     MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType,
                     ServerHttpRequest request, ServerHttpResponse response);
}

核心方法

supports()

  • 决定是否对该方法的返回值应用 advice
  • 参数：
    • returnType: 控制器方法的返回类型信息
    • converterType: 将用于序列化响应体的消息转换器类型

beforeBodyWrite()

  • 在消息转换器写入响应体之前对其进行处理
  • 参数：
    • body: 控制器返回的原始响应体
    • 其他参数与 supports() 相同
    • request/response: 当前请求和响应对象

典型应用场景

1. 统一响应封装

最常见的用途是将所有控制器的返回值包装成统一格式：

@RestControllerAdvice
public class UnifiedResponseAdvice implements ResponseBodyAdvice<Object> {
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, 
                                MediaType selectedContentType,
                                Class<? extends HttpMessageConverter<?>> selectedConverterType,
                                ServerHttpRequest request, ServerHttpResponse response) {
        if (body instanceof ApiResponse) {
            return body;
        }
        return ApiResponse.success(body);
    }
}

2. 响应数据脱敏

对敏感数据进行自动处理：

@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, 
                            MediaType selectedContentType,
                            Class<? extends HttpMessageConverter<?>> selectedConverterType,
                            ServerHttpRequest request, ServerHttpResponse response) {
    if (body instanceof UserInfo) {
        UserInfo user = (UserInfo) body;
        user.setIdCard(desensitize(user.getIdCard()));
    }
    return body;
}

3. 响应数据缓存

缓存特定响应：

@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, 
                            MediaType selectedContentType,
                            Class<? extends HttpMessageConverter<?>> selectedConverterType,
                            ServerHttpRequest request, ServerHttpResponse response) {
    if (request.getURI().getPath().contains("/api/cacheable")) {
        cacheManager.put(generateCacheKey(request), body);
    }
    return body;
}

高级用法与最佳实践

1. 精确控制应用范围

通过 supports() 方法精确控制哪些方法需要处理：

@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
    // 只处理标注了@ResponseWrap注解的方法
    return returnType.hasMethodAnnotation(ResponseWrap.class);
    // 或者排除特定包下的控制器
    // return !returnType.getDeclaringClass().getPackage().getName().startsWith("org.springdoc");
}

2. 处理特殊情况 处理String类型返回值

@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, 
                            MediaType selectedContentType,
                            Class<? extends HttpMessageConverter<?>> selectedConverterType,
                            ServerHttpRequest request, ServerHttpResponse response) {
    if (body instanceof String) {
        response.getHeaders().setContentType(MediaType.APPLICATION_JSON);
        return objectMapper.writeValueAsString(ApiResponse.success(body));
    }
    // 其他处理...
}

处理文件下载等非JSON响应

@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
    // 排除文件下载等场景
    return !ResourceHttpMessageConverter.class.isAssignableFrom(converterType);
}

3. 性能优化

@RestControllerAdvice
public class CustomResponseAdvice implements ResponseBodyAdvice<Object> {
    // 重用ObjectMapper实例
    private static final ObjectMapper objectMapper = new ObjectMapper();
    // 预定义的成功响应
    private static final ApiResponse<?> EMPTY_SUCCESS = ApiResponse.success(null);
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, 
                                MediaType selectedContentType,
                                Class<? extends HttpMessageConverter<?>> selectedConverterType,
                                ServerHttpRequest request, ServerHttpResponse response) {
        if (body == null) {
            return EMPTY_SUCCESS;
        }
        // 其他处理...
    }
}

常见问题解决方案

1. 与Swagger的兼容性问题

@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
    // 排除Swagger相关的控制器
    return !returnType.getDeclaringClass().getPackage().getName().startsWith("springfox.documentation");
}

2. 循环引用问题

当包装的对象存在循环引用时，需要在ObjectMapper中配置：

objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
objectMapper.configure(SerializationFeature.FAIL_ON_SELF_REFERENCES, false);

3. 异常处理

虽然ResponseBodyAdvice不处理异常，但可以与@ExceptionHandler配合使用：

@ExceptionHandler(Exception.class)
public ApiResponse<?> handleException(Exception e) {
    return ApiResponse.failure(e.getMessage());
}

完整示例

@RestControllerAdvice
public class GlobalResponseAdvice implements ResponseBodyAdvice<Object> {
    private final ObjectMapper objectMapper;
    public GlobalResponseAdvice(ObjectMapper objectMapper) {
        this.objectMapper = objectMapper;
    }
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        // 排除Swagger和Actuator端点
        return !(returnType.getDeclaringClass().getName().contains("springfox") || 
                returnType.getDeclaringClass().getName().contains("org.springframework.boot.actuate"));
    }
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, 
                                MediaType selectedContentType,
                                Class<? extends HttpMessageConverter<?>> selectedConverterType,
                                ServerHttpRequest request, ServerHttpResponse response) {
        // 非JSON响应不处理
        if (!selectedContentType.includes(MediaType.APPLICATION_JSON)) {
            return body;
        }
        // 已经是包装类型不处理
        if (body instanceof ApiResponse) {
            return body;
        }
        // 处理String类型返回值
        if (body instanceof String) {
            try {
                response.getHeaders().setContentType(MediaType.APPLICATION_JSON);
                return objectMapper.writeValueAsString(ApiResponse.success(body));
            } catch (JsonProcessingException e) {
                throw new RuntimeException("JSON序列化失败", e);
            }
        }
        // 空值处理
        if (body == null) {
            return ApiResponse.success();
        }
        // 默认包装
        return ApiResponse.success(body);
    }
    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    public static class ApiResponse<T> {
        private int code;
        private String message;
        private T data;
        private long timestamp = System.currentTimeMillis();
        public static <T> ApiResponse<T> success() {
            return new ApiResponse<>(200, "success", null);
        }
        public static <T> ApiResponse<T> success(T data) {
            return new ApiResponse<>(200, "success", data);
        }
    }
}

通过合理使用ResponseBodyAdvice，你可以实现响应处理的集中管理，使代码更加整洁和一致。

到此这篇关于Spring MVC 接口 ResponseBodyAdvice 及其应用最佳实践记录的文章就介绍到这了,更多相关Spring MVC ResponseBodyAdvice 内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Java如何配置IDEA自定义注释

    Java如何配置IDEA自定义注释

    在IDEA中设置自动创建类和方法的注释可以提高编码效率,确保代码的一致性和可读性,首先,对于创建类的注释,可以通过修改File→Settings→File and Code Templates→Class的模板来实现,其次,对于方法注释
    2024-10-10
  • 巧妙mybatis避免Where 空条件的尴尬

    巧妙mybatis避免Where 空条件的尴尬

    这篇文章主要介绍了巧妙mybatis避免Where 空条件的尴尬，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2020-11-11
  • 使用JavaMail发送邮件保证成功的方法

    使用JavaMail发送邮件保证成功的方法

    JavaMail是利用现有的邮件账户发送邮件的工具，使用过JavaMail的api发送邮件的人可能会有这样一个疑惑：我如何知道我调用该api发送的邮件是否成功呢？那么通过下面这篇文章大家一起来看看使用JavaMail保证邮件发送成功的方法，有需要的朋友们可以参考借鉴。
    2016-11-11
  • Java中的HashMap内存泄漏问题详解

    Java中的HashMap内存泄漏问题详解

    这篇文章主要介绍了Java中的HashMap内存泄漏问题详解,WeakHashMap中的key是弱引用,如果再使用之后没有及时remove掉这个key,那么当GC时key就可能会被回收,导致key对应的value对象占用的内存无法回收进而导致内存泄漏,需要的朋友可以参考下
    2023-09-09
  • mybatis中resulthandler的用法

    mybatis中resulthandler的用法

    这篇文章主要介绍了mybatis中resulthandler的用法，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2022-01-01
  • 基于Java编写简易的算式测试程序

    基于Java编写简易的算式测试程序

    本文将利用Java语言编写一个简易的算式测试程序，这个程序可以自动生成指定数量的加减乘三则运算题目，感兴趣的小伙伴可以了解一下
    2022-05-05
  • 解决idea中yml文件图标问题及自动提示失效的情况

    解决idea中yml文件图标问题及自动提示失效的情况

    这篇文章主要介绍了解决idea中yml文件图标问题及自动提示失效的情况，具有很好的价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2021-01-01
  • MyBatis-Plus内置接口方法的具体使用

    MyBatis-Plus内置接口方法的具体使用

    java开发应用程序与数据库交互使用比较多的就是mybatisPlus接口,本文主要介绍了MyBatis-Plus内置接口方法的具体使用,具有一定的参考价值,感兴趣的可以了解一下
    2023-12-12
  • 解决因jdk版本引起的TypeNotPresentExceptionProxy异常

    解决因jdk版本引起的TypeNotPresentExceptionProxy异常

    这篇文章介绍了解决因jdk版本引起的TypeNotPresentExceptionProxy异常的方法，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2021-12-12
  • SpringCache缓存处理详解

    SpringCache缓存处理详解

    这篇文章主要介绍了SpringCache缓存处理详解,SpringCache是一个框架,实现了基于注解缓存功能,只需要简单地加一个注解,就能实现缓存功能,需要的朋友可以参考下
    2023-09-09

最新评论