订阅模式配置
在配置参数中添加mode:sub
,可将规则刷新机制选为订阅模式。
# 工作原理
订阅模式基于Pub/Sub机制,依赖于Redisson中RMapCache结构的监听功能。
考虑到轮询模式无法保证规则刷新的实时性,因此提供订阅模式的刷新机制,即客户端修改数据后发送一个事件,LiteFlow订阅到该事件后进行数据刷新。
基于Pub/Sub机制,若采用Redis原生Hash结构,则修改数据方需要增加额外的开发成本来发送事件。 为降低用户修改规则的开发成本,Redis配置源的订阅模式选择采用Redisson的RMapCache结构。
RMapCache可看作自带监听功能的Redis Hash结构,其底层通过创建额外的Key和Lua脚本,自动使用Pub/Sub来实现监听机制。
需要注意的是,由于Redisson对RMapCache结构中的field和value进行了改动,并非纯文本。故对数据的读取和修改均只能使用Redisson客户端进行。
# 配置参数
Redis配置源支持单点和哨兵两种模式。订阅模式下配置参数如下:
liteflow:
rule-source-ext-data-map:
#单点模式配置如下两项
host: 127.0.0.1
port: 6379
#哨兵模式配置如下三项
redisMode: sentinel
masterName: mymaster
sentinelAddress: [127.0.0.1:26389, 127.0.0.1:26379]
#如果你没有用户名或密码可以不配置
username: root
password: 123456
mode: sub
chainDataBase: 1
chainKey: chainKey
#如果你没有脚本组件,以下可以不配置
scriptDataBase: 1
scriptKey: scriptKey
liteflow.rule-source-ext-data={\
\# 单点模式配置如下两项\
"host":"127.0.0.1",\
"port":6379,\
\# 哨兵模式配置如下三项\
"redisMode":"sentinel",\
"masterName":"mymaster",\
"sentinelAddress":["127.0.0.1:26389","127.0.0.1:26379"],\
"username":"root",\
"password":"123456",\
"mode":"sub",\
"chainDataBase":1,\
"chainKey":"chainKey",\
"scriptDataBase":1,\
"scriptKey":"scriptKey"\
}
// Make sure to add code blocks to your code group
# 配置说明
配置项 | 说明 |
---|---|
redisMode | Redis模式,single为单点,sentinel为哨兵,默认为单点 |
host | 单点模式Redis连接IP地址 |
port | 单点模式Redis连接端口号 |
masterName | 哨兵模式主节点名 |
sentinelAddress | 哨兵模式哨兵节点连接地址 ip:port |
username | Redis的用户名 (Redis 6.0及以上) |
password | Redis的密码 |
mode | 规则刷新模式,poll为轮询,sub/subscribe为订阅,默认为轮询 |
chainDataBase | 规则数据的数据库号 |
chainKey | 规则数据的Redis key名 |
scriptDataBase | 脚本组件的数据库号 |
scriptKey | 脚本组件的Redis key名 |
# 存储数据说明
提示
在订阅模式中,规则和脚本数据均以Redisson RMapCache结构存储,配置项chainKey
和scriptKey
即为该RMapCache的名字。
对于规则来说,你需要使用Redisson客户端,为规则单独创建一个RMapCache类型的数据,这个结构内的每个键值对就是一个规则,RMapCache内的key为chainId,value为单纯的EL(THEN(a,b,c)
)。
假设你的规则RMapCache数据键名为:chains
,那么利用Redisson客户端的数据操作如下:
RMapCache<String, String> chains = redissonClient.getMapCache("chains");
chains.put("chain1", "THEN(a, b, c);");
chains.put("chain2", "IF(x, b).ELIF(y, c).ELSE(d);");
对于脚本来说,RMapCache中的key有固定格式:脚本组件ID:脚本类型:脚本名称[:脚本语言]
,value为脚本数据。
假设你的脚本RMapCache数据键名为:scripts
,那么利用Redisson客户端的数据操作如下:
RMapCache<String, String> scripts = redissonClient.getMapCache("scripts");
scripts.put("s1:script:脚本组件1", "defaultContext.setData(\"test1\",\"hello\");");
scripts.put("s2:script:脚本组件2:js", "defaultContext.setData(\"test2\",\"hello\");");
关于脚本类型,可以参照定义脚本组件这一章节。
# 自动刷新
使用了此Redis配置源插件的订阅模式,凡是在配置的RMapCache对象内的数据改动,会自动推送到业务系统,进行实时的平滑热刷新,你无需做任何事情。
# 模式优缺点
根据工作原理,订阅模式有如下优势和局限性:
【优势】
- 数据刷新实时性高;
- 能够做到按需刷新,不产生额外的通知成本;
- 监听性能较高。
【劣势】
- 基于独有数据结构,Redis客户端只能使用Redisson。
如果对数据数据延迟容忍度低,希望保证实时性,且接受使用Redisson,推荐采用订阅模式。
# 小例子
为了让大家能简单上手Redis规则文件的配置和运行,这里有一个小demo,大家可以拉到本地来运行,需要你替换Redis的配置信息。
运行项目前,先读项目里的readme.txt
文件。
https://github.com/bryan31/liteflow-ext-rule-demo