统一异常处理

目录

• 一、统一异常处理
  • 1、创建统一异常处理器
• 二、处理特定异常
  • 1、添加依赖
  • 2、添加异常处理方法
  • 3、测试
• 三、自定义异常
  • 1、创建自定义异常类
  • 2、添加异常处理方法
  • 3、修改Controller
  • 4、测试

一、统一异常处理

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

1、创建统一异常处理器

创建exception包，创建统一异常处理器类UnifiedExceptionHandler，当工程中出现异常，会被统一捕获处理。

@Slf4j
@Component
//在controller层添加通知。如果使用@ControllerAdvice，则方法上需要添加@ResponseBody
@RestControllerAdvice
public class UnifiedExceptionHandler {
    /**
     * 未定义异常
     */
    @ExceptionHandler(value = Exception.class) //当controller中抛出Exception，则捕获
    public RestResult handleException(Exception e) {
        log.error(e.getMessage(), e);
        return RestResult.error();
    }
}

二、处理特定异常

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

1、添加依赖

添加jdbc依赖

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

2、添加异常处理方法

在 UnifiedExceptionHandler 中添加

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

3、测试

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

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

三、自定义异常

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

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

1、创建自定义异常类

import lombok.Data;
 
/**
 * 自定义异常类
 */
@Data
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(ResponseCodeEnum resultCodeEnum) {
        this.message = resultCodeEnum.getMessage();
        this.code = resultCodeEnum.getCode();
    }
 
    /**
     * @param resultCodeEnum 接收枚举类型
     * @param cause          原始异常对象
     */
    public BusinessException(ResponseCodeEnum resultCodeEnum, Throwable cause) {
        super(cause);
        this.message = resultCodeEnum.getMessage();
        this.code = resultCodeEnum.getCode();
    }
 
}

2、添加异常处理方法

UnifiedExceptionHandler类中添加

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

3、修改Controller

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

@ApiOperation("新增积分等级")
@PostMapping("/save")
public RestResult save(
    @ApiParam(value = "积分等级对象", required = true)
    @RequestBody IntegralGrade integralGrade) {
    
    //如果借款额度为空就手动抛出一个自定义的异常！
    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 RestResult.ok().message("保存成功");
    } else {
        return RestResult.error().message("保存失败");
    }
}

4、测试

测试

结果