springboot下添加全局异常处理和自定义异常处理的过程解析

更新时间：2023年12月12日 09:00:50 作者：Scotyzh

在spring项目中，优雅处理异常，好处是可以将系统产生的全部异常统一捕获处理，自定义的异常也由全局异常来捕获，如果涉及到validator参数校验器使用全局异常捕获也是较为方便，这篇文章主要介绍了springboot下添加全局异常处理和自定义异常处理,需要的朋友可以参考下

前言

在spring项目中，优雅处理异常，好处是可以将系统产生的全部异常统一捕获处理，自定义的异常也由全局异常来捕获，如果涉及到validator参数校验器使用全局异常捕获也是较为方便。

相关代码：

GlobalExceptionHandler类：

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
    /********************************
     *  @function  : 自定义从捕捉
     *  @parameter : [e:CustomException | 自定义异常]
     *  @date      : 2023/12/5 11:47
     ********************************/
    @ExceptionHandler(value = CustomException.class)
    public AjaxResult customExceptionHandler(HttpServletRequest request, CustomException e) {
        log.error("业务异常，url：{}, 异常内容：{}" ,request.getRequestURI(), e);
        return new AjaxResult(e.getCode() , e.getMessage(), null);
    }
    /********************************
     *  @function  : 空指针异常捕捉
     *  @parameter : [e：Exception | 异常]
     *  @date      : 2023/12/5 11:47
     ********************************/
    @ExceptionHandler(value = Exception.class)
    public AjaxResult exceptionHandler(HttpServletRequest request, Exception e) {
        log.error("服务器内部异常异常，url：{}, 异常内容：{}" ,request.getRequestURI(), e);
        return new AjaxResult(500 , e.getMessage(), null);
    }
}

自定义异常CustomException类：

@Slf4j
@Data
public class CustomException extends RuntimeException{
    //错误码
    private int code;
    //错误信息
    private String message;
    public CustomException() {
        super();
    }
    public CustomException(ResultCodeEnum resultCodeEnum) {
        super(String.valueOf(resultCodeEnum.getCode()));
        this.code = resultCodeEnum.getCode();
        this.message = resultCodeEnum.getMessage();
    }
}

通用返回类：AjaxResult

