3分钟快速上手springBoot全局异常处理

发布时间 2023-12-10 11:19:58作者: CodeWorld1

统一异常处理

前后端都是有个统一的格式返回如Result,中有code,message,data。而若service、controller抛出异常则会导致不是统一格式的返回而是以下格式:

而导致前端接受不到约定好的code,message最终导致内部发生异常而用户却得不到最基本的反馈。

可以通过java中统一异常处理的方式抓取异常顶层controller抛出的异常,再对异常封装为约定好的Result对象

  1. 在新建类GlobalExceptionHandler上加上@RestControllerAdvice表示抓取全局Exceptinon并用json格式返回

    @RestControllerAdvice
    public class GlobalExceptionHandler {
    
  2. 在方法名上加明@ExceptionHandler,并在value中表示要处理的特定异常,可以是自定义的异常UserException或则是RuntimeException

    @ExceptionHandler(value = UserException.class)
    public Result<Object> handleBusinessException(HttpServletRequest httpServletRequest, UserException e) {
       return Result.userError(e.getMessage());
    }
    
  3. 在写代码时显示抛出自定义异常:

    public Boolean signUp(User user){
        if (userMapper.signIn(user.getUsername(), user.getPassword()) != null) {
            throw new UserException("已有账号重复注册");
        }
    

    在此访问接口可以有自定义异常的信息

    这样1.可以处理自定义异常2.可以处理其它意料外的异常统一返回;并且会自动优先匹配子类异常如优先级:UserException(继承了RuntimeException)-->RuntimeException-->Exception;

  4. 注意若捕获到子类异常则需要getCause().getmessage()获取异常错误信息不然message为null,以下为捕获RuntimeException子类的其它潜在异常的示例:

private Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
@ExceptionHandler(value = RuntimeException.class)
public Result<Object> handleRuntimeException(HttpServletRequest httpServletRequest, RuntimeException e) {
log.warn(e.getCause().getMessage());
return Result.serverError("系统内部错误");
}