Java自学者论坛

 找回密码
 立即注册

手机号码,快捷登录

恭喜Java自学者论坛(https://www.javazxz.com)已经为数万Java学习者服务超过8年了!积累会员资料超过10000G+
成为本站VIP会员,下载本站10000G+会员资源,会员资料板块,购买链接:点击进入购买VIP会员

JAVA高级面试进阶训练营视频教程

Java架构师系统进阶VIP课程

分布式高可用全栈开发微服务教程Go语言视频零基础入门到精通Java架构师3期(课件+源码)
Java开发全终端实战租房项目视频教程SpringBoot2.X入门到高级使用教程大数据培训第六期全套视频教程深度学习(CNN RNN GAN)算法原理Java亿级流量电商系统视频教程
互联网架构师视频教程年薪50万Spark2.0从入门到精通年薪50万!人工智能学习路线教程年薪50万大数据入门到精通学习路线年薪50万机器学习入门到精通教程
仿小米商城类app和小程序视频教程深度学习数据分析基础到实战最新黑马javaEE2.1就业课程从 0到JVM实战高手教程MySQL入门到精通教程
查看: 351|回复: 0

springboot接口返回封装与异常控制

[复制链接]
  • TA的每日心情
    奋斗
    2024-11-24 15:47
  • 签到天数: 804 天

    [LV.10]以坛为家III

    2053

    主题

    2111

    帖子

    72万

    积分

    管理员

    Rank: 9Rank: 9Rank: 9

    积分
    726782
    发表于 2021-4-30 10:51:15 | 显示全部楼层 |阅读模式

     

    首先,返回有两个状态,status和code

    status标识response的状态,有2个值:0成功,-1服务错误。

    code跟业务有关,可以有各种数值,99999服务未知异常,10000参数异常,100001创建订单失败等等。这两个状态用枚举类表示。

    ResponseStatus

    /**
     * @Author: ivan
     * @Description: 服务状态代码
     * @Date: 18/11/26
     * @Modified By;
     */
    public enum ResponseStatus {
    
        OK(0, "成功"),
        ERROR(-1, "服务错误");
    
        private int value;
        private String message;
    
        ResponseStatus(int value, String message){
            this.value = value;
            this.message = message;
        }
    
        public int getValue() {
            return value;
        }
    
        public String getMessage() {
            return message;
        }
    
    }

     

     

    ResponseCode

    /**
     * @Author: ivan
     * @Description: 业务状态代码
     * @Date: 18/11/26
     * @Modified By;
     */
    public enum ResponseCode {
    
        FORMAL(0, "业务正常"),
        INVALID_PARAM(100000, "参数错误"),
        UNKNOWN_FAILED(999999, "服务器未知错误"),
        SAVE_FAILED(888888, "保存失败"),
        UPDATE_FAILED(777777, "保存失败"),
        DELTE_FAILED(666666, "删除失败"),
        SEARCH_FLOW_FAILED(555555, "查询任务流的执行详情失败!");
    
        private int value;
        private String message;
    
        ResponseCode(int value, String message){
            this.value = value;
            this.message = message;
        }
    
        public int getValue() {
            return value;
        }
    
        public String getMessage() {
            return message;
        }
    
    }

     

    然后,是Response类,简单工厂模式,提供build方法,创建正常返回和错误返回Response。

    Response

    /**
     * @Author: ivan
     * @Description: 返回值封装
     * @Date: Created in 17:26 18/11/26
     * @Modified By:
     */
    public class Response<T> implements Serializable {
    
        private int status;
    
        private int code;
    
        private String message;
    
        private Object data;
    
        public Response(ResponseStatus status, ResponseCode code, String message, T data) {
            this.setStatus(status);
            this.setCode(code);
            this.setMessage(message);
            this.setData(data);
        }
    
        public static <T> Response<T> buildSuccessResponse(T data) {
            return new Response<T>(ResponseStatus.OK, ResponseCode.FORMAL, null, data);
        }
    
        public static <T> Response<T> buildFailResponse(ResponseStatus responseStatus, ResponseCode responseCode,
                                                      String message, T data) {
            return new Response<T>(responseStatus, responseCode, message, data);
        }
    
    
        public int getStatus() {
            return status;
        }
    
        public void setStatus(ResponseStatus status) {
            this.status = status.getValue();
        }
    
        public int getCode() {
            return code;
        }
    
        public void setCode(ResponseCode code) {
            this.code = code.getValue();
        }
    
        public String getMessage() {
            return message;
        }
        public void setMessage(String message) {
            this.message = message;
        }
    
        public Object getData() {
            return data;
        }
    
        public void setData(Object data) {
            this.data = data;
        }
    }

     

    如果不想在controller里try-catch一般的异常,并且在一定的条件下通过throw控制代码逻辑,我们需要建立ControllerAdvice。

    我这个advice会捕捉ApiException(自定义),一般用业务Code码里的错误码和信息,这时候我们可以返回提示性异常。然后就是Exception普通异常,一般提示服务器未知错误。

    我这里还处理了一个参数校验异常

    /**
     * @Author: ivan
     * @Description: 全局异常处理advice
     * @Date: Created in 20:21 18/11/26
     * @Modified By:
     */
    @ControllerAdvice
    public class GlobalExceptionHandler {
    
        private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
    
        /**
        *   处理全局异常handler, ApiException为业务异常, 其他为服务器未知异常
        */
        @ExceptionHandler(Exception.class)
        @ResponseBody
        public Response<String> handle(Exception e) {
    
            Response<String> response;
    
            if (e instanceof ApiException) {
                ApiException error = (ApiException) e;
                response = Response.buildFailResponse(ResponseStatus.ERROR, error.getResponseCode(),
                        error.getResponseCode().getMessage(), null);
            } else {
                response = Response.buildFailResponse(ResponseStatus.ERROR, ResponseCode.UNKNOWN_FAILED,
                        ResponseCode.UNKNOWN_FAILED.getMessage(), null);
            }
    
            logger.error("[Exception] message={}", e);
    
            return response;
        }
    
    
        /**
         *  处理参数校验异常handler
         */
        @ExceptionHandler(ValidationException.class)
        @ResponseBody
        public Response<String> handle(ValidationException e) {
    
            StringBuilder sb = new StringBuilder();
    
            if(e instanceof ConstraintViolationException){
    
                ConstraintViolationException error = (ConstraintViolationException) e;
                Set<ConstraintViolation<?>> violations = error.getConstraintViolations();
    
                for (ConstraintViolation<?> item : violations) {
                    sb.append(item.getMessage());
                }
    
            }
    
            logger.error("[Validation] message={}", sb.toString(), e);
    
            return Response.buildFailResponse(ResponseStatus.ERROR, ResponseCode.INVALID_PARAM, sb.toString(), null);
    
        }
    
    }

     

    哎...今天够累的,签到来了1...
    回复

    使用道具 举报

    您需要登录后才可以回帖 登录 | 立即注册

    本版积分规则

    QQ|手机版|小黑屋|Java自学者论坛 ( 声明:本站文章及资料整理自互联网,用于Java自学者交流学习使用,对资料版权不负任何法律责任,若有侵权请及时联系客服屏蔽删除 )

    GMT+8, 2025-2-4 08:42 , Processed in 0.061476 second(s), 29 queries .

    Powered by Discuz! X3.4

    Copyright © 2001-2021, Tencent Cloud.

    快速回复 返回顶部 返回列表