柯基笔记：全局异常处理

• 作者：柯基大佬
• 日期：2021-10-20
• 类型：Java
• 说明：本文源于 柯基 手写摘要，如需转载请带上链接或注明出处！

全局异常处理

注：使用Mybatis自带的异常处理

简单异常处理

用到的注解：

• @ControllerAdvice Spring3.2提供的新注解，Controller增强器

可对controller层中被 @RequestMapping 注解了的方法增加逻辑处理

常用于 统一异常处理、全局数据绑定、全局数据预处理

• @ExceptionHandler 标记异常处理，可指定具体异常类型class
• @ResponseBody 指定异常返回
• @Slf4j 控制台log打印

其中，ControllerAdvice和Slf4j作用于类，ExceptionHandler和ResponseBody作用于方法，
在多个异常方法重载时，会根据具体发生的Exception进不同的方法

以下是全局异常统一处理的使用样例：

1. 定义全局异常处理类

   @Slf4j // log
   @ControllerAdvice
   public class GlobalException {
   
       @ResponseBody // 返回异常
       @ExceptionHandler(Exception.class)
       public BaseBean<String> exception(Exception e) {
           log.error("全局异常：" + e);
           return BaseBean.failed("全局异常：" + e.getMessage());
       }
   
       @ResponseBody
       @ExceptionHandler(NullPointerException.class)
       public BaseBean<String> exception(NullPointerException e) {
           log.error("全局空指针异常：" + e);
           return BaseBean.failed("全局空指针异常：" + e.getMessage());
       }
   }

2. 当程序发生异常

   throw new NullPointerException("测试空指针异常");

3. 被捕获后返回json

   {
       "data": null,
       "code": 110,
       "msg": "全局空指针异常：测试空指针异常",
       "success": false
   }

自定义异常处理

使用枚举类自定义常用响应码（code, msg）

将定义的code替换掉项目里原有的硬编码code

public enum ResponseCode {

    SUCCESS(200, "操作成功!"),
    FAILED(201, "请求失败!"),
    FAILED_OPERATION(202, "操作失败!"),
    FAILED_ADD(555, "新增失败!"),
    FAILED_UPDATE(556, "修改失败!"),
    FAILED_DELETE(557, "删除失败!"),
    NO_DATA(10000, "暂无数据!"),
    LOGOUT(10010, "用户已注销!"),
    PERMISSION_ERROR(10110, "用户无操作权限!"),
    PARAMETER_ERROR(10755, "参数错误!"),
    TOKEN_ERROR(10444, "Token校验失败!"),
    TOKEN_EXPIRE(10555, "Token过期已失效!"),
    TOKEN_EMPTY(10777, "Token为空!"),
    SQL_ERROR(10500, "数据查询错误!"),
    NET_ERROR(10999, "网络异常错误!"),
    UNKNOWN_ERROR(11111, "发生未知错误!"),
    UNLAWFUL_REQUEST(10101, "非法请求!");

    /**
     * 错误码
     */
    private final int code;

    /**
     * 错误描述
     */
    private final String message;

    ResponseCode(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}