@Data
public class AjaxResult extends HashMap<String, Object> {
    // 状态码
    private static final String CODE_TAG = "code";
    // 返回消息
    private static final String MSG_TAG = "message";
    // 数据对象
    private static final String DATA_TAG = "data";
    public AjaxResult(int code, String message, Object data)
    {
        super.put(CODE_TAG, code);
        super.put(MSG_TAG, message);
        if (data != null)
        {
            super.put(DATA_TAG, data);
        }
    }
    /********************************
     *  @method    : success
     *  @function  : 返回成功消息（重载）
     *  @parameter :
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult success(){
        return new AjaxResult(ResultCodeEnum.SUCCESS.getCode(), ResultCodeEnum.SUCCESS.getMessage(), null);
    }
    /********************************
     *  @method    : success
     *  @function  : 返回成功消息（重载）
     *  @parameter : message : String | 返回消息
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult success(String message){
        return new AjaxResult(ResultCodeEnum.SUCCESS.getCode(), message, null);
    }
    /********************************
     *  @method    : success
     *  @function  : 返回成功消息（重载）
     *  @parameter : data : Object | 数据对象
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult success(Object data){
        return new AjaxResult(ResultCodeEnum.SUCCESS.getCode(), ResultCodeEnum.SUCCESS.getMessage(), data);
    }
    /********************************
     *  @method    : success
     *  @function  : 返回成功消息（重载）
     *  @parameter : message : String | 返回消息
     *  @parameter : data : Object | 数据对象
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult success(String message, Object data){
        return new AjaxResult(ResultCodeEnum.SUCCESS.getCode(), message, data);
    }
    /********************************
     *  @method    : failed
     *  @function  : 返回失败消息（重载）
     *  @parameter :
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult failed(){
        return new AjaxResult(ResultCodeEnum.FAILED.getCode(), ResultCodeEnum.FAILED.getMessage(), null);
    }
    /********************************
     *  @method    : failed
     *  @function  : 返回失败消息（重载）
     *  @parameter : message : String | 返回消息
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult failed(String message){
        return new AjaxResult(ResultCodeEnum.FAILED.getCode(), message, null);
    }
    /********************************
     *  @method    : failed
     *  @function  : 返回失败消息（重载）
     *  @parameter : resultCodeEnum : ResultCodeEnum | 失败枚举类型
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult failed(ResultCodeEnum resultCodeEnum){
        return new AjaxResult(resultCodeEnum.getCode(), resultCodeEnum.getMessage(), null);
    }
    /********************************
     *  @method    : failed
     *  @function  : 返回失败消息（重载）
     *  @parameter : message : String | 返回消息
     *  @parameter : data : Object | 数据对象
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult failed(String message, Object data){
        return new AjaxResult(ResultCodeEnum.FAILED.getCode(), message, data);
    }
    /********************************
     *  @method    : failed
     *  @function  : 返回失败消息（重载）
     *  @parameter : resultCodeEnum : ResultCodeEnum | 失败枚举类型
     *  @parameter : data : Object | 数据对象
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult failed(ResultCodeEnum resultCodeEnum, Object data){
        return new AjaxResult(resultCodeEnum.getCode(), resultCodeEnum.getMessage(), data);
    }
}

枚举类ResultCodeEnum：

public enum ResultCodeEnum {
    // 10??? 通用
    SUCCESS(10000,"请求成功"),
    FAILED(10008, "请求失败"),
    FAILED_PARAM_ERROR(10009, "参数错误"),
...
    private Integer code;
    private String message;
    ResultCodeEnum(Integer code, String message) {
        this.code = code;
        this.message = message;
    }
    public int getCode(){
        return code;
    }
    public String getMessage(){
        return message;
    }
}

使用：

在controller里面判断值是否异常，如果异常则直接抛出异常不进行执行，终止当前的流程，在service层也可以这样处理。

    public AjaxResult getUserInfo(@RequestParam(value = "userId") Integer userId) {
        if （userId == 0) {
            throw new CustomException(ResultCodeEnum.NOT_EXIST_USER_ERROR);
        }
        ...
    }

再者是一些数值上的错误，比如除0，这种情况会被全局异常捕获，并返回相应的错误给到前端

    @GetMapping("/test")
    public AjaxResult test(){
        int i = 60/0;
        return AjaxResult.success();
    }

到此这篇关于springboot下添加全局异常处理和自定义异常处理的文章就介绍到这了,更多相关springboot异常处理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Spring Security 表单登录功能的实现方法
这篇文章主要介绍了Spring Security 表单登录,本文将构建在之前简单的 Spring MVC示例之上，因为这是设置Web应用程序和登录机制的必不可少的。需要的朋友可以参考下
2019-06-06
Object类wait及notify方法原理实例解析
这篇文章主要介绍了Object类wait及notify方法原理实例解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-08-08
java并发编程专题（十）----(JUC原子类)基本类型详解
这篇文章主要介绍了java JUC原子类基本类型详解的相关资料,文中示例代码非常详细，帮助大家更好的理解和学习，感兴趣的朋友可以了解下
2020-07-07
Eclipse中常用快捷键汇总
这篇文章主要介绍了Eclipse中常用快捷键，文中介绍的非常详细，帮助大家更好的利用eclipse开发，感兴趣的朋友可以了解下
2020-07-07
SpringBoot开发中使用DTO层的方法示例
DTO层是在应用程序的业务逻辑层和数据访问层之间引入的一个中间层,用于在不同层之间传输数据,本文主要介绍了SpringBoot开发中使用DTO层,具有一定的参考价值,感兴趣的可以了解一下
2024-06-06
MyBatisPlus查询报错Unknow column ‘id‘ in ‘field list‘解决分析
这篇文章主要为大家介绍了MyBatisPlus查询报错Unknow column ‘id‘ in ‘field list‘解决分析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2023-09-09
解读Java中Set真的是无序的吗
这篇文章主要介绍了Java中Set是不是无序的问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-07-07
Java中数组array和列表list相互转换
这篇文章主要介绍了Java中数组array和列表list相互转换,在Java中,可以将数组（array）和列表（list）相互转换,但需要注意一些细节和限制,本文通过实例代码给大家介绍的非常详细,需要的朋友可以参考下
2023-09-09
Java获取文件的hash值(SHA256)两种方式
这篇文章主要给大家介绍了关于Java获取文件hash值(SHA256)的两种方式,SHA256是一种哈希算法,它是不可逆的,也就是说无法解密,需要的朋友可以参考下
2023-09-09
springmvc接收参数为日期类型详解
这篇文章主要介绍了springmvc接收参数为日期类型,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-09-09