SpringBoot-全局异常处置
背景
在 Web 开发中, 我们经常会需求处置各种异常, 这是一件棘手的事情, 需求思索以下几个问题 :
什么时分需求捕获 ( try-catch ) 异常, 什么时分需求抛出 ( throws ) 异常到上层 ?
在 dao 层捕获还是在 service 捕获, 还是在 controller 层捕获 ?
抛出异常后要怎样处置. 怎样返回给页面错误信息 ?
全局异常处置
引荐做法
不要在业务代码中停止捕获异常, 即 dao, service, controller 层的一切异常都全部抛出到上层. 这样不会招致业务代码中的一堆 try-catch 招致业务代码紊乱.
哪一层都不捕获.
返回统一的结果集 ( 错误码 + 错误描绘 ).
通常会将事务配置在 Service 层, 当数据库操作失败时, 让 Service 层抛出运转时异常, 而不停止 try-catch 处置, Spring 事物管理器就会停止回滚. 为了事务回滚
但 Service 层抛出后. 在 Controller 层就需求 try-catch 去捕获异常, 否则会返回原生错误信息到客户端. 但是, 假如在 Controller 层的每个办法体里面都写一些模板化的 try-catch 的代码, 代码不但不美观, 也增加了维护的难度, 特别是还需求对 Service 层的不同异常停止不同处置的时分.@ControllerAdvice 注解是 Spring 3.2 中新增的. 用于拦截全局的 Controller 的异常. 留意：该注解只能拦截 Controller 不能拦截 Interceptor 的异常.
全局异常处置的步骤
在 SpringMVC / SpringBoot 项目中, 只需求运用 AOP 编写一个全局的异常处置切面类, 用它来统一处置一切的异常即可.
定义一个类, 在类上添加 @ControllerAdvice+@ExceptionHandler注解, 同时需求运用 @ResponseBody 注解表示返回值为 JSON 字符串.
全局异常处置-实例
github.com/SanJingYe88…
① 运用统一的返回值
在 Controller 层的返回值只要两种, 一种是 Result 作为非分页恳求的返回值, 一种是 PageResult 作为分页恳求的返回值.
Result 非分页恳求, 返回结果实体类.
PageResult 分页恳求, 返回结果实体类.② 全局异常错误
编写一个 CodeMsg 全局异常错误码实体类. 将错误码集中管理, 然后经过 Result.error(CodeMsg codeMsg) 这种方式调用, 将业务错误码直接传回前端. 并且错误码能够随意扩展.
③ 自定义异常类
ServiceException 自定义业务异常类. 经过组合, 内部维持一个 CodeMsg 的援用, 在业务层对异常停止实例化并抛出, 让切面 GlobalExceptionHandler 捕获处置.` ServiceException
CheckException `自定义参数校验异常类.
④ 校验工具类
能够创立校验工具类来对常用的校验做统一抽取, 还能够停止 i18n 国际化显现音讯. 这里是我们本人手动编写了校验工具类, 还能够运用 Guava 提供的 Preconditions 类.
⑤ 全局异常处置类
编写 GlobalExceptionHandler 全局异常处置类. 对业务层传输来的异常做判别, 经过 Result.error(ex.getCodeMsg()) 对不同类型的异常统一返回.
@ControllerAdvice 注解, 在类上运用, 表示该类为全局异常处置类, 当 Controller 层抛出异常时调用.@ExceptionHandler 注解, 在办法上运用, 表示该办法在发作何品种型异常时会被调用. 由该注解的 value 属性决议.
全局异常处置不生效的可能缘由
被 Swagger自带的注解影响到了，RequestMapping 注解，一定要放在 Swagger 相关注解的前面。
多模块工程，全局异常处置器没有被 Sping 扫描到，所以无法处置。