2022-06-07 responsebodyadvice caused the spring frame problem in swagger

Problems arise

Due to the unified processing of global response ResponseBodyAdvice cause swagger “/swagger-resources/configuration/ui”、“/swagger-resources/configuration/security”、"/swagger-resources" request , from json The format becomes a custom response body, which makes it impossible to display .

terms of settlement

Add basePackages Limit ：

/** *  Global unified return processing  * * @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) {
    
        //  return  true execute  beforeBodyWrite Method ,
        //  Return type is not  ResponseResult, And there's no  @NotResponseBody annotation , Will execute 
        return !returnType.getParameterType().equals(ResponseResult.class) && !returnType.hasMethodAnnotation(NotResponseBody.class);
    }


    /** *  Process the returned information , Save the access log and return code and msg */
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
    
        //  if  String type , Then return directly  json character string 
        if (returnType.getGenericParameterType().equals(String.class)) {
    
            SystemLogContextHolder.get().setRespCode(2000).setRespMsg("");
            return JsonUtil.obj2Str(body);
        }
        return ResponseResult.success(body);
    }
}

Reference article ： Project implementation ResponseBodyAdvice Lead to swagger abnormal