2022-06-07 ResponseBodyAdvice导致Swagger出现弹框问题

出现问题

由于全局响应统一处理实现ResponseBodyAdvice造成swagger “/swagger-resources/configuration/ui”、“/swagger-resources/configuration/security”、"/swagger-resources"请求，由json格式变成自定义响应体导致无法显示。

解决办法

对全局响应统一处理添加basePackages限制：

/** * 全局统一返回处理 * * @Author zsl * @Date 2022/5/15 19:10 * @Email [email protected] */
@ControllerAdvice(basePackages = "com.zsl.custombox.authentication.controller")
@Order(Integer.MAX_VALUE - 20)
public class GlobalResponseResultAdvice implements ResponseBodyAdvice<Object> {
    
    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
    
        // 返回 true则执行 beforeBodyWrite方法,
        // 返回类型不是 ResponseResult，且没有 @NotResponseBody注解，会执行
        return !returnType.getParameterType().equals(ResponseResult.class) && !returnType.hasMethodAnnotation(NotResponseBody.class);
    }


    /** * 处理返回信息，并保存访问日志返回code和msg */
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
    
        // 若为 String类型，则直接返回 json字符串
        if (returnType.getGenericParameterType().equals(String.class)) {
    
            SystemLogContextHolder.get().setRespCode(2000).setRespMsg("");
            return JsonUtil.obj2Str(body);
        }
        return ResponseResult.success(body);
    }
}

参考文章：项目实现ResponseBodyAdvice导致swagger异常