Spring-Cloud-Gateway 源码解析 —— 过滤器 (4.7) 之 NettyRoutingFilter
总阅读量:8029次
摘要: 原创出处 http://www.iocoder.cn/Spring-Cloud-Gateway/filter-netty-routing/ 「芋道源码」欢迎转载，保留摘要，谢谢！
本文主要基于 Spring-Cloud-Gateway 2.0.X M4
阅读源码最好的方式，是使用 IDEA 进行调试 Spring Cloud Gateway 源码，不然会一脸懵逼。
胖友可以点击「芋道源码」扫码关注，回复 git019 关键字
获得艿艿添加了中文注释的 Spring Cloud Gateway 源码地址。阅读源码很孤单，加入源码交流群，一起坚持！
1. 概述
本文主要分享 NettyRoutingFilter 的代码实现。
NettyRoutingFilter ，Netty 路由网关过滤器。其根据 http:// 或 https:// 前缀( Scheme )过滤处理，使用基于 Netty 实现的 HttpClient 请求后端 Http 服务。
NettyWriteResponseFilter ，与 NettyRoutingFilter 成对使用的网关过滤器。其将 NettyRoutingFilter 请求后端 Http 服务的响应写回客户端。
大体流程如下 ：
另外，Spring Cloud Gateway 实现了 WebClientHttpRoutingFilter / WebClientWriteResponseFilter ，功能上和 NettyRoutingFilter / NettyWriteResponseFilter 相同，差别在于基于 org.springframework.cloud.gateway.filter.WebClient 实现的 HttpClient 请求后端 Http 服务。在 《Spring-Cloud-Gateway 源码解析 —— 过滤器 (4.8) 之 WebClientHttpRoutingFilter》 ，我们会详细解析。
推荐 Spring Cloud 书籍：
- 请支持正版。下载盗版，等于主动编写低级 BUG 。
- 程序猿DD —— 《Spring Cloud微服务实战》
- 周立 —— 《Spring Cloud与Docker微服务架构实战》
- 两书齐买，京东包邮。
2. NettyRoutingFilter
org.springframework.cloud.gateway.filter.NettyRoutingFilter ，Netty 路由网关过滤器。
构造方法，代码如下 ：
public class NettyRoutingFilter implements GlobalFilter, Ordered { |
httpClient属性，基于 Netty 实现的 HttpClient 。通过该属性，请求后端的 Http 服务。
#getOrder() 方法，代码如下 ：
|
- 返回顺序为
Integer.MAX_VALUE。在 《Spring-Cloud-Gateway 源码解析 —— 过滤器 (4.1) 之 GatewayFilter 一览》「3. GlobalFilter」 ，我们列举了所有 GlobalFilter 的顺序。
#filter(ServerWebExchange, GatewayFilterChain) 方法，代码如下 ：
1: |
-
第 4 行 ：获得
requestUrl。 -
第 7 至 10 行 ：判断 ForwardRoutingFilter 是否能够处理该请求，需要满足两个条件 ：
-
http://或者https://前缀( Scheme ) 。 -
调用
ServerWebExchangeUtils#isAlreadyRouted(ServerWebExchange)方法，判断该请求暂未被其他 Routing 网关处理。代码如下 ：public static boolean isAlreadyRouted(ServerWebExchange exchange) {
return exchange.getAttributeOrDefault(GATEWAY_ALREADY_ROUTED_ATTR, false);
}- x
-
-
第 13 行 ：设置该请求已经被处理。代码如下 ：
public static void setAlreadyRouted(ServerWebExchange exchange) {
exchange.getAttributes().put(GATEWAY_ALREADY_ROUTED_ATTR, true);
} -
第 18 行 ：创建 Netty Request Method 对象。
request#getMethod()返回的不是io.netty.handler.codec.http.HttpMethod，所以需要进行转换。 -
第 21 行 ：获得
url。 -
第 24 至 25 行 ：创建 Netty Request Header 对象(
io.netty.handler.codec.http.DefaultHttpHeaders)，将请求的 Header 设置给它。 -
--------- 第 28 至 50 行 ：调用
HttpClient#request(HttpMethod, String, Function)方法，请求后端 Http 服务。 -
第 29 至 31 行 ：创建 Netty Request 对象(
reactor.ipc.netty.http.client.HttpClientRequest)。-
第 29 行 ：TODO 【3024】 NettyPipeline.SendOptions::flushOnEach
-
第 30 行 ：设置请求失败( 后端服务返回响应状体码
>= 400)时，不抛出异常。相关代码如下 ：// HttpClientOperations#checkResponseCode(HttpResponse response)
// ... 省略无关代码
if (code >= 400) {
if (clientError) {
if (log.isDebugEnabled()) {
log.debug("{} Received Request Error, stop reading: {}",
channel(),
response.toString());
}
Exception ex = new HttpClientException(uri(), response);
parentContext().fireContextError(ex);
receive().subscribe();
return false;
}
return true;
}- 通过设置
clientError = false，第 51 行可以调用Mono#doNext(Consumer)方法，统一订阅处理返回的reactor.ipc.netty.http.client.HttpClientResponse对象。
- 通过设置
-
第 31 行 ：设置 Netty Request 对象的 Header 。
-
-
第 34 至 44 行 ：【TODO 3025】目前是一个 BUG ，在 2.0.X 版本修复。见 FormIntegrationTests#formUrlencodedWorks() 单元测试的注释说明。
-
第 47 至 50 行 ：请求后端的 Http 服务。
- 第 47 行 ：发送请求 Header 。
- 第 48 至 50 行 ：发送请求 Body 。其中中间的
#map(...)的过程为Flux<DataBuffer> => ByteBuffer => Flux<DataBuffer>。
-
--------- 第 51 至 65 行 ：请求后端 Http 服务完成，将 Netty Response 赋值给响应
response。 -
第 53 至 57 行 ：创建
org.springframework.http.HttpHeaders对象，将 Netty Response Header 设置给它，而后设置回给响应response。 -
第 60 行 ：设置响应
response的状态码。 -
第 65 行 ：设置 Netty Response 到
CLIENT_RESPONSE_ATTR。后续 NettyWriteResponseFilter 将 Netty Response 写回给客户端。 -
--------- 第 66 行 ：提交过滤器链继续过滤。
3. NettyWriteResponseFilter
org.springframework.cloud.gateway.filter.NettyWriteResponseFilter ，Netty 回写响应网关过滤器。
#getOrder() 方法，代码如下 ：
public static final int WRITE_RESPONSE_FILTER_ORDER = -1; |
- 返回顺序为
-1。在 《Spring-Cloud-Gateway 源码解析 —— 过滤器 (4.1) 之 GatewayFilter 一览》「3. GlobalFilter」 ，我们列举了所有 GlobalFilter 的顺序。
#filter(ServerWebExchange, GatewayFilterChain) 方法，代码如下 ：
1: |
- 第 5 行 ：调用
#then(Mono)方法，实现 After Filter 逻辑。 - 第 7 至 11 行 ：从
CLIENT_RESPONSE_ATTR中，获得 Netty Response 。 - 第 15 至 21 行 ：将 Netty Response 写回给客户端。因为
org.springframework.http.server.reactive#writeWith(Publisher<? extends DataBuffer>)需要的参数类型是Publisher<? extends DataBuffer>，所以【第 18 至 20 行】的转换过程是ByteBufFlux => Flux<NettyDataBuffer>。- 第 19 行 ：TODO 【3024】ByteBufFlux#retain()
666. 彩蛋
下一篇 《Spring-Cloud-Gateway 源码解析 —— 过滤器 (4.8) 之 WebClientHttpRoutingFilter》 走起！
胖友，分享一波朋友圈可好！