API开发中对全局异常的处理思路与流程

异常的分类

异常分为两种

  • 自定义异常
  • 系统异常

自定义异常

在开发时,对异常情况进行封装的异常,比如参数校验不通过,文件不存在的异常。这些异常信息需要返回给客户端,所以通常带有错误代码和错误信息

系统异常

这个时系统在运行的过程中,我们无法预料的异常,比如除 0 异常,数据库连接断开异常。这些异常不需要告知客户端详细信息,只需要告知客户端“服务器出错”,并且将错误信息写入日志,以供后端人员 debug。

SpringBoot中的全局异常处理

需要用到 ControllerAdvice 注解

import com.ikutarian.yuejia.vo.Result;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * 全局异常处理
 * 异常分为两种:1)自定义异常 2)系统错误异常
 */
@ControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 自定义异常的处理
     */
    @ResponseBody
    @ExceptionHandler(value = BaseRunTimeException.class)
    public Result jsonErrorHandler(BaseRunTimeException e) throws Exception {
        return Result.error(e.getCode(), e.getMessage());
    }

    /**
     * 系统错误异常
     */
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public Result errorHandler(Exception e) {
        // TODO 写入日志
        return Result.error(ResultEnum.SYSTEM_ERROR.getCode(), ResultEnum.SYSTEM_ERROR.getMsg());
    }
}

自定义异常都继承与 BaseRunTimeException

import lombok.Getter;

@Getter
public class BaseRunTimeException extends RuntimeException {

    private Integer code;

    public BaseRunTimeException(Integer code, String msg) {
        super(msg);
        this.code = code;
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,306评论 19 139
  • 点击查看原文 Web SDK 开发手册 SDK 概述 网易云信 SDK 为 Web 应用提供一个完善的 IM 系统...
    layjoy阅读 14,731评论 0 15
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 174,955评论 25 709
  • 仙剑奇侠传1,我仙侠电视剧的启蒙之作。 神仙姐姐、逍遥哥哥、小阿奴、唐钰小宝、表哥、拜月叔叔……时至今日,这些名字...
    尼洁的屋顶阅读 2,701评论 0 1