RuleGo

English| 简体中文

官网 | 文档 | 贡献指南

RuleGo是一个基于Go语言的轻量级、高性能、嵌入式、新一代组件编排规则引擎。它可以帮助你快速构建低耦合、灵活的系统，实时响应和调整业务需求变更。

RuleGo 还提供大量可复用的组件，支持对数据进行聚合、过滤、分发、转换、丰富和执行各种动作，也能和各种协议、系统进行联动和集成。 它在低代码、业务代码编排、数据集成、工作流、大模型智能体、边缘计算、自动化、IoT等多种场景具有广泛的应用潜力。

您的鼓励是我们前进的动力。如果这个项目对您有帮助，请右上角点个Star吧。

特性

• 轻量级： 无外部中间件依赖，在低成本设备中也能高效对数据进行处理和联动，适用于物联网边缘计算。
• 高性能： 得益于Go的高性能特性，另外RuleGo采用协程池和对象池等技术。
• 双模式： 嵌入式和独立部署模式，支持把RuleGo嵌入到现有应用中，作为一个内部组件运行。也可以作为中间件独立部署，提供规则引擎以及编排服务。
• 组件化： 所有业务逻辑都是组件，并能灵活配置和重用它们。
• 规则链： 可以灵活地组合和重用不同的组件，实现高度定制化和可扩展性的业务流程。
• 流程编排： 支持对规则链组件进行动态编排，不重启应用情况下，替换或者新增业务逻辑。
• 扩展简单： 提供丰富灵活的扩展接口，可以很容易地实现自定义组件或者引入第三方组件。
• 动态加载： 支持通过Go plugin 动态加载组件和扩展组件。
• 规则链嵌套： 支持子规则链嵌套，实现流程复用。
• 内置大量组件： 消息路由,脚本转换,过滤器,gRPC,HTTP,MQTT,发送邮件,数据库操作 等组件。可以自行扩展其他组件。
• 上下文隔离机制： 可靠的上下文隔离机制，无需担心高并发情况下的数据串流。
• AOP机制： 允许在不修改规则链或节点的原有逻辑的情况下，对规则链的执行添加额外的行为，或者直接替换原规则链或者节点逻辑。
• 数据集成： 允许动态配置Endpoint，例如：HTTP Endpoint，MQTT Endpoint，TCP/UDP Endpoint，UDP Endpoint，Kafka Endpoint，Schedule Endpoint等。

使用场景

RuleGo是一款编排式的规则引擎，最擅长去解耦你的系统。

• 如果你的系统业务复杂，并且代码臃肿不堪
• 如果你的业务场景高度定制化或者经常变动
• 如果你的系统需要对接大量的第三方应用或者协议
• 或者需要端对端的物联网解决方案
• 或者边缘计算场景
• 或者需要对异构系统数据集中处理
• 或者你想尝试在Go语言实现热部署......
  那RuleGo框架会是一个非常好的解决方案。

典型使用场景

• 边缘计算： 可以在边缘服务器部署RuleGo，对数据进行预处理，筛选、聚合或者计算后再上报到云端。数据的处理规则和分发规则可以通过规则链动态配置和修改，而不需要重启系统。类似node-red系统
• 物联网： 收集设备数据上报，经过规则链的规则判断，触发一个或者多个动作，例如：发邮件、发告警、和其他设备或者系统联动。
• 数据分发： 可以根据不同的消息类型，调用HTTP、MQTT或者gRPC把数据分发到不同系统。
• 应用集成： 把RuleGo当做胶水连接各种系统或者协议，例如：ssh、webhook、kafka、消息队列、数据库、chatGPT、第三方应用系统。
• 异构系统数据集中处理： 从不同的数据源（如 MQTT、HTTP、WS、TCP/UDP 等）接收数据，然后对数据进行过滤、格式转换、然后分发到数据库、业务系统或者仪表板。
• 高度定制化业务： 把高度定制化或者经常变化的业务解耦出来，交给RuleGo规则链进行管理。业务需求变化而不需要重启主程序。
• 复杂业务编排： 把业务封装成自定义组件，通过RuleGo编排和驱动这些自定义的组件，业务逻辑并支持动态调整和替换。
• 微服务编排： 通过RuleGo编排和驱动微服务，或者动态调用第三方服务处理业务，并返回结果。
• 业务代码和业务逻辑解耦： 例如：用户积分计算系统、风控系统。
• 自动化： 例如：CI/CD系统、流程自动化系统、营销自动化系统。
• 低代码： 例如：低代码平台、iPaaS系统、ETL、类LangFlow系统（对接大模型提取用户意图，然后触发规则链与其他系统进行联动或者进行业务处理）。

