Spring Cloud Gateway Filter 执行原理刨析

准备工作

需要了解响应式编程,推荐阅读

版本

Spring Cloud Gateway:2.2.3.RELEASE

本文目标

了解 Gateway Filter 内部执行原理

问题:

@Component
public class TestGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("start");
        Mono<Void> mono = chain.filter(exchange);
        log.info("end")
        return mono;
    }

    @Override
    public int getOrder() {
        return 1;
    }
}

我编写了一个 TestGlobalFilter,下一个 Filter 的逻辑是输出日志 HelloWorld。日志中输出的顺序会是什么样?

正确答案是

start
end
HelloWorld

如果按照 Servlet 的开发思想,调用 chain.filter 一定会立刻执行下一个 Filter,Gateway 为什么不可以呢?

因为 chain.filter 的返回值是 Mono,必须要有订阅者调用 subscribe 后才会执行发布者逻辑

DefaultGatewayFilterChain

我们来看下 DefaultGatewayFilterChain 的代码

DefaultGatewayFilterChain

DefaultGatewayFilterChain 返回的是一个 MonoDefer。其内部包含了调用下一个 Filter 的内部函数,那么这个逻辑怎样才能触发的呢?下面继续来看 MonoDefer 的源码

MonoDefer

MonoDefer

MonoDefer subscribe 逻辑如下

  • 调用 supplier.get(),执行内部函数的命令式代码,执行结束后,内部函数会返回一个 Mono
  • p.subscribe(actual); 订阅内部函数返回的 Mono

supplier.get() 抛出异常时,首先向订阅者传递一个空的 Subscription,然后再传递异常

Operators.error

MonoDefer 虽然也是发布者,但是他只是在真正的发布者和订阅者之间做一个承载的作用

过滤器链刨析

在理解了上述两个类之后,我们现在可以梳理一下 Gateway 过滤器链的执行逻辑了

虽然从 Gateway 接收到请求到过滤器链中间还会经历很多步骤,这里我们为了方便理解,直接把过滤器链的调用方,抽象为一个订阅者(因为最终过滤器链会返回一个 Publisher)

除此之外,再简化一下 Filter 的返回值。正常来说 Filter 可以返回任何响应式的发布者逻辑,我们这里简化为每个 Filter 都返回 chain.filter (将最简单的流程理解后,其实复杂的响应式返回也是大同小异)

  1. 订阅者请求 First Filter,这里首先会执行 filter 方法中所有的命令式的代码(响应式的代码并不会执行,因为 Mono 并没有被消费)

  2. 订阅者调用 Filter 返回的 MonoDefer 的 subscribe 方法。MonoDefer 被订阅时首先会执行内部函数。如果还有下一个过滤器,则执行并返回 nextFilter.filter,如果所有过滤器都已执行完毕则返回 Mono.empty(对应 MonoDefer 的 44 行)

  3. nextFilter.filter 先执行 filter 方法中所有的命令式的代码,然后返回 chain.filter

  4. First Filter 返回的 MonoDefer 内部会去订阅 nextFilter.filter 返回的 Mono(对应 MonoDefer 的 52 行)。Second MonoDefer(nextFilter.filter 的返回值)被订阅,接下来就是重复步骤 2 的逻辑,无限套娃下去直到所有 Filter 执行完毕...

下面用一张图来解释一下上面的逻辑

通过上述的图文讲解,我们可以看到响应式编程中一个过滤器链该怎么设计和实现

回到问题

回到最开始的问题,如果想在 Spring Cloud Gateway 中实现先执行过滤器链再执行某某操作,应该怎么写呢?

@Slf4j
@Component
public class LogFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("hello");
        return chain.filter(exchange)
                .then(Mono.defer(() -> {
                    log.info("world");
                    return Mono.empty();
                }));
    }

    @Override
    public int getOrder() {
        return -9;
    }
}

Mono.then 的作用就是内部消费并忽略第一个 Mono(但是 Error 信号会被传递下去),然后入参的 Mono 作为生产者向下游传播数据。

忽略了 chain.filter 返回的 Mono 不会造成问题吗?当然不会,Gateway 的 Filter 链的订阅者并不需要我们传递什么数据,我们只需要将所有过滤器代码执行完即可

最后

如果觉得我的文章对你有帮助,动动小手点下喜欢和关注,你的支持是对我最大的帮助

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342

推荐阅读更多精彩内容