使用spring-boot开发过程中，调用接口时常遇到各种报错问题，如果项目一开始没有做完整的异常架构设计，那么对于问题排查起来就很是耗费时间。我们可以通过spring提供的异常捕获机制，在项目架构设计阶段就做好各种异常的判断，包括日志记录，详细的堆栈信息等，统一http响应的报文格式返回给前端，这样既能避免泄露私密信息以及公司所用的技术栈，又方便我们排查问题~
关于异常处理的spring官方文档说明：https://docs.spring.io/spring-framework/docs/5.3.6/reference/html/web.html#mvc-ann-exceptionhandler
下面来看下在spring-boot中两种主要的异常处理方式
局部异常的处理
通过@ExceptionHandler注解标记在Controller的方法中，来做Controller范围内的异常捕获处理
ExceptionHandler详细方法参数说明：https://docs.spring.io/spring-framework/docs/5.3.6/reference/html/web.html#mvc-ann-exceptionhandler-args
@Slf4j
@RestController
@RequestMapping("/raise/exception/test")
public class RaiseExceptionTestController {
@GetMapping("long")
public Long get(Long id) {
return id;
}
//局部异常处理
@ExceptionHandler
@ResponseBody
public Object handleException(Exception e, HandlerMethod handlerMethod, HttpMethod httpMethod, HttpServletRequest httpServletRequest) {
//这里可以根据方法参数来自定义逻辑处理，存入database/消息队列中等
log.error("{} to {} processed by {} error:{}", httpMethod.name(), httpServletRequest.getRequestURI(), handlerMethod.getMethod(), e.getMessage());
//按照约定的数据格式返回给前端
Map data = new HashMap(2);
data.put("status", false);
//实际使用应该屏蔽掉私密信息，可以根据具体的异常类型来做不同的错误描述声明
data.put("msg", e.getMessage());
data.put("random", Math.random());
data.put("processed-by", this.getClass().getSimpleName());
return data;
}
}
启动工程，访问测试接口来引发一个类型转换错误测试
GET /raise/exception/test/long?id=abc
此时可以看到已经按照我们异常处理器中封装的报文格式返回响应了
全局异常的处理
spring中可以通过@ControllerAdvice注解来拦截所有Controller，这时就可以将@ExceptionHandler方法声明写到这里，来实现全局的异常处理了
spring关于ControllerAdvice的详细使用说明：https://docs.spring.io/spring-framework/docs/5.3.6/reference/html/web.html#mvc-ann-controller-advice
@Slf4j
@ControllerAdvice
public class CustomControllerAdvice {
@ExceptionHandler
@ResponseBody
public Object handleAllException(Exception e, HandlerMethod handlerMethod, HttpMethod httpMethod, HttpServletRequest httpServletRequest) {
log.error("{} to {} processed by {} error:{}", httpMethod.name(), httpServletRequest.getRequestURI(), handlerMethod.getMethod(), e.getMessage());
Map data = new HashMap(2);
data.put("status", false);
data.put("msg", e.getMessage());
data.put("processed-by", this.getClass().getSimpleName());
return data;
}
}
注意先注释局部异常处理器，再访问接口引发异常来测试下结果，屏蔽局部异常处理器的干扰
可以看到我们的全局异常处理器已经生效了
那么局部异常处理器和全局异常处理器同时存在的时候会是什么样的结果呢？通过我实际测试发现，局部异常处理器优先级会高于全局异常处理器，也就是说，当两者同时存在的时候，只会执行局部的异常处理逻辑~
最后要说下，spring官方建议在使用全局异常处理的时候，通过继承ResponseEntityExceptionHandler，来按照需要重写对应的方法，大部分http相关异常情况ResponseEntityExceptionHandler已经帮我们处理的很好了
ResponseEntityExceptionHandler的官方说明：https://docs.spring.io/spring-framework/docs/5.3.6/javadoc-api/org/springframework/web/servlet/mvc/method/annotation/ResponseEntityExceptionHandler.html
示例代码：
@ControllerAdvice
public class CustomControllerAdvice extends ResponseEntityExceptionHandler {
@ExceptionHandler
@ResponseBody
public Object handleAllException(Exception e, HandlerMethod handlerMethod, HttpMethod httpMethod, HttpServletRequest httpServletRequest) {
...
}
@Override
protected ResponseEntity<Object> handleMissingServletRequestParameter(MissingServletRequestParameterException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
//todo
}
}
ResponseEntityExceptionHandler相关http接口调用异常处理方法
