Spring 中的异常处理
工作中遇到这样的同事,问他活干完吗,他说开发好了,结果测试时发现各种异常情况未处理,联调测试时各种未知错误,最后联调完成比他预期的两倍工作量还多。这样的开发如果是新人还可以原谅,如果有工作经验且出现多次这样的情况,就需改进了。
为了保证程序的健壮性和便于快速定位请求出现的异常问题,我们必须为程序提供统一的异常处理方式,一个合格的程序员在开发时就要有异常处理意识,并能熟练使用自己常用语言框架的异常处理机制。
Spring 框架的异常处理提供了许多种方式,在 Spring 3.2 之前主要有两种处理方式:扩展 HandlerExceptionResolver
和 使用注解 @ExceptionHandler,Spring 3.2 之后提供了更丰富的处理方式。
HandlerExceptionResolver 扩展
HandlerExceptionResolver
是一个处理 Web 程序发生异常时的接口,接口方法如下:
@Nullable
ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, @Nullable Object handler, Exception ex);
从返回值类型 ModelAndView
可以看出,这个属于 Spring MVC 框架中的接口,实现此方法就可以对捕获的异常进行解析处理,然后根据自身需要返回 ModelAndView
对象,以 JSON 数据或者页面形式响应客户端请求。
首先来看下 HandlerExceptionResolver
类层次体系,Spring 提供了 4 个实现类,下面根据这些类做了简单的描述。
HandlerExceptionResolver | 描述 |
---|---|
SimpleMappingExceptionResolver |
映射异常类到指定视图,一般用于展现异常发生时的错误页面 |
DefaultHandlerExceptionResolver |
HandlerExceptionResolver 的默认实现,处理 Spring MVC 异常 |
ResponseStatusExceptionResolver |
处理带有 @ResponseStatus 注解的异常,将注解上对应的值转换为 HTTP 状态码,一般放于自定义的异常类上 |
ExceptionHandlerExceptionResolver |
处理带有 @ExceptionHandler 注解的异常 |
当我们需要实现自定义的 HandlerExceptionResolver
时,只要通过继承它的抽象类 AbstractHandlerExceptionResolver
,覆写 doResolveException
方法就可以了。
下方的示例代码处理了程序中发生的 IllegalArgumentException
异常时的情况,并通过 MappingJackson2JsonView
对象返回客户端一个 JSON 数据对象。如果不是 IllegalArgumentException
异常,返回 null
表示让其他异常处理器进行处理,这里由于异常处理链机制,如果不处理异常,就会由 Web 容器将异常返回给客户端。
@Component
public class RestResponseStatusExceptionResolver extends AbstractHandlerExceptionResolver {
@Override
protected ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
try {
if (ex instanceof IllegalArgumentException) {
ModelAndView modelAndView = new ModelAndView();
Map<String, String> maps = new HashMap<>();
maps.put("code", "400");
maps.put("message", ex.getClass().getName());
maps.put("data", null);
MappingJackson2JsonView mappingJackson2JsonView = new MappingJackson2JsonView();
mappingJackson2JsonView.setAttributesMap(maps);
modelAndView.setView(mappingJackson2JsonView);
return modelAndView;
}
} catch (Exception handlerException) {
logger.warn("Handling of [" + ex.getClass().getName() + "] resulted in Exception", handlerException);
}
return null;
}
}
我们使用 Postman 工具模拟请求项目的 API 接口 /exception1
来导致异常的触发,正常可以看到如下效果:
@ExceptionHandler
接下来我们看下 @ExceptionHandler
的用法,这个注解通常定义在某个控制器下的方法里,表明处理该控制器出现的指定异常, 如下代码所示:
@RestController
public class RestApiController {
//...
@ExceptionHandler({IllegalStateException.class})
public ModelAndView handleIllegalStateException(IllegalStateException ex) {
System.out.println("非法状态异常出现,需要处理 " + ex.getMessage());
ModelAndView modelAndView = new ModelAndView();
Map<String, String> maps = new HashMap<>();
maps.put("data", null);
maps.put("message", ex.getClass().getName());
maps.put("code", "400");
MappingJackson2JsonView mappingJackson2JsonView = new MappingJackson2JsonView();
mappingJackson2JsonView.setAttributesMap(maps);
modelAndView.setView(mappingJackson2JsonView);
return modelAndView;
}
}
@ExceptionHandler
可以设置多个需要捕获处理的异常类型,也可以不填默认为所有异常类,更多信息可以查看 mvc-ann-exceptionhandler
然后使用 Postman 工具模拟请求项目的 API 接口 /exception2
来触发异常,看下响应数据:
这样方式使用 @ExceptionHandler
存在一个缺陷,就是只会针对当前控制器下的异常处理,若需要实现全局控制器的异常处理,还需要配合注解 @ControllerAdvice
一起使用,接下来就介绍这个处理方式。
@ControllerAdvice
Spring 3.2 引入了一种新注解 @ControllerAdvice
,用于将所有控制器中异常的处理放在一处进行,将指定一个类作为全局异常处理器,用 @ExceptionHandler
注解标注的方法去处理异常,具体示例代码如下:
@ControllerAdvice
public class NormalExceptionHandler {
@ExceptionHandler()
public ResponseEntity handleException(Exception e) {
System.out.println("NormalExceptionHandler handle exception");
return ResponseEntity.ok(new Result<>(400, e.getMessage(), null));
}
}
代码中的 Result 对象只是一个数据传输对象 (DTO),便于返回客户端统一格式的数据。
再来看下使用 Postman 工具模拟请求 API 接口 /exception3
响应的数据,见下图。
还有一个注解 @RestControllerAdvice
跟 @ControllerAdvice
很相似,其实就是 @ControllerAdvice
与 @ResponseBody
注解的组合,效果就是异常处理方法返回的对象,直接就会被序列化成 JSON 数据给客户端,使用方式如下:
@RestControllerAdvice
public class RestExceptionHandler {
@ExceptionHandler({ArithmeticException.class})
public Result handlerException(Exception e) {
return new Result<>(400, e.getMessage(), null);
}
}
这个注解是在 Spring 4.3 版本引入的,主要就是便于针对 REST 请求异常时直接返回 JSON 格式的数据,而不使用 ResponseEntity
对象方式传递数据。
@ControllerAdvice
默认拦截所有控制器中发生的异常,当然也可以限定范围,限定方式有限定注解,包名等,具体示例如下:
// Target all Controllers annotated with @RestController
@ControllerAdvice(annotations = RestController.class)
public class ExampleAdvice1 {}
// Target all Controllers within specific packages
@ControllerAdvice("org.example.controllers")
public class ExampleAdvice2 {}
// Target all Controllers assignable to specific classes
@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})
public class ExampleAdvice3 {}
对于 全局 @ExceptionHandler
方法处理的描述,官方文档还有额外的备注如下:
Global
@ExceptionHandler
methods (from a@ControllerAdvice
) are applied after local ones (from the@Controller
).
这表明了异常处理也存在优先级,先交给当前控制器内的 @ExceptionHandler
方法处理,若未处理再由全局的@ExceptionHandler
方法处理。
ResponseEntityExceptionHandler 扩展
ResponseEntityExceptionHandler
类是主要针对 Spring MVC 所抛出异常的处理类,比如 405 请求,400 请求等,都默认由 ResponseEntityExceptionHandler
处理,我们可以过继承这个类覆写它的方法,来实现特定请求异常的处理。比如下面代码实现对 405 请求异常的响应处理。
@@ControllerAdvice
public class CustomWebResponseEntityExceptionHandler extends ResponseEntityExceptionHandler {
@Override
protected ResponseEntity<Object> handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
switch (status) {
case METHOD_NOT_ALLOWED:
return getMethodNotAllowedResponse(request);
default:
return ResponseEntity.ok(new Result<>(status.value(), status.getReasonPhrase(), null));
}
}
public ResponseEntity getMethodNotAllowedResponse(WebRequest request) {
String uri = "";
if (request instanceof ServletWebRequest) {
uri = ((ServletWebRequest) request).getRequest().getRequestURI();
}
Result<Object> result = new Result<>();
result.setCode(HttpStatus.METHOD_NOT_ALLOWED.value());
result.setMessage(uri + " 请求方式不正确");
return ResponseEntity.ok(result);
}
}
通过这样的方式,我们尝试发送 GET 请求给 API 接口/hello
,会有如下返回信息:
当时 ResponseEntityExceptionHandler
也存在局限性,目前支持的 SpringMVC 标准异常只有下面 15 种异常类型:
HttpRequestMethodNotSupportedException
HttpMediaTypeNotSupportedException
HttpMediaTypeNotAcceptableException
MissingPathVariableException
MissingServletRequestParameterException
ServletRequestBindingException
ConversionNotSupportedException
TypeMismatchException
HttpMessageNotReadableException
HttpMessageNotWritableException
MethodArgumentNotValidException
MissingServletRequestPartException
BindException
NoHandlerFoundException
AsyncRequestTimeoutException
ResponseStatusException
ResponseStatusException
类是在 Spring 5.0 引入,关联 HTTP 状态码和可选的原因,我们直接就可以在请求方法中构建这个异常对象进行返回,使用起来十分简单:
@GetMapping("/exception4")
public ResponseEntity<String> exception4(String param) {
throw new ResponseStatusException(HttpStatus.NOT_FOUND, "资源未找到");
}
使用这种方式虽然能直接返回响应码和具体原因,但是没有统一处理异常的效果,通常配合 @ControllerAdvice
一起组合使用。
Spring Boot ErrorController
ErrorController
是 Spring Boot 2.0 引入接口,基于此的实现类 org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController
为我们提供了一种通用的方式进行错误处理, 下面是这个实现类的关键方法:
@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
public ModelAndView errorHtml(HttpServletRequest request,
HttpServletResponse response) {
HttpStatus status = getStatus(request);
Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes(
request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
response.setStatus(status.value());
ModelAndView modelAndView = 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 = getErrorAttributes(request,
isIncludeStackTrace(request, MediaType.ALL));
HttpStatus status = getStatus(request);
return new ResponseEntity<>(body, status);
}
可以从这两个方法看出针对错误请求,BasicErrorController
提供了两种数据形式的返回,一种是 HTML 页面,一种是 JSON 数据;如果我们直接使用浏览器访问接口的话见到的就是 errorHtml
方法返回的 HTML 页面数据,它们的区别就在于请求时 Header 里 Accept 值的不同。
另外,Spring Boot 提供统一错误信息处理,是允许关闭的,只要在配置文件 application.properties
设置 server.error.whitelabel.enabled
为 false
即可。
server.error.whitelabel.enabled=false
当然我们也可以基于此进行扩展,比如实现一个自定义的错误控制器,继承 BasicErrorController
,编写自己的错误展示逻辑和内容,比如下面代码:
@Component
public class CustomErrorController extends BasicErrorController {
public CustomErrorController(ErrorAttributes errorAttributes) {
super(errorAttributes, new ErrorProperties());
}
@RequestMapping(produces = MediaType.APPLICATION_XML_VALUE)
public ResponseEntity<Map<String, Object>> xmlError(HttpServletRequest request, HttpStatus status) {
Map<String, Object> map = new HashMap<>();
map.put("code", status.value());
map.put("message", status.getReasonPhrase());
return ResponseEntity.ok(map);
}
}
实现的 CustomErrorController
针对请求时 Aceept 为 application/xml
的发生的异常都统一以 XML 格式进行返回,如图:
注意: Spring Boot 默认不支持数据进行 XML 格式的转换,POM 文件需要额外添加依赖库:
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
</dependency>
Spring 中的异常处理的更多相关文章
- Spring中的统一异常处理方式
源自:https://segmentfault.com/a/1190000016236188 在具体的SSM项目开发中,由于Controller层为处于请求处理的最顶层,再往上就是框架代码的. 因此, ...
- 转:Spring Boot应用中的异常处理
引自:https://www.cnblogs.com/yangfanexp/p/7616570.html 楼主前几天写了一篇“Java子线程中的异常处理(通用)”文章,介绍了在多线程环境下3种通用的异 ...
- Spring 中的统一异常处理
在具体的SSM项目开发中,由于Controller层为处于请求处理的最顶层,再往上就是框架代码的.因此,肯定需要在Controller捕获所有异常,并且做适当处理,返回给前端一个友好的错误码. 不过, ...
- spring boot 中统一异常处理
基于 spring boot 对异常处理的不友好,现在通过其他的方式来统一处理异常 步骤一:自定义异常类 public class UserNotExistException extends Runt ...
- 从零开始学 Java - Spring MVC 统一异常处理
看到 Exception 这个单词都心慌 如果有一天你发现好久没有看到Exception这个单词了,那你会不会想念她?我是不会的.她如女孩一样的令人心动又心慌,又或者你已经练功到了孤独求败,等了半辈子 ...
- Spring中文文档
前一段时间翻译了Jetty的一部分文档,感觉对阅读英文没有大的提高(*^-^*),毕竟Jetty的受众面还是比较小的,而且翻译过程中发现Jetty的文档写的不是很好,所以呢翻译的兴趣慢慢就不大了,只能 ...
- (转)Spring中@Async用法总结
原文:http://blog.csdn.net/blueheart20/article/details/44648667 引言: 在Java应用中,绝大多数情况下都是通过同步的方式来实现交互处理的: ...
- spring mvc4:异常处理
前面学习过struts2的异常处理,今天来看下spring mvc4的异常处理: 一.Servlet配置文件修改 <bean id="exceptionResolver" c ...
- Spring中@Async用法总结
引言: 在Java应用中,绝大多数情况下都是通过同步的方式来实现交互处理的:但是在处理与第三方系统交互的时候,容易造成响应迟缓的情况,之前大部分都是使用多线程来完成此类任务,其实,在Spring 3. ...
随机推荐
- 大话设计模式Python实现- 抽象工厂模式
抽象工厂模式(Abstract Factory Pattern):提供一个创建一系列相关或相互依赖对象的接口,而无需指定它们的类 下面是一个抽象工厂的demo: #!/usr/bin/env pyth ...
- spring-framework-core-ioc Container 笔记版本
Spring框架对于java开发人员来说是无比重要的.接触java也有3年了,接触Spring两年了.在工作中天天使用它,平时也会通过视频和书籍尝试更加的了解Spring.对于初学者来说,Spring ...
- HBase开发错误记录(java.net.UnknownHostException: unknown host: hadoop111)
windows下开发HBase应用程序,HBase部署在linux环境中, 在运行调试时可能会出现无法找到主机,类似异常信息如下: java.net.UnknownHostException: unk ...
- 快速入门:Python简单实例100个(入门完整版)
Python3 100例 文章目录 Python3 100例 实例001:数字组合 实例002:“个税计算” 实例003:完全平方数 实例004:这天第几天 实例005:三数排序 实例006:斐波那契 ...
- FusionInsight大数据开发--HBase应用开发
HBase应用开发 HBase的定义 HBase是一个高可靠.高性能.面向列.可伸缩的分布式存储系统. 适合于存储大表数据,可以达到实时级别. 利用Hadoop HDFS 作为其文件存储系统,提供实时 ...
- LinuxShell——变量
LinuxShell——变量 摘要:本文主要学习了Shell命令中的变量. 什么是变量 简单的说,变量就是让某一个特定字串代表不固定的内容. 变量是计算机内存的单元,其中存放的值可以改变.当Shell ...
- Winform中设置ZedGraph鼠标双击获取距离最近曲线上的点的坐标值
场景 WInforn中设置ZedGraph的焦点显示坐标格式化以及显示三个坐标数的解决办法: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/det ...
- Vue中iframe和组件的通信
最近的项目开发中用到了Vue组件中嵌套iframe,相应的碰到了组件和HTML的通信问题,场景如下:demo.vue中嵌入 test.html 由于一般的iframe嵌套是用于HTML文件的,在vue ...
- 英语_金丝楠是紫楠(phoebeSheareri)的别名
姚黄魏紫俱凋零--红木家具今古谈(连载七) [上海木业网]楠木品种包括闽楠.细叶楠.红毛山楠.滇楠.白楠.紫楠.乌心楠.桢楠.水楠.香楠等二百余种之多,1997年的木材国家标准中就列入了八种.某些售卖 ...
- 【Linux】扩展阿里云数据盘分区和文件系统
扩容云盘只是扩大存储容量,不会扩容文件系统 一.准备工作 在扩展数据盘扩展分区和文件系统前,请提前完成以下工作. 创建快照以备份数据,防止操作失误导致数据丢失. 通过ECS控制台或者API扩容云盘容量 ...