Spring MVC统一异常处理通用做法

女爷i 2021-07-25 00:43 389阅读 0赞

# 一 自定义统一异常处理 #

package com.atguigu.gulimall.product.exception;
    
    import com.atguigu.common.exception.BizCodeEnume;
    import com.atguigu.common.utils.R;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.validation.BindingResult;
    import org.springframework.web.bind.MethodArgumentNotValidException;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.RestControllerAdvice;
    
    import java.util.HashMap;
    import java.util.Map;
    
    /**
    * @className: GulimallExceptionControllerAdvice
    * @description: 集中处理所有异常
    * @date: 2020/10/31
    * @author: cakin
    */
    @Slf4j
    //@ResponseBody
    //@ControllerAdvice(basePackages = "com.atguigu.gulimall.product.controller")
    // 处理 com.atguigu.gulimall.product.controller 这个控制器包的异常
    // @RestControllerAdvice 是 @ResponseBody 和 @ControllerAdvice 的合体
    @RestControllerAdvice(basePackages = "com.atguigu.gulimall.product.controller")
    public class GulimallExceptionControllerAdvice {
        /**
         * 功能描述：处理数据校验的异常
         *
         * @param e 异常
         * @return R 返回给前端的数据
         * @author cakin
         * @date 2020/10/31
         */
        @ExceptionHandler(value = MethodArgumentNotValidException.class)
        public R handleVaildException(MethodArgumentNotValidException e) {
            log.error("数据校验出现问题{}，异常类型：{}", e.getMessage(), e.getClass());
            BindingResult bindingResult = e.getBindingResult();
            Map<String, String> errorMap = new HashMap<>();
            bindingResult.getFieldErrors().forEach((fieldError) -> {
                errorMap.put(fieldError.getField(), fieldError.getDefaultMessage());
            });
            return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(), BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data", errorMap);
        }
    
        /**
         * 功能描述：其他未知异常
         *
         * @param throwable 异常
         * @return R 返回给前端的数据
         * @author cakin
         * @date 2020/10/31
         */
        @ExceptionHandler(value = Throwable.class)
        public R handleException(Throwable throwable) {
            log.error("错误：", throwable);
            return R.error(BizCodeEnume.UNKNOW_EXCEPTION.getCode(), BizCodeEnume.UNKNOW_EXCEPTION.getMsg());
        }
    }

# 二 异常枚举 #

package com.atguigu.common.exception;
    
    /**
     * @className: BizCodeEnume
     * @description: 关于异常的枚举
     * 错误码和错误信息定义类
     * 1. 错误码定义规则为5为数字
     * 2. 前两位表示业务场景，最后三位表示错误码。例如：100001。10:通用 001:系统未知异常
     * 3. 维护错误码后需要维护错误描述，将他们定义为枚举形式
     * 错误码列表：
     * 10: 通用
     * 001：参数格式校验
     * 11: 商品
     * 12: 订单
     * 13: 购物车
     * 14: 物流
     * @date: 2020/10/31
     * @author: cakin
     */
    public enum BizCodeEnume {
        UNKNOW_EXCEPTION(10000, "系统未知异常"),
        VAILD_EXCEPTION(10001, "参数格式校验失败");
    
        private int code;
        private String msg;
    
        BizCodeEnume(int code, String msg) {
            this.code = code;
            this.msg = msg;
        }
    
        public int getCode() {
            return code;
        }
    
        public String getMsg() {
            return msg;
        }
    }