SpringBoot统一返回值及异常包装

男娘i 2022-10-24 05:58 175阅读 0赞

# 欢迎使用Markdown编辑器写博客 #

在项目开发过程中，我们希望所有接口返回值都包含四个元素。  
a、code：请求接口的返回码，成功或者异常等返回编码，例如定义请求成功，code = “0000”，code = “1111”;

b、message：请求接口的描述，也就是对返回编码的描述，“0000”：表示请求结果为成功，“1111”：表示请求结果为失败，可以根据业务返回异常信息；

c、success：true表示接口请求成功，false表示接口请求失败。

d、data：请求接口成功，返回的结果。

*  **自定义返回模型**

/** * @Author: LailaiMonkey * @Description： * @Date：Created in 2020-09-28 15:58 * @Modified By： */
    public class WebAPIResponse<T> { 
    
        /** * 是否成功 */
        private boolean success;
    
        /** * code码 */
        private int code;
    
        /** * 消息内容 */
        private String message;
    
        /** * 数据 */
        private T data;
    
        public WebAPIResponse(boolean success, int code, String message, T data) { 
            this.success = success;
            this.code = code;
            this.message = message;
            this.data = data;
        }
    
        public WebAPIResponse(T data) { 
            this.success = true;
            this.code = 0;
            this.message = "success";
            this.data = data;
        }
    
        public WebAPIResponse(int code, String message) { 
            this.success = true;
            this.code = code;
            this.message = message;
        }
    
        public static <T> WebAPIResponse<T> success(T data) { 
            return new WebAPIResponse<>(data);
        }
    
        static <T> WebAPIResponse<T> fail(int code, T data) { 
            return new WebAPIResponse<>(false, code, "未知错误异常", data);
        }
    
        static <T> WebAPIResponse<T> fail(int code, String message, T data) { 
            return new WebAPIResponse<>(false, code, message, data);
        }
    
        public boolean isSuccess() { 
            return success;
        }
    
        public void setSuccess(boolean success) { 
            this.success = success;
        }
    
        public int getCode() { 
            return code;
        }
    
        public void setCode(int code) { 
            this.code = code;
        }
    
        public String getMessage() { 
            return message;
        }
    
        public void setMessage(String message) { 
            this.message = message;
        }
    
        public T getData() { 
            return data;
        }
    
        public void setData(T data) { 
            this.data = data;
        }
    }

*  **统一返回值和异常拦截**

/** * @Author: 侯旭日 * @Description： * @Date：Created in 2020-09-28 16:20 * @Modified By： */
    @RestControllerAdvice
    public class WebResponseException extends WebAbstractResponseAdapter { 
    
        private static final Logger logger = LoggerFactory.getLogger(WebResponseException.class);
    
    	//所有异常进行包装
        @ExceptionHandler(value = Throwable.class)
        public Object exceptionHandler(Exception e) { 
            if (e instanceof BusinessExceptionImpl) { 
                BusinessExceptionImpl exception = (BusinessExceptionImpl) e;
                return WebAPIResponse.fail(exception.getCode(), exception.getMessage(), null);
            }
            return WebAPIResponse.fail(0000, null);
        }
    
    }

*  **返回值信息处理**

/** * @Author: LailaiMonkey * @Description： * @Date：Created in 2020-10-12 15:28 * @Modified By： */
    abstract public class WebAbstractResponseAdapter implements ResponseBodyAdvice<Object> { 
    
        @Override
        public boolean supports(MethodParameter methodParameter,
                                Class<? extends HttpMessageConverter<?>> converterType) { 
            //过滤String类型，String单独序列化方式
            return AbstractJackson2HttpMessageConverter.class.isAssignableFrom(converterType);
        }
    
        @Override
        public Object beforeBodyWrite(Object o,
                                      MethodParameter methodParameter,
                                      MediaType mediaType,
                                      Class<? extends HttpMessageConverter<?>> aClass,
                                      ServerHttpRequest serverHttpRequest,
                                      ServerHttpResponse serverHttpResponse) { 
    
            //包装后直接返回
            if (o instanceof WebAPIResponse) { 
                return o;
            }
            return WebAPIResponse.success(o);
        }
    }

我们可以向任意一个Controller发起请求，返回值都会按我们规定样式进行包装。