LiteFlow LiteFlow
💒首页
  • v2.11.0(当前版本)
  • What's New

    • What' s New In LiteFlow v2.11.0?
  • 历史版本

    • v2.10.X
    • v2.9.X
    • v2.8.X
    • v2.7.X
    • v2.6.X
  • 升级指南

    • 升级到2.9.3说明
    • 升级到2.9.X说明
    • 升级到2.8.X说明
    • 升级到2.7.X说明
  • 常见问题
  • 专题解释

    • 如何理解上下文这个概念?
    • Slot是一个什么样的概念,在框架中起到什么样的作用?
💖赞助
🧩插件
🔥PPT
  • 项目介绍
  • 项目成员
  • 更新记录
  • 参与开发
👥加入群聊
🧤用户
  • Gitee (opens new window)
  • Github (opens new window)
  • 推荐

    • TLog-轻量级的分布式日志追踪神器 (opens new window)
    • ERD ONLINE-开箱即用的数据库建模、产品版本管理软件 (opens new window)
    • Forest-更轻量、更简单实用的HTTP客户端框架 (opens new window)

广告采用随机轮播方式显示 ❤️成为赞助商
💒首页
  • v2.11.0(当前版本)
  • What's New

    • What' s New In LiteFlow v2.11.0?
  • 历史版本

    • v2.10.X
    • v2.9.X
    • v2.8.X
    • v2.7.X
    • v2.6.X
  • 升级指南

    • 升级到2.9.3说明
    • 升级到2.9.X说明
    • 升级到2.8.X说明
    • 升级到2.7.X说明
  • 常见问题
  • 专题解释

    • 如何理解上下文这个概念?
    • Slot是一个什么样的概念,在框架中起到什么样的作用?
💖赞助
🧩插件
🔥PPT
  • 项目介绍
  • 项目成员
  • 更新记录
  • 参与开发
👥加入群聊
🧤用户
  • Gitee (opens new window)
  • Github (opens new window)
  • 推荐

    • TLog-轻量级的分布式日志追踪神器 (opens new window)
    • ERD ONLINE-开箱即用的数据库建模、产品版本管理软件 (opens new window)
    • Forest-更轻量、更简单实用的HTTP客户端框架 (opens new window)
  • 🍤LiteFlow简介
  • 🍓项目特性
  • 🧁环境支持

    • ☕️JDK支持度
    • 🌿Springboot支持度
    • 🌱Spring的支持度
  • 🍟快速开始(Hello world)

    • 🍄说明
    • 🌿Springboot场景安装运行

      • 🧬依赖
      • ⚙️配置
      • 🛫执行
    • 🌱Spring场景安装运行

      • 🧬依赖
      • ⚙️配置
      • 🛫执行
    • 🌵其他场景安装运行

      • 🍄说明
      • 🧬依赖
      • ⚙️配置
      • 🛫执行
  • 🍢配置项

    • 🍄说明
    • 🌿Springboot下的配置项
    • 🌱Spring下的配置项
    • 🌵其他场景代码设置配置项
  • 🗂规则文件

    • 📔规则文件格式
    • 📕本地规则文件配置
    • 📗ZK规则文件配置源
    • 📘SQL数据库配置源
    • 📋Nacos配置源
    • 🗄Etcd配置源
    • 📜Apollo配置源
    • 📑Redis配置源

      • 配置说明
      • 轮询模式配置
      • 订阅模式配置
        • 工作原理
        • 配置参数
        • 配置说明
        • 存储数据说明
        • 自动刷新
        • 模式优缺点
        • 小例子
    • 📙自定义配置源
  • 🔗常规组件

    • 📎普通组件
    • ✂️选择组件
    • 📌条件组件
    • 🧬次数循环组件
    • ⛓条件循环组件
    • ⌛️迭代循环组件
    • 🧿退出循环组件
  • 🧩EL规则的写法

    • 🍄说明
    • 🌴串行编排
    • 🎋并行编排
    • 🌾选择编排
    • 🌵条件编排
    • 🌳循环编排
    • 🎃捕获异常表达式
    • 🍄与或非表达式
    • 🍁使用子流程
    • 🍂使用子变量
    • 💐复杂编排例子
    • 🌻关于分号
    • 🌰关于注释
    • 🐚组件名包装
    • 🔆验证规则
  • 🌮数据上下文

    • 🍄说明
    • 🌯数据上下文的定义和使用
    • 🪶用初始化好的上下文传入
  • 🛩执行器

    • 🍄说明
    • 🎡执行方法
    • 🎢流程入参
    • 🎈LiteflowResponse对象
  • 🍋脚本组件

    • 🌭脚本语言介绍
    • 🍫脚本语言种类

      • 🥏Groovy脚本引擎
      • 🧀Javascript脚本引擎
      • ☕️Java脚本引擎
      • 🥞QLExpress脚本引擎
      • 🍧Python脚本引擎
      • 🍝Lua脚本引擎
      • 🥐Aviator脚本引擎
    • 🍣脚本与Java进行交互
    • 🍱多脚本语言混合共存
    • 🌯文件脚本的定义
    • 🍘动态刷新脚本
  • 🍇声明式组件

    • 🥭什么叫声明式组件
    • 🧅类级别式声明
    • 🥥方法级别式声明
  • 🎲用代码动态构造规则

    • 🍄说明
    • 🎯如何构造
  • 🎨高级特性

    • 🍒前置和后置组件
    • 🍌本地规则文件监听
    • 🥠替补组件
    • 🍉组件参数
    • 🍑组件别名
    • 🍍组件标签
    • 🥝组件事件回调
    • 🐋组件回滚
    • 🥑隐式子流程
    • 🍕私有投递
    • 🍣组件重试
    • 🥦异步循环模式
    • ⏱️超时控制
    • 🍖平滑热刷新
    • 🍪组件切面
    • 🍡步骤信息
    • 🧊异常
    • 🧇打印信息详解
    • 🧁自定义请求Id
    • 🌭不同格式规则加载
    • 🥗异步线程池自定义
    • 🍿自定义组件执行器
    • 🍥简单监控
    • 🧉XML的DTD
  • ⛱测试用例以及示例

    • 🪁测试用例
    • 🪀DEMO案例
  • 🪂性能表现
  • v2.11.X文档
  • 🗂规则文件
  • 📑Redis配置源
铂赛东
2023-08-28
目录

订阅模式配置

在配置参数中添加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> chainKey = 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> scriptKey = 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

    帮助我们改善此文档 (opens new window)
    上次更新: 2023/08/28, 15:41:39
    轮询模式配置
    📙自定义配置源

    ← 轮询模式配置 📙自定义配置源→

    Theme by Vdoing | Copyright © 2020-2023 铂赛东 | MIT License
    沪ICP备18012955号-2
    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式