RuleGo高性能规则引擎-轻识

RuleGo是一个基于Go语言的轻量级、高性能、嵌入式、可编排组件式规则引擎。也一个灵活配置和高度定制化的事件处理框架。可以对输入消息进行聚合、分发、过滤、转换、丰富、执行各种动作和与第三方系统联动。

特性

轻量级：无外部中间件依赖，既可以下沉到边缘服务器，实现物联网边缘计算解决方案，也可以部署在云端，作为规则引擎服务。
高性能：得益于Go的高性能特性，另外RuleGo采用协程池和对象池等技术。对10W条数据进行JS脚本过滤->JS脚本数据处理->HTTP推送 处理,平均用时9秒。
嵌入式：支持把RuleGo嵌入到现有项目，非入侵式利用其特性。
组件化：所有业务逻辑都是组件，并能灵活配置和重用它们。
规则链：可以灵活地组合和重用不同的组件，实现高度定制化和可扩展性的业务流程。
流程编排：支持对规则链进行动态编排，你可以把业务地封装成RuleGo组件，然后通过搭积木方式实现你高度变化的业务需求。
扩展简单：提供丰富灵活的扩展接口和钩子，如：自定义组件、组件注册管理、规则链DSL解析器、协程池、规则节点消息流入/流出回调、规则链处理结束回调。
动态加载：支持通过Go plugin 动态加载组件和扩展组件。
内置常用组件：消息类型Switch,JavaScript Switch,JavaScript过滤器,JavaScript转换器,HTTP推送，MQTT推送，发送邮件，日志记录 等组件。可以自行扩展其他组件。
上下文隔离机制：可靠的上下文隔离机制，无需担心高并发情况下的数据串流。

使用场景

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

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

典型使用场景

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

安装

使用go get命令安装RuleGo：

go get github.com/rulego/rulego

使用

使用Json格式定义规则链DSL：

{
  "ruleChain": {
    "name": "测试规则链",
    "root": true
  },
  "metadata": {
    "nodes": [
      {
        "id": "s1",
        "type": "jsFilter",
        "name": "过滤",
        "debugMode": true,
        "configuration": {
          "jsScript": "return msg!='bb';"
        }
      },
      {
        "id": "s2",
        "type": "jsTransform",
        "name": "转换",
        "debugMode": true,
        "configuration": {
          "jsScript": "metadata['test']='test02';\\\\n metadata['index']=50;\\\\n msgType='TEST_MSG_TYPE2';\\\\n var msg2=JSON.parse(msg);\\\\n msg2['aa']=66;\\\\n return {'msg':msg2,'metadata':metadata,'msgType':msgType};"
        }
      },
      {
        "id": "s3",
        "type": "restApiCall",
        "name": "推送数据",
        "debugMode": true,
        "configuration": {
          "restEndpointUrlPattern": "http://192.168.216.21:9099/api/socket/msg",
          "requestMethod": "POST",
          "maxParallelRequestsCount": 200
        }
      }
    ],
    "connections": [
      {
        "fromId": "s1",
        "toId": "s2",
        "type": "True"
      },
      {
        "fromId": "s2",
        "toId": "s3",
        "type": "Success"
      }
    ],
    "ruleChainConnections": null
  }
}

导入RuleGo包并创建一个规则引擎实例：

import "github.com/rulego/rulego"

//创建一个规则引擎实例，每个规则引擎实例有且只有一个根规则链
ruleEngine, err := rulego.New("rule01", []byte(ruleFile))

把消息、消息类型、消息元数据交给规则引擎实例处理：

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

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

//需要得到结束回调的调用方式
ruleEngine.OnMsgWithOptions(msg,types.WithEndFunc(func(msg types.RuleMsg, err error) {
//规则链异步回调结果 
//注意：规则链如果有多个分支结束点，会调用多次
}))

//带context.Context的调用方式,用于不同组件实例共享数据
ruleEngine.OnMsgWithOptions(msg,types.WithContext(context.WithValue(context.Background(), "shareKey", "shareValue")))

支持规则链类型：

顺序执行：

异步+顺序执行：

使用子规则链方式：

一些复杂例子：

源代码/文档：

Gitee

Github