Spring中的统一异常处理方式
源自:https://segmentfault.com/a/1190000016236188
在具体的SSM项目开发中,由于Controller层为处于请求处理的最顶层,再往上就是框架代码的。 因此,肯定需要在Controller捕获所有异常,并且做适当处理,返回给前端一个友好的错误码。
不过,Controller一多,我们发现每个Controller里都有大量重复的、冗余的异常处理代码,很是啰嗦。能否将这些重复的部分抽取出来,这样保证Controller层更专注于业务逻辑的处理,同时能够使得异常的处理有一个统一的控制中心点。
一、全局异常处理
1、HandlerExceptionResolver接口
使用全局异常处理器只需要两步:
1)实现HandlerExceptionResolver接口。
2)将实现类作为Spring Bean,这样Spring就能扫描到它并作为全局异常处理器加载。
在resolveException中实现异常处理逻辑。
从参数上,可以看到,不仅能够拿到发生异常的函数和异常对象,还能够拿到HttpServletResponse对象,从而控制本次请求返回给前端的行为。
此外,函数还可以返回一个ModelAndView对象,表示渲染一个视图,比方说错误页面。
不过,在前后端分离为主流架构的今天,这个很少用了。如果函数返回的视图为空,则表示不需要视图。
2、使用示例
来看一个例子:
逻辑很显然,在发生异常时,将ResponseDTO序列化为json给前端。
3、Controller局部异常处理
1)使用示例
这种异常处理只局部于某个Controller内,如:
所有Controller方法(即被RequestMapping注解的方法)抛出的异常,会被该异常处理方法处理。
使用上,在Controller内部,用@ExceptionHandler注解的方法,就会作为该Controller内部的异常处理方法。并且,它的参数中可以注入如WebRequest、NativeWebRequest等,用来拿到请求相关的数据。
它可以返回String代表一个view名称,也可以返回一个对象并且用@ResponseBody修饰,由框架的其它机制帮你序列化。
此外,它还能够对异常类型进行细粒度的控制,通过注解可以有选择的指定异常处理方法应用的异常类型:
虽然说全局异常处理HandlerExceptionResolver通过条件判断也能做到,
但是使用这种注解方式明显更具有可读性。
2)一个问题
刚才说到异常处理函数可以用@ResponseBody修饰,就像一般的Controller方法一样。
然而,非常遗憾的是,如果使用自定义的HandlerMethodReturnValueHandler,却不生效。
比如:
不知道是我的使用姿势不对,还是什么情况?各种Google后无果。
所以,目前的解决方案是,如果能够控制@JsonResponse注解相关的定义代码,将处理返回值这部分逻辑抽取出来,然后在异常处理函数中手动调用。
4、ControllerAdvice
1)使用示例
刚才介绍的是Controller局部的异常处理,用于处理该Controller内部的特有的异常处理十分有用。
首先,定义一个存放异常处理函数的类,并使用@ControllerAdvice修饰。
@ExceptionHanlder修饰的方法的写法和Controller内的异常处理函数写法是一样的。
2)控制生效的Controller范围
注意到,我是这样编写注解的:
它用来限定这些异常处理函数起作用的Controller的范围。如果不写,则默认对所有Controller有效。
这也是ControllerAdvice进行统一异常处理的优点,它能够细粒度的控制该异常处理器针对哪些Controller有效,这样的好处是:
一个系统里就能够存在不同的异常处理器,Controller也可以有选择的决定使用哪个,更加灵活。
不同的业务模块可能对异常处理的方式不同,通过该机制就能做到。
设想一个一开始并未使用全局异常处理的系统,如果直接引入全局范围内生效的全局异常处理,势必可能会改变已有Controller的行为,有侵入性。
也就是说,如果不控制生效范围,即默认对所有Controller生效。如果控制生效范围,则默认对所有Controller不生效,降低侵入性。
如刚才示例中的例子,只针对实现了GlobalExceptionHandlerMixin接口的类有效:
ControllerAdvice支持的限定范围:
按注解:
@ControllerAdvice(annotations = RestController.class)
按包名:
@ControllerAdvice("org.example.controllers")
按类型:
@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})
二、总结
以上几种方式是Spring专门为异常处理设计的机制。
就我个人而言,由于ControllerAdvice具有更细粒度的控制能力,所以我更偏爱于在系统中使用ControllerAdvice进行统一异常处理。
除了用异常来传递系统中的意外错误,也会用它来传递处于接口行为一部分的业务错误。
这也是异常的优点之一,如果接口的实现比较复杂,分多层函数实现,如果直接传递错误码,那么到Controller的路径上的每一层函数都需要检查错误码,退回到了C语言那种可怕的“写一行语句检查一下错误码”的模式。
当然,理论上,任何能够给Controller加切面的机制都能变相的进行统一异常处理。比如:
1、在拦截器内捕获Controller的异常,做统一异常处理。
2、使用Spring的AOP机制,做统一异常处理。
Spring中的统一异常处理方式的更多相关文章
- Spring 中的统一异常处理
在具体的SSM项目开发中,由于Controller层为处于请求处理的最顶层,再往上就是框架代码的.因此,肯定需要在Controller捕获所有异常,并且做适当处理,返回给前端一个友好的错误码. 不过, ...
- spring 或 springboot统一异常处理
spring 或 springboot统一异常处理https://blog.csdn.net/xzmeasy/article/details/76150370 一,本文介绍spring MVC的自定义 ...
- 基于Spring Boot的统一异常处理设计
基于Spring Boot的统一异常处理设计 作者: Grey 原文地址:https://www.cnblogs.com/greyzeng/p/11733327.html Spring Boot中,支 ...
- web.xml中配置Spring中applicationContext.xml的方式
2011-11-08 16:29 web.xml中配置Spring中applicationContext.xml的方式 使用web.xml方式加载Spring时,获取Spring applicatio ...
- spring+hibernate 配置多个数据源过程 以及 spring中数据源的配置方式
spring+hibernate 配置多个数据源过程 以及 spring中数据源的配置方式[部分内容转载] 2018年03月27日 18:58:41 守望dfdfdf 阅读数:62更多 个人分类: 工 ...
- Spring MVC自定义统一异常处理类,并且在控制台中输出错误日志
在使用SimpleMappingExceptionResolver实现统一异常处理后(参考Spring MVC的异常统一处理方法), 发现出现异常时,log4j无法在控制台输出错误日志.因此需要自定义 ...
- Spring Cloud:统一异常处理
在启动应用时会发现在控制台打印的日志中出现了两个路径为 {[/error]} 的访问地址,当系统中发送异常错误时,Spring Boot 会根据请求方式分别跳转到以 JSON 格式或以界面显示的 /e ...
- spring boot 2 统一异常处理
spring mvc 针对controller层异常统一处理非常简单,使用 @RestControllerAdvice 或 @RestControllerAdvice 注解就可以轻@RestContr ...
- Spring Boot实践——统一异常处理
注解说明 @ControllerAdvice,是Spring3.2提供的新注解,从名字上可以看出大体意思是控制器增强.让我们先看看@ControllerAdvice的实现: /** * Special ...
随机推荐
- WPF在XAML的资源中定义空字符串String.Empty
代码如下: <!--1. 首先引用System的命名空间--> <Window x:Class="DriverEasyWPF.Views.DialogWindow" ...
- C#学习之文件操作
1 DirectoryInfo 类介绍 DirectoryInfo 类在 .net 开发中主要用于创建.移动和枚举目录和子目录的实例方法,此类不能被继承. 从事 .net 软件开发的同事对 Dir ...
- Cmake编写JNI
调用两个库 CMakeLists.txt //把那种大段的注释去掉了 cmake_minimum_required(VERSION ) add_library( # Sets the name of ...
- 常用工具说明-- Intellij Idea生成JavaDoc
JavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了.在简略介绍JavaDoc写法之后,再看一下在Intellij Idea 中如何将代码中的注释 ...
- [转]SQL SERVER中openrowset与opendatasource的区别
本文转自:http://blog.sina.com.cn/s/blog_6399df820102vyy8.html SQL SERVER中openrowset与opendatasource的区别: o ...
- Oracle存储过程中调用DBLink同义词出现错误:PLS-00201: 必须声明标识符
前几天编写一个存储过程,需要访问远程数据库的字段,于是建立一个dbLink并建了同义词: CREATE PUBLIC DATABASE LINK orcl@dbc CONNECT TO orcl ID ...
- “App.exe 以附加有调试器,但没有将该调试器配置为调试此未经处理的异常。”
目前不清楚原因,但是将项目文件放到C盘就可以正常调试运行. 记录一下
- monggo查询语法
db.getCollection('vvt_user_reward').find({"description":"双节活动"})
- webpack2引入bootstrap的坑
在webpack官网教程的代码分离-css章节中,给出的例子是这样的. //安装 ExtractTextWebpackPlugin 如下 npm install --save-dev extract- ...
- js-权威指南学习笔记15.3
1.如果要明确地选取一个表单元素,可以索引表单对象的elements属性:document.forms.address.elements.street--一个name为address的form下的na ...