探究微服务架构中ResponseBodyAdvice失效的真相

2023-10-30 00:18:25

微服务架构中 ResponseBodyAdvice 失效的问题及其解决方法

在微服务架构中，将基础功能抽取到公共 Jar 包已成为一种普遍做法，以促进服务的解耦和复用。然而，这样做时，我们可能会遇到一些问题，其中之一便是 ResponseBodyAdvice 的失效。本文将深入探讨这个问题，并提供有效的解决方法。

什么是 ResponseBodyAdvice？

ResponseBodyAdvice 是 SpringMVC 中的一个接口，它允许我们在控制器方法执行前后修改响应体。我们通常使用 ResponseBodyAdvice 来实现统一的异常处理。例如，当控制器方法抛出异常时，我们可以使用 ResponseBodyAdvice 将异常信息转换为 JSON 格式，并返回给客户端。

ResponseBodyAdvice 失效的原因

当将基础功能抽取到公共 Jar 包中时，可能会出现 ResponseBodyAdvice 失效的问题。这是因为当控制器方法抛出异常时，ResponseBodyAdvice 不会执行，导致异常信息无法正确处理。

调试过程

为了探究 ResponseBodyAdvice 失效的原因，我们可以一步步进行调试：

检查 ResponseBodyAdvice 是否已正确注册。 ResponseBodyAdvice 可以通过 @ControllerAdvice 注解进行注册。
确保 ResponseBodyAdvice 已被 SpringMVC 扫描到。 ResponseBodyAdvice 必须位于 SpringMVC 扫描路径范围内。
确保 ResponseBodyAdvice 的优先级高于其他 ResponseBodyAdvice。 ResponseBodyAdvice 的优先级可以通过 @Order 注解进行设置。

解决方法

如果 ResponseBodyAdvice 没有正确注册，我们可以通过以下方法来解决这个问题：

确保 ResponseBodyAdvice 已正确标注了 @ControllerAdvice 注解。
确保 ResponseBodyAdvice 已被 SpringMVC 扫描到。
确保 ResponseBodyAdvice 的优先级高于其他 ResponseBodyAdvice。

示例代码

以下是一个 ResponseBodyAdvice 的示例，它会在控制器方法抛出异常时，将异常信息转换为 JSON 格式：

@ControllerAdvice
public class GlobalResponseBodyAdvice 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 Exception) {
            return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR, Collections.singletonMap("errorMessage", body.toString()));
        }
        return body;
    }
}