Spring 异常处理的各种姿势总结
本文实例总结了Spring异常处理的各种姿势。分享给大家供大家参考，具体如下：
1.前言
统一的异常处理对于应用的重要性不言而喻。今天我们来介绍一下Spring如何来进行统一的Rest异常处理。同时我们也会简单比较一下它们之间的优劣。
2.@Controller结合@ExceptionHandler
在控制器中声明一个方法然后用@ExceptionHandler注解标记即可：
@Controller
@RequestMapping("/test")
publicclassTestController{
@RequestMapping("/err")
@ResponseBody
publicObjectdemo1(){
inti=1/0;
returnnewDate();
}
@ExceptionHandler({RuntimeException.class})
publicModelAndViewfix(Exceptionex){
System.out.println(ex.getMessage());
returnnewModelAndView("error",newModelMap("ex",ex.getMessage()));
}
}
优点：
- 优先级最高。
- @ExceptionHandler标记的方法返回值类型支持多种。可以是视图，也可以是json等。
缺点：
- 一个Controller中的@ExceptionHandler注解上的异常类型不能出现相同的，否则运行时抛异常。
- 需要显式的声明处理的异常类型。
- 作用域仅仅是该Controller并不是真正意义上的全局异常。如果要想作用于全局需要将其放入所有控制器的父类中。
3.@ControllerAdvice结合@ExceptionHandler
这是2.的改进型，通过定义@ControllerAdvice类并在方法上标记@ExceptionHandler，达到了全局异常处理的目的：
@ControllerAdvice
publicclassTestController{
@ExceptionHandler({RuntimeException.class})
publicModelAndViewfix(Exceptionex){
System.out.println(ex.getMessage());
returnnewModelAndView("error",newModelMap("ex",ex.getMessage()));
}
}
优点：
- 全局的异常处理。
- 完全控制响应的主体以及状态码
- 将多个异常映射到同一方法，以一起处理，并且它充分利用了更新的RestfulResponseEntity响应
缺点：
- 一个Controller中的@ExceptionHandler注解上的异常类型不能出现相同的，否则运行时抛异常。
- 需要显式的声明处理的异常类型。
一般情况下也建议使用该方式进行异常处理。大多数情况下都是兼容的。
4.HandlerExceptionResolver接口
实现HandlerExceptionResolver接口，这里我们继承其抽象实现AbstractHandlerExceptionResolver:
@Component
publicclassRestResponseStatusExceptionResolverextendsAbstractHandlerExceptionResolver{
@Override
protectedModelAndViewdoResolveException(
HttpServletRequestrequest,
HttpServletResponseresponse,
Objecthandler,
Exceptionex){
try{
if(exinstanceofIllegalArgumentException){
returnhandleIllegalArgument((IllegalArgumentException)ex,response,handler);
}
//todomoreexception
}catch(ExceptionhandlerException){
//todo
}
returnnull;
}
privateModelAndView
handleIllegalArgument(IllegalArgumentExceptionex,HttpServletResponseresponse)
throwsIOException{
response.sendError(HttpServletResponse.SC_CONFLICT);
Stringaccept=request.getHeader(HttpHeaders.ACCEPT);
//todomoreresponse
returnnewModelAndView();
}
}
优点：
- 这是一个全局的异常处理器。
- 这种方式全局异常处理返回JSP、velocity等模板视图比较方便。
- 支持多种格式的响应，虽然覆写的方法返回的是ModelAndView但是因为参数中有HttpServletResponse，我们可以利用它来进行定制响应结果。例如，如果客户端要求输入application/json，那么在出现错误情况时，我们要确保我们返回一个以application/json编码的响应。
缺点：
- 我们需要与低级的HttpServletResponse交互才能实现各种形式的响应体。
- 优先级比较低
5.SpringBoot中的异常处理
如果你用的框架是SpringBoot。我们还可以用它独特的处理方式。优点是屏蔽了低级的API,缺点也比较明显，无法捕捉到具体的异常。
5.1实现ErrorController
SpringBoot在默认情况下，提供了/error映射来处理所有错误，在Servlet容器里注册了全局的错误页面(WhitelabelErrorPage)并返回客户端。
通过实现ErrorController接口并注册为Bean。这里不再举例。可参考BasicErrorController。
5.2添加ErrorAttributes
我们也可以添加ErrorAttributes类型的Bean来替换替换默认的异常处理。
@Component
publicclassMyCustomErrorAttributesextendsDefaultErrorAttributes{
@Override
publicMapgetErrorAttributes(
WebRequestwebRequest,booleanincludeStackTrace){
MaperrorAttributes=
super.getErrorAttributes(webRequest,includeStackTrace);
errorAttributes.put("locale",webRequest.getLocale()
.toString());
errorAttributes.remove("error");
//todoyourbusiness
returnerrorAttributes;
}
}
5.3继承基类BasicErrorController
SpringBoot自动配置还提供了实现ErrorController接口异常处理的基类BasicErrorController，默认是处理text/html类型请求的错误，可以继承该基类自定义处理更多的请求类型，添加公共方法并使用@RequestMapping注解的produce属性指定处理类型。
@Component
publicclassMyErrorControllerextendsBasicErrorController{
publicMyErrorController(ErrorAttributeserrorAttributes){
super(errorAttributes,newErrorProperties());
}
@RequestMapping(produces=MediaType.APPLICATION_XML_VALUE)
publicResponseEntity>xmlError(HttpServletRequestrequest){
//todoyourbusiness
}
}
6.Spring5的ResponseStatusException
另外在最新的Spring5中你还可以通过抛出ResponseStatusException异常来进行处理。
好处：
- 使用比较方便
- 一种类型，多种状态代码：一种异常类型可以导致多种不同的响应。与@ExceptionHandler相比，这减少了紧密耦合
- 我们将不必创建那么多的自定义异常类
- 由于可以通过编程方式创建异常，因此可以更好地控制异常处理
缺点：
- 没有统一的异常处理方式，强制执行某些应用程序范围的约定更加困难
- 可能会有大量的重复代码。
7.总结
我们对常用的、不常用的Spring处理异常的方式进行了总结和优劣上的分析。相信你可以从中找到适合你的处理方式。如果对你有用请帮忙点一个赞，您的鼓励，我的动力！
更多关于java相关内容感兴趣的读者可查看本站专题：《Spring框架入门与进阶教程》、《Java数据结构与算法教程》、《Java操作DOM节点技巧总结》、《Java文件与目录操作技巧汇总》和《Java缓存操作技巧汇总》
希望本文所述对大家java程序设计有所帮助。