rulego

环境要求

• 本机已安装 Go 语言环境，可正常执行 go 命令
• 一个使用 Go Modules 的 Go 项目（用于嵌入 RuleGo）
• 能访问 GitHub 拉取 github.com/rulego/rulego 依赖（网络通畅或已配置模块代理）
• 一个可用的规则链 JSON 定义文件（可参考 README 中的示例）

安装与启动步骤

1. 1初始化 Go 项目

   在项目目录下初始化 Go 模块，已有 go.mod 的项目可跳过这一步，直接执行依赖安装。

   go mod init example.com/myapp

   复制

2. 2拉取 RuleGo 依赖

   README 给出的唯一安装命令，使用 go get 把 RuleGo 作为库引入当前项目。

   go get github.com/rulego/rulego

   复制

3. 3准备规则链 JSON

   用 JSON 定义规则链 DSL，描述组件及连接关系；可参考示例文件 chain_call_rest_api.json 和官方 DSL 文档。

4. 4创建规则引擎实例

   导入 rulego 包，加载规则链文件，并用唯一 ID 创建规则引擎实例，注意处理返回的 err。

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

   复制

5. 5提交消息处理

   构造元数据、消息负载与消息类型，交给规则引擎，它会按规则链定义自动处理。

   // 定义消息元数据
   metaData := types.NewMetadata()
   metaData.PutValue("productType", "test01")
   // 定义消息负载和消息类型
   msg := types.NewMsg(0, "TELEMETRY_MSG", types.JSON, metaData, "{"temperature":35}")
   
   // 把消息交给规则引擎处理
   ruleEngine.OnMsg(msg)

   复制

关键配置

如何确认成功

调用 ruleEngine.OnMsg(msg) 无报错，且规则链中的下游组件按定义收到并处理了该消息，即表示运行成功。

常见问题

注意事项

• README 只提供了 go get 这一条安装命令，项目以库形式嵌入使用，没有给出独立部署的命令行或 Docker 命令。
• 支持嵌入现有应用（Embedded）和独立部署（Standalone）两种模式，Standalone 模式可对外提供规则引擎与编排服务。
• 内置大量通用组件，并兼容 MCP 协议，可作为 MCP 客户端或服务端使用。
• 规则链运行示例可参考官方演示地址 http://8.134.32.225:9090/ui/ 与官网 https://rulego.cc。