架构图

RuleGo架构图

规则链运行示例图

更多运行模式

安装

使用go get命令安装RuleGo：

go get github.com/rulego/rulego

或者使用gitee/gitcode源

go get gitee.com/rulego/rulego
#or 
go get gitcode.com/rulego/rulego

使用

RuleGo 使用很简单。只需以下3步：

1. 使用JSON定义规则链：

• 规则链DSL文档
• example_chain.json

2. 导入RuleGo包，并使用规则链定义，创建一个规则引擎实例：

import "github.com/rulego/rulego"
//加载规则链定义文件
ruleFile := fs.LoadFile("chain_call_rest_api.json")
//使用规则链定义，创建一个规则引擎实例
ruleEngine, err := rulego.New("rule01", ruleFile)

3. 把消息负荷、消息类型、消息元数据交给规则引擎实例处理，然后规则引擎就会根据规则链的定义处理消息：

//定义消息元数据
metaData := types.NewMetadata()
metaData.PutValue("productType", "test01")
//定义消息负荷和消息类型
msg := types.NewMsg(0, "TELEMETRY_MSG", types.JSON, metaData, "{\"temperature\":35}")

//把消息交给规则引擎处理
ruleEngine.OnMsg(msg)

可以在不重启应用的情况下实时更新规则链逻辑

规则引擎管理API

• 动态更新规则链

//动态更新规则链逻辑
err := ruleEngine.ReloadSelf(ruleFile)
//更新规则链下某个节点
ruleEngine.ReloadChild("node01", nodeFile)
//获取规则链定义
ruleEngine.DSL()

• 规则引擎实例管理：

//加载文件夹所有规则链定义到规则引擎池
rulego.Load("/rules", rulego.WithConfig(config))
//通过ID获取已经创建的规则引擎实例
ruleEngine, ok := rulego.Get("rule01")
//删除已经创建的规则引擎实例
rulego.Del("rule01")

• 配置：文档

//创建一个默认的配置
config := rulego.NewConfig()
//调试节点回调，节点配置必须配置debugMode:true 才会触发调用
//节点入和出信息都会调用该回调函数
config.OnDebug = func (chainId,flowType string, nodeId string, msg types.RuleMsg, relationType string, err error) {
}
//使用配置
ruleEngine, err := rulego.New("rule01", []byte(ruleFile), rulego.WithConfig(config))

规则链定义

规则链定义DSL

规则链节点组件

RuleGo 的核心特性是组件化，所有业务逻辑都是组件，并能灵活配置和重用它们。目前RuleGo 已经内置了大量常用的组件。

• 标准组件
• rulego-components :文档
• rulego-components-ai
• rulego-components-ci
• rulego-components-iot
• 自定义节点组件示例 :文档

数据集成

RuleGo 提供Endpoint规则引擎输入端模块，对异构系统进行统一的数据接入和集成。详细参考： Endpoint

Endpoint组件

• Endpoint组件
• Endpoint DSL

RuleGo-Server

我们提供了一个基于RuleGo的开箱即用规则引擎服务：RuleGo-Server ， 以及配套的前端可视化编辑器：RuleGo-Editor 。 RuleGo-Server 可以作为一个独立部署的中间件，提供规则链管理、调试、部署，以及节点组件管理等操作。

性能

RuleGo 大部分工作都在初始化时完成，执行规则链时几乎不会额外增加系统开销，资源占用极低，特别适合在边缘服务器运行。 另外RuleGo使用有向无环图来表示规则链，每个输入消息只需要沿着图中的路径进行处理，无需匹配所有的规则， 这大大提高了消息处理和路由的效率，也节省了系统资源。

性能测试用例：

机器：树莓派2(900MHz Cortex-A7*4,1GB LPDDR2)  
数据大小：260B   
规则链：JS脚本过滤->JS复杂转换->HTTP推送   
测试结果：100并发和500并发，内存占用变化不大都在19M左右

更多性能测试用例

生态

• RuleGo-Editor ：规则链可视化编辑器
• RuleGo-Server ：RuleGo Server
• rulego-components ：扩展组件库
• rulego-components-ai ：AI场景组件库
• rulego-components-ci ：CI/CD场景组件库
• rulego-components-iot ：IoT场景组件库

贡献

欢迎任何形式的贡献，包括提交问题、建议、文档、测试或代码。贡献指南

交流群

QQ群号：720103251

微信(加好友拉入群)：rulegoteam

许可

RuleGo使用Apache 2.0许可证，详情请参见LICENSE文件。