在配置参数中添加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
    #下面两项可以选配(2.12.2+支持)
    connectionPoolSize: 2
    connectionMinimumIdleSize: 4
    #下面的几项必须配置
    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的格式为：规则ID[:是否启用]，其中方括号内的为可选项，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，推荐采用订阅模式。

脚本key的语言配置

如果你只依赖了一种脚本语言插件包，那么语言这项是不需要配置的。会自动识别的。如果你配置了多语言脚本，那么脚本语言这一项，是必须要写的。

比如s1:boolean_script:布尔脚本s1:js。

关于脚本的多语言共存，请参考多脚本语言混合共存这一章。

规则的启用关闭和脚本启用关闭v2.12.0+

LiteFlow也支持在Etcd节点上保留数据的同时关闭和启动规则/脚本。

之前说到规则的key的固定格式为规则ID[:是否启用]，如果配置chain1:false，那么这个规则就是关闭状态。相当于逻辑删除。

当然如果你只是配置key为chain1，那么等价于chain1:true。

对于脚本key来说，固定格式为脚本组件ID:脚本类型[:脚本名称:脚本语言:是否启用]，如果配置s1:script:脚本s1:groovy:false，那么这个脚本就是关闭状态，相当于逻辑删除。

如果不配置最后一项，比如s1:script:脚本s1:groovy，那么等价于s1:script:脚本s1:groovy:true。

提示

对于规则key或者脚本key来说，一定要以冒号为分隔符对应好位置，如果你想配置是否启动，那么是在第5项，前面4项就必须要写，如果你写成s1:script:脚本s1:false那将会报错。

小例子

为了让大家能简单上手Redis规则文件的配置和运行，这里有一个小demo，大家可以拉到本地来运行，需要你替换Redis的配置信息。

运行项目前，先读项目里的readme.txt文件。

https://github.com/bryan31/liteflow-ext-rule-demo