Spring Cloud Gateway过滤器精确控制异常返回(实战，控制http返回码和message字段)
- 2021 年 11 月 30 日
- 筆記
欢迎访问我的GitHub
这里分类和汇总了欣宸的全部原创(含配套源码)：//github.com/zq2599/blog_demos
本篇概览
- 前文《Spring Cloud Gateway过滤器精确控制异常返回(分析篇)》咱们阅读源码，了解到Spring Cloud Gateway是如何处理全局异常信息的，学了那么多理论，不免手痒想实战验证学习效果，今天咱们就来写代码，最终目标是改写下图两个红框中的内容：
- 为了简单起见，本篇不再新增maven子工程，而是基于前文创建的子工程gateway-change-body，在这里面继续写代码；
源码下载
- 本篇实战中的完整源码可在GitHub下载到，地址和链接信息如下表所示(//github.com/zq2599/blog_demos)：
| 名称 | 链接 | 备注 |
|---|---|---|
| 项目主页 | //github.com/zq2599/blog_demos | 该项目在GitHub上的主页 |
| git仓库地址(https) | //github.com/zq2599/blog_demos.git | 该项目源码的仓库地址，https协议 |
| git仓库地址(ssh) | [email protected]:zq2599/blog_demos.git | 该项目源码的仓库地址，ssh协议 |
- 这个git项目中有多个文件夹，本篇的源码在spring-cloud-tutorials文件夹下，如下图红框所示：
- spring-cloud-tutorials文件夹下有多个子工程，本篇的代码是gateway-change-body，如下图红框所示：
第一种：抛出ResponseStatusException异常
- 打开gateway-change-body工程的RequestBodyRewrite.java文件，改动如下图红框，如果请求body不含user-id参数就返回Mono.error，入参是ResponseStatusException异常，设置了返回码为400，message为一段中文描述：
-
接下来运行nacos、provider-hello工程、gateway-change-body工程
-
用postman发请求试试，请求和响应的详情如下图：
- 从上图可见，返回码为400，和我们设定的一样，但是message却为空，这是怎么回事呢？按照咱们的设定，这里应该显示请求参数必须包含user-id字段，看来咱们遇到一只拦路虎了
小小拦路虎
- 咱们代码中，抛异常的时候设定message内容如下图红框所示，但运行的时候返回的是空字符串，这是怎么回事呢？
- 来看DefaultErrorWebExceptionHandler.isIncludeMessage方法，看下图红框中的那个errorProperties，您会不会恍然大悟：这不就是springboot配置中的erro配置嘛！
- 修改工程的配置文件，红框内是新增的配置：
- 再用postman试试，如下图，这一次，status、message、exception、trace齐聚一堂，完全符合预期：
- 看来第一种方法是可行的：返回ResponseStatusException类型的异常；
第二种：自定义异常，带ResponseStatus注解
-
接下来试试第二种方法：通ResponseStatus注解
-
首先新建一个异常类MyGatewayException.java，使用了ResponseStatus，在里面配置返回码和message内容，这次的返回码用的是403：
package com.bolingcavalry.changebody.exception;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;
@ResponseStatus(code = HttpStatus.FORBIDDEN, reason = "user-id字段不能为空")
public class MyGatewayException extends Exception {
}
- 编码完成，重启应用，然后再发一次请求，如下图，返回码和message内容都符合预期：
- 至此，两种最简单的方式都完成验证，一般情况下已经满足要求：将错误信息准确传递给调用方
留有瑕疵
-
聪明的您应该已发现上述两种方案有瑕疵：返回body的格式和字段都是固定的，如果项目中对返回body的内容有严格要求，例如只允许code、message、data三个字段，其余字段一律不能返回，此时又该怎么办呢？
-
似乎需要一种方法，让咱们可以随心所欲的设置body内容，篇幅所限，这种终极的解决方式就留在下一篇吧，敬请期待，欣宸原创，必不辜负您…
你不孤单，欣宸原创一路相伴
欢迎关注公众号：程序员欣宸
微信搜索「程序员欣宸」，我是欣宸，期待与您一同畅游Java世界…
//github.com/zq2599/blog_demos
