spring boot异常处理
spring boot异常处理
在spring mvc异常处理一文中，我介绍了在spring mvc中如何配置异常处理链、如何捕获异常、如何构建统一的异常处理。今天来谈谈如何在spring boot配置异常的统一处理方式。
spring boot和spring mvc中异常处理的不同
在spring mvc中，如果最终有未处理的异常，DispatcherServlet将会重新发送/error请求用于返回最终的错误信息，但是Servlet本身并不提供全局的错误页面，而是需要开发者在web.xml中配置：
<error-page>
<location>/error</location>
</error-page>
也就是说，即便是采用Spring中的Bean配置方式一文中介绍的Java注解的方式实现无xml的系统配置，仍然需要开发者提供微型的web.xml配置文件来实现全局错误文件的配置。
而在spring boot中，当最终有未处理的异常抛出的时候，Servlet容器仍然会发送/error请求，但是和spring mvc不同的是，spring boot提供了内置的BasicErrorController处理全局的错误信息，不需要任何其他的配置。
下面通过一个简单的例子验证一下spring boot中默认的异常处理流程：
-
首先在
HomeController中映射index请求，接口中什么都不做，仅抛出一个RuntimeException异常。@Controller public class HomeController { @GetMapping(value = "/index") @ResponseBody public String index() { throw new RuntimeException("runtime exception in /index"); } } -
然后请求该接口，结果如下：
1.jpg
在这里，处理在一个请求接口中排出了异常，我们没有做其他任何操作，spring boot自动的给我们展示了这个whitelabel错误信息。那么这是怎么实现的呢?
BasicErrorController完成默认的异常处理
实际上，spring boot已经为我们提供了/error请求的controller，它就是BasicErrorController。
BasicErrorController的源码如下：
@Controller
@RequestMapping({"${server.error.path:${error.path:/error}}"})
public class BasicErrorController extends AbstractErrorController {
// ... 省略构造函数
public String getErrorPath() {
return this.errorProperties.getPath();
}
@RequestMapping(
produces = {"text/html"}
)
public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
HttpStatus status = this.getStatus(request);
Map<String, Object> model = Collections.unmodifiableMap(this.getErrorAttributes(request, this.isIncludeStackTrace(request, MediaType.TEXT_HTML)));
response.setStatus(status.value());
ModelAndView modelAndView = this.resolveErrorView(request, response, status, model);
return modelAndView != null ? modelAndView : new ModelAndView("error", model);
}
@RequestMapping
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
Map<String, Object> body = this.getErrorAttributes(request, this.isIncludeStackTrace(request, MediaType.ALL));
HttpStatus status = this.getStatus(request);
return new ResponseEntity(body, status);
}
protected ErrorProperties getErrorProperties() {
return this.errorProperties;
}
// ... 省略其他方法
}
从源码可知：
-
BasicErrorController处理${server.error.path:${error.path:/error}请求。意思是：- 如果在
application.properties中设置了server.error.path，就映射该值； - 否则，如果
error.path有值就映射该值 - 否则映射
/error
可以通过修改
server.error.path和error.path让BasicErrorController不再处理error请求 - 如果在
-
BasicErrorController有errorHtml和error两种不同的处理接口处理请求，其中errorHtml特指http请求中accept属性值为text/html的请求。如果请求的返回类型不同，可以为一个请求通过设置
produces指定特定的返回类型
自定义错误页面
spring boot默认的错误页面显然不能满足开发的正常需求，通过在src/main/resources/templates文件夹中添加error.ftl(基于freemaker模板)错误页面实现自定义错误信息。还可以通过在src/main/resources/templates/error中添加404.ft l等以http错误码开头的页面实现不同http错误状态的不同展现。结构如下图：
2.jpg
如果
error文件夹下有对应的状态码错误页面，则会渲染该页面；否则，渲染error.flt页面。
具体的错误页面的内容，大家根据自己项目的情况，设计自己的展示样式。
统一异常处理
前文说过，/error请求的触发前提是系统中抛出的异常到最终都没有被处理掉，在spring mvc异常处理中提到可以通过@ControllerAdvice和@ExceptionHandler实现捕获系统中的异常，在spring boot中该方法同样奏效。需要注意的是，如果@ControllerAdvice中如果有其他异常没有捕获到，最终仍然会通过BasicErrorController处理这些异常。
统一异常处理部分代码如下：
@RestControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);
/**
* 接口参数异常
* @param e
* @return
*/
@ExceptionHandler(value = {InterfaceIllegalArgumentException.class})
public Map<String, Object> handleIllegalArgumentException(InterfaceIllegalArgumentException e) {
LOGGER.error(e.getMessage(), e);
return OutPut.failure(HttpStatusWrapper.ILLEGAL_REQUEST_PARAMETERS, e.getMessage());
}
/**
* 其他未知异常
* @param e
* @return
*/
@ExceptionHandler(value = {Exception.class})
public Map<String, Object> handleException(Exception e) {
LOGGER.error(e.getMessage(), e);
return OutPut.failure(HttpStatusWrapper.INTERNAL_SERVER_ERROR, ResponseMsg.QUERY_FAILURE);
}
/**
* 请求阐述不匹配错误
* @param ex
* @param headers
* @param status
* @param request
* @return
*/
@Override
protected ResponseEntity<Object> handleTypeMismatch(TypeMismatchException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
return ResponseEntity.status(HttpStatusWrapper.REQUEST_PARAMETER_TYPE_MISMATCH.getCode()).body(OutPut.failure(HttpStatusWrapper.REQUEST_PARAMETER_TYPE_MISMATCH, ex.getValue() + "的类型不匹配，需要" + ex.getRequiredType()));
}
/**
* 请求的类型不支持
* @param ex
* @param headers
* @param status
* @param request
* @return
*/
@Override
protected ResponseEntity<Object> handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
final String supportMediaTypes = ex.getSupportedMediaTypes().stream()
.map(MimeType::getType)
.collect(Collectors.joining(","));
return ResponseEntity.status(HttpStatusWrapper.UNSUPPORTED_MEDIA_TYPE.getCode()).body(OutPut.failure(HttpStatusWrapper.UNSUPPORTED_MEDIA_TYPE, ex.getContentType() + "is not supported, the support media type are" + String.join(",", supportMediaTypes)));
}
}
