Spring Boot 2.x 系列教程:WebFlux REST API 全局异常处理 Error Handling

  • 时间:
  • 浏览:0

摘要: 原创出处 https://www.bysocket.com 「公众号:泥瓦匠BYSocket 」欢迎关注和转载,保留摘要,谢谢!

本文内容

  • 怎么会要全局异常防止?
  • WebFlux REST 全局异常防止实战
  • 小结

摘录:不都利于不断培养好习惯,一起去不断打破坏习惯,亲戚亲戚一点人的行为举止利于够自始至终都有正确的。

一、怎么会要全局异常防止?

前后端分拖累发,一般提供 REST API,正常返后该有响应体,异常情况下会有对应的错误码响应。

挺多人咨询的,Spring Boot MVC 异常防止用切面 @RestControllerAdvice 注解去实现去全局异常防止。那 WebFlux 怎么防止异常?怎么实现统一错误码异常防止?

全局异常防止的好处:

  • 异常错误码等统一维护
  • 防止一点重复代码

二、WebFlux REST 全局异常防止实战

下面介绍怎么统一拦截异常,进行响应防止。

2.1 工程信息

  • 运行环境:JDK 7 或 8,Maven 3.0+
  • 技术栈:SpringBoot 2.1.3
  • 代码地址:https://github.com/JeffLi1993/springboot-learning-example
  • 模块工程名: 2-x-spring-boot-webflux-handling-errors

工程价值形式:

application.properties 并非配置,默认即可

Application Spring Boot 应用启动类,是还利于 用来启动 Spring Boot 应用。其所含了 @SpringBootApplication 注解和 SpringApplication 类,并调用 SpringApplication 类的 run() 辦法 ,就还利于 启动该应用。

具体实现类的关系图如下:

2.2 CityRouter 路由器类

城市路由器代码如下:

RouterFunctions 对请求路由防止类,即将请求路由到防止器,这将一个 GET 请求 /hello 路由到防止器 cityHandler 的 helloCity 辦法 上。跟 Spring MVC 模式下的 HandleMapping 类似于。

RouterFunctions.route(RequestPredicate, HandlerFunction) 辦法 ,对应的 参是请求参数和防止函数,机会请求匹配,就调 对应的防止器函数。

2.3 CityHandler 服务防止类

城市服务器防止类,代码如下:

Mono:实现发布者,并返回 0 或 1 个元素,即单对象。Mono 是响应流 Publisher 具有基础 rx 操作符。还利于 成功发布元素机会错误。用 Mono 作为返回对象,是机会返回所含了一个 ServerResponse 对象,而都有多个元素。

ServerResponse 是对响应的封装,还利于 设置响应情况,响应头,响应正文。比如 ok 代表的是 200 响应码、MediaType 枚举是代表这文本内容类型、返回的是 String 的对象。

ServerRequest 是对请求的封装。从请求中搞定 city 的值,机会没有语录则抛出对应的异常。GlobalException 是封装的全局异常。

Mono.justOrEmpty():从一个 Optional 对象或 null 对象中创建 Mono。

2.4 GlobalError 防止类

如图:

GlobalException 全局异常类,代码如下:

GlobalErrorAttributes 全局异常属性值类,代码如下:

重写了父类 DefaultErrorAttributes 默认错误属性类的 getErrorAttributes 获取错误属性辦法 ,从服务请求封装 ServerRequest 中获取对应的异常。

怎么会让判断有无 GlobalException,机会是 CityHandler 服务防止类抛出的 GlobalException,则返回对应的异常的信息。

GlobalErrorWebExceptionHandler 全局异常防止类,代码如下:

代码解析如下:

  • AbstractErrorWebExceptionHandler 抽象类是用来防止全局错误时进行扩展和实现
  • @Order 注解标记 AspectJ 的切面排序,值越小拥有越高的优先级,这里设置优先级偏高。
  • 构造函数将 GlobalErrorAttributes 全局异常属性值类设置到 AbstractErrorWebExceptionHandler 抽象类的局部变量中。
  • 重写 getRoutingFunction 辦法 ,设置对应的 RequestPredicates 和 Mono 服务响应对象
  • 将 GlobalErrorAttributes 的全局异常属性值 map,设置到新的 ServerResponse 即可。

到此基本刚开始。Spring Boot MVC 错误码怎么实战,参考地址:https://www.bysocket.com/archives/1692

2.5 运行验证

在 IDEA 中执行 Application 类启动,任意正常模式机会 Debug 模式。怎么会让打开浏览器访问:

异常界面如下:

可见,这是在 CityHandler 城市服务防止类逻辑中抛出的全局异常信息。没有正常情况会是怎么?

改下 URL ,访问如下:

正常界面如下:

三、小结

在 Spring 框架中没有代表错误响应的类,以后返回响应对象,一个 Map。机会利于 定义业务的错误码返回体,参考错误码怎么实战,参考地址:https://www.bysocket.com/archives/1692。

本文重点还是有别于 Spring Boot 传统 MVC 模式统一异常防止,实战了 WebFlux 全局异常防止机制。实战中这块扩展利于 考虑:

  • 异常分层,从基类中扩展出来
  • 错误码设计分层,易扩展,比如在错误码中新增调用量字段…

代码示例

本文示例读者还利于 通过查看下面仓库的中的模块工程名: 2-x-spring-boot-webflux-handling-errors:

  • Github:https://github.com/JeffLi1993/springboot-learning-example
  • Gitee:https://gitee.com/jeff1993/springboot-learning-example

机会您对什么感兴趣,欢迎 star、follow、收藏、转发给予支持!

参考资料

  • WebFlux REST API 全局异常防止:https://www.bysocket.com/archives/2200
  • https://dzone.com/articles/exception-handling-in-spring-boot-webflux-reactive

以下专题教程我知道你您会有兴趣

  • 《Spring Boot 2.x 系列教程》 https://www.bysocket.com/springboot
  • 《Java 核心系列教程》 https://www.bysocket.com/archives/2200

 

(关注微信公众号,领取 Java 精选干货学习资料)