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

半截的诗--

已于 2023-07-13 21:41:12 修改

阅读量324

点赞数

分类专栏： springboot JAVA 文章标签： java 开发语言 spring boot

于 2023-07-13 21:37:47 首次发布

本文链接：https://blog.csdn.net/m0_65992672/article/details/131712014

版权

springboot 同时被 2 个专栏收录

23 篇文章 4 订阅

订阅专栏

JAVA

16 篇文章 0 订阅

订阅专栏

返回异常消息看Java项目中定义统一返回结果_半截的诗--的博客-CSDN博客

一、制造异常

屏蔽 IntegralGrade 中的 @TableField注解

@ApiModelProperty(value = "逻辑删除(1:已删除，0:未删除)")
//@TableField("is_deleted")
@TableLogic
private Boolean deleted;

Swagger中测试

测试列表查询功能，查看结果，发生错误，显示响应失败

二、统一异常处理

目标：我们想让异常结果也显示为统一的返回结果对象，并且统一处理系统的异常信息，那么需要进行统一异常处理。

1、创建统一异常处理器

guigu-common中创建exception包，创建统一异常处理器类UnifiedExceptionHandler

package com.atguigu.common.exception;
/**
 * 统一异常处理，当出现异常时都会被统一异常处理器捕获
 */
@Slf4j
@Component //Spring容易自动管理
@RestControllerAdvice //在controller层添加通知。如果使用@ControllerAdvice，则方法上需要添加@ResponseBody，将当前类标识为异常处理的组件
public class UnifiedExceptionHandler {
    /**
     * 未定义异常，只要是Controller类里面出现了该类型的异常，就可以被这个方法拦截到。
     */
    @ExceptionHandler(value = Exception.class) //当controller中抛出Exception，则捕获
    public R handleException(Exception e) {
        log.error(e.getMessage(), e);
        return R.error();
    }
}

2、测试

返回统一错误结果

三、处理特定异常

如果我们不想显示统一的“服务器内部错误”，需要个性化的显示异常信息，那么需要针对特定的异常做处理

1、添加依赖

在guigu-common中添加jdbc依赖，因为异常是jdbc的

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-jdbc</artifactId>
</dependency>

2、添加异常处理方法

在 UnifiedExceptionHandler 中添加

/**
* 特定异常
*/
@ExceptionHandler(BadSqlGrammarException.class)
public R handleBadSqlGrammarException(BadSqlGrammarException e){
    log.error(e.getMessage(), e);
    return R.setResult(ResponseEnum.BAD_SQL_GRAMMAR_ERROR);
}

3、测试

问题：上面的例子虽然针对特定的异常显示个性化的错误信息，但是你会发现，针对每个不同的异常我们都需要在项目中添加对应的处理方法，并捕获对应的异常对象，可能还要针对这个异常添加额外的依赖。这显然不是最好的方式。

方案：此类异常直接抛出，并且用Exception类捕获就可以了。

4、恢复制造的异常

@TableField(value = "is_deleted")

四、自定义异常

目标：使用一个或较少的异常类，可以捕获和显示所有的异常信息。

方案：因此，我们可以创建一个自定义异常类（必须是运行时异常），在程序中抛出这个自定义异常对象，并在统一异常处理器（UnifiedExceptionHandler）中捕获自定义异常对象

1、创建自定义异常类

package com.atguigu.common.exception;
/**
 * 自定义异常，这里的异常类抛出后被UnifiedExceptionHandler捕获
 * 因此，我们可以创建一个自定义异常类（必须是运行时异常），在程序中抛出这个自定义异常对象，并在统一异常处理器中捕获自定义异常对象
 */
@Data
@NoArgsConstructor//无参构造器
public class BusinessException extends RuntimeException {
    //状态码
    private Integer code;
    //错误消息
    private String message;
    
    /**
     *
     * @param message 错误消息
     */
    public BusinessException(String message) {
        this.message = message;
    }
    /**
     *
     * @param message 错误消息
     * @param code 错误码
     */
    public BusinessException(String message, Integer code) {
        this.message = message;
        this.code = code;
    }
    /**
     *
     * @param message 错误消息
     * @param code 错误码
     * @param cause 原始异常对象
     */
    public BusinessException(String message, Integer code, Throwable cause) {
        super(cause);
        this.message = message;
        this.code = code;
    }
    /**
     *
     * @param resultCodeEnum 接收枚举类型
     */
    public BusinessException(ResponseEnum resultCodeEnum) {
        this.message = resultCodeEnum.getMessage();
        this.code = resultCodeEnum.getCode();
    }
    /**
     *
     * @param resultCodeEnum 接收枚举类型
     * @param cause 原始异常对象
     */
    public BusinessException(ResponseEnum resultCodeEnum, Throwable cause) {
        super(cause);
        this.message = resultCodeEnum.getMessage();
        this.code = resultCodeEnum.getCode();
    }
}

2、添加异常处理方法

UnifiedExceptionHandler类中添加

/**
 * 统一异常处理，当出现异常时都会被统一异常处理器捕获
 */
@Slf4j
@Component //Spring容易自动管理
@RestControllerAdvice //在controller层添加通知。如果使用@ControllerAdvice，则方法上需要添加@ResponseBody，将当前类标识为异常处理的组件
public class UnifiedExceptionHandler {

    /**
     * 未定义异常，只要是Controller类里面出现了该类型的异常，就可以被这个方法拦截到。
     */
    @ExceptionHandler(value = Exception.class) //当controller中抛出Exception，则捕获
    public R handleException(Exception e) {
        log.error(e.getMessage(), e);
        return R.error();
    }

    /**
     * 捕获自定义异常
     */
    @ExceptionHandler(BusinessException.class)
    public R handleBusinessException(BusinessException e){
        log.error(e.getMessage(), e);
        return R.error().message(e.getMessage()).code(e.getCode());
    }
}

3、修改Controller

在AdminIntegralGradeController的方法中添加异常处理，业务中需要的位置抛出BusinessException自定义异常。

@ApiOperation("新增积分等级")
@PostMapping("/save")
public R save(
    @ApiParam(value = "积分等级对象", required = true)
    @RequestBody IntegralGrade integralGrade){
       //如果借款额度为空就手动抛出一个自定义的异常！，抛完异常会被UnifiedExceptionHandler捕获
       if(integralGrade.getBorrowAmount() == null){
           //BORROW_AMOUNT_NULL_ERROR(-201, "借款额度不能为空"),如果要抛其它异常就在枚举类添加枚举就行
           throw new BusinessException(ResponseEnum.BORROW_AMOUNT_NULL_ERROR);
        }
    boolean result = integrationService.save(integralGrade);
    if (result) {
        return R.ok().message("保存成功");
    } else {
        return R.error().message("保存失败");
    }
}