通常情况下,在一个系统中,抽象出公用的部分的过程是一个DRY的一个过程。这是所有计算机工程中的一个准则。防止重复是各种轮子的开始。
springboot 异常处理
springboot常用的异常处理是利用@ControllerAdvice或者@RestControllerAdvice编写的,这两个注解的作用均是在Runtime时期。这个类会捕获在Controller中抛出的异常,这样就可以极大的简化controller中出现的杂乱的异常代码,遇到异常只需要抛出,在共有的异常处理类中就会处理。
代码如下:
@RestControllerAdvice
public class GlobalExceptionHandler {
}
复制代码
常见异常分类
在常见的HTTP Restful请求中,所有抛出的异常都要有对应的http code来对应。常见的HTTP状态码有:
- 200 成功 通常的成功响应都返回这个HTTP状态码
- 201 创建 通常在创建应用成功之后会返回这个HTTP状态码
- 404 找不到,通常在查询对象无法找到的时候返回这个HTTP状态码,这个是最常用的异常响应
- 500 内部错误 通常在服务器内部出现错误的时候,比如逻辑异常的时候返回500错误
- 401 请求未授权 通常在没有通过服务器鉴权的时候会抛出这个状态码
- 403 禁止 通常在没有认证的时候返回这个状态码
- 409 冲突 通常在新增对象的时候,如果已经存在这个对应的对象就会返回这个状态码,比如新增对象ID冲突
401和403的区别在于403是认证,比如用户密码错误这属于认证失败,返回403。而如果在登录之后,访问某些资源,但是没有权限,这属于鉴权失败,返回401。
对应的异常处理代码如下:
404异常:
/**
* 响应码 404 找不到
*
* @param e
* @return
*/
@ExceptionHandler({NoSuchStudentException.class})
@ResponseStatus(HttpStatus.NOT_FOUND)
@ResponseBody
public VndErrors onNotFoundException(Exception e) {
String logRef = logWarnLevelExceptionMessage(e);
if (log.isTraceEnabled()) {
logTraceLevelStrackTrace(e);
}
String msg = getExceptionMessage(e);
return new VndErrors(logRef, msg);
}
复制代码
409 冲突错误异常,经常用在新增或修改的时候
/**
* 响应码 409 对象已经存在,冲突错误
*
* @param e
* @return
*/
@ExceptionHandler(AllReadyExistsStudentException.class)
@ResponseStatus(HttpStatus.CONFLICT)
@ResponseBody
public VndErrors onAllReadyExistsException(Exception e) {
String logRef = logWarnLevelExceptionMessage(e);
if (log.isTraceEnabled()) {
logTraceLevelStrackTrace(e);
}
String msg = getExceptionMessage(e);
return new VndErrors(logRef, msg);
}
复制代码
500内部错误异常
/**
* 响应码 500 内部错误
*
* @param e
* @return
*/
@ExceptionHandler(Exception.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ResponseBody
public VndErrors onException(Exception e) {
log.error("Caught exception while handling a request", e);
String logRef = e.getClass().getSimpleName();
String msg = getExceptionMessage(e);
return new VndErrors(logRef, msg);
}
复制代码
这些都是一些异常的案例,可以参考编写自己的异常处理,异常处理在遇到对应的@ExceptionHandler时候,如果已经在对应的ExceptionHandler中存在,就会按照这个注解下的方法进行异常处理,如果没有,就会继续往上抛出,在上述代码案例中,可以看到500内部错误异常的代码@ExceptionHandler(Exception.class)使用的是Exception类,这样的话,所以没有被其他@ExceptionHandler处理或者尚未编写的异常处理,都会按照HTTP状态码500这个代码来处理。
所以,在真实的业务场景下,尽可能将自己的业务异常补充到对应HTTP状态码的异常处理方法中,这样就会在Restful的API中,让状态码发挥自己的应有的意义。而不是仅仅抛出一个错误.
VndErrors 和HATEOAS
了解更多可以阅读此文
springboot统一返回对象
了解更多可以阅读此文
源代码
了解更多可以阅读此文