springboot异常

SpringBoot全局异常处理设置（返回JSON）

• 控制全局的异常处理。
• 后端代码出现异常时直接返回json格式的状态码及消息给前端
• @ControllerAdvice、@ExceptionHandler

注解说明

• @ControllerAdvice
  一个增强的 Controller，需要配合@ExceptionHandler使用；当将异常抛到controller时,可以对异常进行统一处理,规定返回的json格式或是跳转到一个错误页面
• @ExceptionHandler
  springboot中的异常处理器注解，统一处理某一类异常

返回类及全局状态码

• 返回类

@Data
public class Result<T> {

    private Integer code;
    private String msg;
    private T data;

    public Result(T data) {
        this.msg = "success";
        this.data = data;
    }

    public Result(CodeMsg cm) {
        if (cm == null) {
            return;
        }
        this.code = cm.getCode();
        this.msg = cm.getMsg();
    }

    /**
     * 成功调用
     *
     * @return
     */
    public static <T> Result<T> success(T data) {
        return new Result<T>(data);
    }

    /**
     * 失败调用
     *
     * @return
     */
    public static <T> Result error(CodeMsg codeMsg) {
        return new Result<T>(codeMsg);
    }
}

• 全局状态码

@Data
@ToString
public class CodeMsg {

    private Integer code;
    private String msg;

    /**
     * 成功标识
     */
    public static CodeMsg SUCCESS = new CodeMsg(0, "success");
    /**
     * 失败标识
     */
    public static CodeMsg ERROR = new CodeMsg(500, "服务端异常！");

    //参数校验异常处理
    public static CodeMsg BIND_ERROR = new CodeMsg(500101, "参数校验异常：%s");

    /*=======================登陆失败状态开始======================*/
    public static CodeMsg SESSION_ERROR = new CodeMsg(500210, "Session不存在或者已经失效");
    public static CodeMsg PASSWORD_EMPTY = new CodeMsg(500211, "登录密码不能为空");
    public static CodeMsg MOBILE_EMPTY = new CodeMsg(500212, "手机号不能为空");
    public static CodeMsg MOBILE_ERROR = new CodeMsg(500213, "手机号格式错误");
    public static CodeMsg MOBILE_NOT_EXIST = new CodeMsg(500214, "手机号不存在");
    public static CodeMsg PASSWORD_ERROR = new CodeMsg(500215, "密码错误");
    /*=======================登陆失败状态结束======================*/

    /**
     * 参数校验异常处理
     * @param args
     * @return
     */
    public CodeMsg fillArgs(Object... args) {
        int code = this.code;
        String message = String.format(this.msg, args);
        return new CodeMsg(code, message);
    }

    private CodeMsg(int code,String msg){
        this.code = code;
        this.msg = msg;
    }

}

统一返回类2

/**
 * 统一的 REST响应对象
 * @author wj
 * @create 2022-07-01 14:28
 */
@Data
public class RetResult {

    /**
     * 成功
     */
    public static int SUCCESS_CODE = 200;
    /**
     * 失败
     */
    public static int FAIL_CODE = 500;
    /**
     * 业务警告
     */
    public static int WARN_CODE = 400;

    int code;
    String message;
    Object data;

    private RetResult(int code, String message, Object data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    /**
     * 操作成功-无数据返回
     * @return
     */
    public static RetResult success() {
        return new RetResult(SUCCESS_CODE,"操作成功！",true);
    }

    /**
     * 操作成功-带数据
     * @param data
     * @return
     */
    public static RetResult success(Object data) {
        return new RetResult(SUCCESS_CODE,"操作成功！",data);
    }

    /**
     * 500异常
     * @param message
     * @return
     */
    public static RetResult fail(String message) {
        return new RetResult(FAIL_CODE,message,"");
    }

    /**
     * 业务异常
     * @param message
     * @return
     */
    public static RetResult warn(String message) {
        return new RetResult(WARN_CODE,message,"");
    }
}

全局异常处理器 - 自定义异常

• 全局异常处理器

@Slf4j
@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {

     @ExceptionHandler(value = Exception.class)
    public Result<String> exceptionHandler(HttpServletRequest request, Exception e){
        //自定义异常处理
        if(e instanceof GlobalException){
            GlobalException ex = (GlobalException)e;
            return Result.error(ex.getCm());
        }
        //Valid参数校验异常处理
        else if(e instanceof BindException){
            BindException ex = (BindException)e;
            List<ObjectError> errors = ex.getAllErrors();
            ObjectError error = errors.get(0);
            String msg = error.getDefaultMessage();
            return Result.error(CodeMsg.BIND_ERROR.fillArgs(msg));
        }
        //其他异常处理
        else{
            log.error("【出现异常】：", e);
            return Result.error(CodeMsg.ERROR);
        }
     }
}

• 自定义异常

public class GlobalException extends RuntimeException{

    private static final long serialVersionUID = 1L;

    private CodeMsg cm;

    public GlobalException(CodeMsg cm) {
        super(cm.toString());
        this.cm = cm;
    }

    public CodeMsg getCm() {
        return cm;
    }
}

• 使用

        //验证用户是否存在
        if(dbUser == null){
            throw new GlobalException(CodeMsg.MOBILE_NOT_EXIST);
        }

本站文章除注明转载/出处外，均为本站原创或翻译，转载前请务必署名,转载请标明出处
最后编辑时间为: 2022/07/01 14:43