SpringBoot实战之异常处理篇

Posted 2020-10-23 庞国明博客

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了SpringBoot实战之异常处理篇相关的知识，希望对你有一定的参考价值。

在互联网时代，我们所开发的应用大多是直面用户的，程序中的任何一点小疏忽都可能导致用户的流失，而程序出现异常往往又是不可避免的，那该如何减少程序异常对用户体验的影响呢？其实方法很简单，对异常进行捕获，然后给予相应的处理即可。但实现的方式却有好多种，例如：

try {
    ...
} catch (Exception e) {
    doSomeThing();
}

像这种标准的 try-catch 是可以解决问题，但如果让你在每个接口实现里面都 try-catch 一下，我想你应该是不太愿意的。那么下面来介绍下 SpringBoot 为我们提供的处理方式。

1. ErrorController 应用

首先，我们来模拟一下，出现异常的场景，方式比较简单，直接在正常的代码里面抛出一个异常即可。

技术分享图片

在上面的示例中，调用接口时，出现了异常，但客户端却收到一个相对正常的响应，这是因为 SpringBoot 默认提供了一个 /error 的映射，该映射被注册为 Servlet 容器中的一个全局错误页面用来合理处理所有的异常情况。但示例中的响应报文不符合我们定义的数据规范，想要使其满足自己的数据规范，可以自己定义一个新的 ErrorController，代码如下：

@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class FundaErrorController implements ErrorController {

    @Override
    public String getErrorPath() {
        return "/error";
    }

    @RequestMapping
    @ResponseBody
    public Result doHandleError() {
        return new Result(ResultCode.WEAK_NET_WORK);
    }
}

当我们再次访问该接口的时候会返回：

{
  "code": -1,
  "msg": "网络异常，请稍后重试",
  "data": null
}

2. ExceptionHandler 应用

熟悉 SpringMVC 的人应该都知道 @ExceptionHandler 这个注解，在 SpringBoot 里面，我们同样可以使用它来做异常捕获。

2.1. 单一 Controller 异常处理

这种方式使用场景较少，但作为学习 @ExceptionHandler 入门示例还是非常不错的，直接在对应的 Controller 里面增加一个异常处理的方法，并使用 @ExceptionHandler 标识它即可。

@ExceptionHandler(Exception.class)
public Result handleException() {
    return new Result(ResultCode.WEAK_NET_WORK);
}

技术分享图片

客户端得到的效果与使用 ErrorController 完全一致，但对于服务端来说却不太一样，如果仔细观察这两种方式的日志输出的话，会发现使用 ErrorController 时，后台会打印出异常堆栈信息，而使用 @ExceptionHandler 却不会，这是因为这两种处理方式的流程存在着本质的差别。

ErrorController： 调用 UserController 抛出异常时，自身没有做任何处理，所以会打印出堆栈信息，但这个异常会被 Servlet 容器捕捉到，Servlet 容器再将请求转发给注册好的异常处理映射 /error 做处理，客户端收到的实际是 ErrorController 的处理结果，而不是 UserController 的。
ExceptionHandler： 异常的处理方法直接被定义在 UserController 里面，也就是说，在异常抛出的时候，UserController 会使用自己的方法去做异常处理，而不会抛出给 Servlet 容器，所以这个地方没有打印堆栈信息。

如果想要在后台添加堆栈信息的输出也非常简单，只需要将该异常作为一个参数传递给异常处理方法，然后在处理方法里面做相应的操作即可。

@ExceptionHandler(Exception.class)
public Result handleException(Exception e) {
    e.printStackTrace();
    return new Result(ResultCode.WEAK_NET_WORK);
}

2.2. 父级 Controller 异常处理

项目的往往存在着多个 Controller，而它们在异常处理方面有存在着很多的共性，这样就不太适合在每一个 Controller 里面都编写一个对应的异常处理方法。可以将异常处理方法向上挪移到父类中，然后所有的 Controller 统一继承父类即可。

定义父类 BaseController：

public class BaseController {

    @ExceptionHandler(Exception.class)
    public Result handleException(Exception e) {
        e.printStackTrace();
        return new Result(ResultCode.WEAK_NET_WORK);
    }

}

UserController 通过继承 BaseController 完成异常处理：

@RestController
@RequestMapping("/sys/user")
public class UserController extends BaseController {
    ...
}

2.3. Advice 异常处理

对于使用父级 Controller 完成异常处理也有着它自己的缺点，那就是代码耦合严重，一旦哪天忘记继承 BaseController，异常又会直达客户了。想要解除这种耦合关系，可以使用 @ControllerAdvice 来协助处理。

@ControllerAdvice
@ResponseBody
public class ExceptionHandlerAdvice {

    @ExceptionHandler(Exception.class)
    public Result handleException(Exception e) {
        e.printStackTrace();
        return new Result(ResultCode.WEAK_NET_WORK);
    }

}

3. 多类别异常处理

实际的开发场景中，异常是区分很多类别的，不同类别的异常需要给用户不同的反馈。例如，在 SpringBoot实战之数据交互篇中有使用到注解式参数校验，但校验不通过原因并没有以有效的方式告之给前端应用。下面我们通过上面提到的异常处理方式来完成这个功能：

首先，在 ResultCode 类中定义好参数错误的 code，代码如下：

PARAMETER_ERROR(10101, "参数错误")

在 ExceptionHandlerAdvice 中添加对应的异常处理方法：

@ExceptionHandler(MethodArgumentNotValidException.class)
public Result handleIllegalParamException(MethodArgumentNotValidException e) {
    List<ObjectError> errors = e.getBindingResult().getAllErrors();
    String tips = "参数不合法";
    if (errors.size() > 0) {
        tips = errors.get(0).getDefaultMessage();
    }
    Result result = new Result(ResultCode.PARAMETER_ERROR);
    result.setMsg(tips);
    return result;
}

当应用程序抛出 MethodArgumentNotValidException 时，会精确匹配到该方法，在方法里面会获取到校验结果，并将所有校验错误中的第一条返回给前端应用。

技术分享图片