soul 网关(十六):RateLimiter 插件解析

前言

上文粗略的讲了限流和熔断的能解决什么问题,使用场景是什么。本文主要讲述 RateLimiter 插件的配置使用和解析,以单体 redis 为例进行讲解。 根据官网文档来看, RateLimiter 是基于令牌桶实现的。

操作流程

配置

1、 进入 admin 控制台,在菜单 "System Manage => Plugin" 中配置 rate_limiter。操作如下图所示:

操作步骤

这里 redis 的配置是需要注意的,当这里配置错误时,或者 redis 没有启动时,虽然会匹配到 RateLimiter 插件,但实际是不起作用的。

  1. 增加 Seletor 和 Rule, 步骤如下图所示:
    增加 Seletor:


    增加seletor

增加 Rule


增加Rule

Handler 中有两个参数:

  • capacity: 令牌桶的容量。
  • rate: 令牌的刷新速率,即每秒产生多少个令牌。

验证配置

  1. 启动 soul-examples 中的 soul-examples-http
  2. 启动 postman, 利用 runner 查看请求情况。
    增加测试


    增加测试

启动 runner


输入连接
  1. 设置并发数 (Iterations)为 50,


    测试结果

源码解析

admin 数据发生变更

  1. 当插件信息发生变更时,BootStrap 中接口 PluginDataSubscriber 有订阅到了信息的变更,它的实现 CommonPluginDataSubscriber, 由该类中 subscribeDataHandler 的方法,进入到 RateLimiterPluginDataHandler 逻辑中。
 private <T> void subscribeDataHandler(final T classData, final DataEventTypeEnum dataType) {
        Optional.ofNullable(classData).ifPresent(data -> {
            if (data instanceof PluginData) {
                PluginData pluginData = (PluginData) data;
                if (dataType == DataEventTypeEnum.UPDATE) {
                    BaseDataCache.getInstance().cachePluginData(pluginData);
                // pluginData.getName()  == rate_limite
                    Optional.ofNullable(handlerMap.get(pluginData.getName())).ifPresent(handler -> handler.handlerPlugin(pluginData));
                }
                ... 
            }
            ...
        });
    }
  1. 进入 RateLimiterPluginDataHandler 的 handlerPlugin 中,看到 createLettuceConnectionFactory 方法,进入该方法,发现这里是根据之前 admin 的配置生成相应的 LettuceConnectionFactory 的连接池,由于之前是 单机模式, 则这里就采用了 redisStandaloneConfiguration
 public void handlerPlugin(final PluginData pluginData) {
        if (Objects.nonNull(pluginData) && pluginData.getEnabled()) {
             ...
            //spring data redisTemplate
            if (Objects.isNull(Singleton.INST.get(ReactiveRedisTemplate.class))
                    || Objects.isNull(Singleton.INST.get(RateLimiterConfig.class))
                    || !rateLimiterConfig.equals(Singleton.INST.get(RateLimiterConfig.class))) {
                LettuceConnectionFactory lettuceConnectionFactory = createLettuceConnectionFactory(rateLimiterConfig);
...
                //  创建 reactiveRedisTemplate, 模板中加载了 redis 的 lua 脚本
                ReactiveRedisTemplate<String, String> reactiveRedisTemplate = new SoulReactiveRedisTemplate<>(lettuceConnectionFactory, serializationContext);
                Singleton.INST.single(ReactiveRedisTemplate.class, reactiveRedisTemplate);
                Singleton.INST.single(RateLimiterConfig.class, rateLimiterConfig);
            }
        }
    }

访问相应链接

  1. 当访问链接 localhost:9195/http/test/findByUserId?userId=1 时,从终端的日志看到
2021-02-04 17:26:23.341  INFO 12552 --- [-work-threads-1] o.d.soul.plugin.base.AbstractSoulPlugin  : rate_limiter selector success match , selector name :测试1
2021-02-04 17:26:23.343  INFO 12552 --- [-work-threads-1] o.d.soul.plugin.base.AbstractSoulPlugin  : rate_limiter rule success match , rule name :test22222

由此我们可知进入到了 RateLimiterPlugin 中。 查看 doExecute 方法中有 isAllowed 的判断,而 isAllowed 中利用 ReactiveRedisTemplate 执行 lua 脚本实现的令牌桶,来判断。

总结

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

推荐阅读更多精彩内容