Skip to content

网关架构

最后更新时间:2026-01-22

概述

  • 单个长连接 Gateway 拥有所有消息传递接口(通过 Baileys 的 WhatsApp、通过 grammY 的 Telegram、Slack、Discord、Signal、iMessage、WebChat)。
  • 控制平面客户端(macOS 应用、CLI、Web UI、自动化)通过配置的绑定主机(默认为 127.0.0.1:18789)上的 WebSocket 连接到 Gateway。
  • Nodes(macOS/iOS/Android/无头节点)也通过 WebSocket 连接,但使用明确的能力/命令声明 role: node
  • 每个主机一个 Gateway;它是唯一打开 WhatsApp 会话的地方。
  • canvas host(默认为 18793)提供代理可编辑的 HTML 和 A2UI。

组件和流程

Gateway(守护进程)

  • 维护提供商连接。
  • 公开类型化的 WS API(请求、响应、服务器推送事件)。
  • 根据 JSON Schema 验证入站帧。
  • 发出事件,如 agentchatpresencehealthheartbeatcron

客户端(mac 应用 / CLI / web 管理)

  • 每个客户端一个 WS 连接。
  • 发送请求(healthstatussendagentsystem-presence)。
  • 订阅事件(tickagentpresenceshutdown)。

Nodes(macOS / iOS / Android / 无头节点)

  • 使用 role: node 连接到 相同的 WS 服务器
  • connect 中提供设备身份;配对是 基于设备的(角色 node),批准存储在设备配对存储中。
  • 公开命令,如 canvas.*camera.*screen.recordlocation.get

协议详情:

WebChat

  • 使用 Gateway WS API 获取聊天历史和发送消息的静态 UI。
  • 在远程设置中,通过与其他客户端相同的 SSH/Tailscale 隧道连接。

连接生命周期(单个客户端)

Client                    Gateway
  |                          |
  |---- req:connect -------->|
  |<------ res (ok) ---------|   (or res error + close)
  |   (payload=hello-ok carries snapshot: presence + health)
  |                          |
  |<------ event:presence ---|
  |<------ event:tick -------|
  |                          |
  |------- req:agent ------->|
  |<------ res:agent --------|   (ack: {runId,status:"accepted"})
  |<------ event:agent ------|   (streaming)
  |<------ res:agent --------|   (final: {runId,status,summary})
  |                          |

传输协议(摘要)

  • 传输:WebSocket,带有 JSON 负载的文本帧。
  • 第一帧 必须connect
  • 握手后:
    • 请求:{type:"req", id, method, params}{type:"res", id, ok, payload|error}
    • 事件:{type:"event", event, payload, seq?, stateVersion?}
  • 如果设置了 OPENCLAW_GATEWAY_TOKEN(或 --token),connect.params.auth.token 必须匹配,否则套接字关闭。
  • 对于有副作用的方法(sendagent),需要幂等性键以安全重试;服务器保留短期去重缓存。
  • Nodes 必须在 connect 中包含 role: "node" 以及能力/命令/权限。

配对 + 本地信任

  • 所有 WS 客户端(操作者 + nodes)在 connect 上包含 设备身份
  • 新设备 ID 需要配对批准;Gateway 为后续连接颁发 设备令牌
  • 本地 连接(环回或网关主机自己的 tailnet 地址)可以自动批准,以保持同主机 UX 流畅。
  • 非本地 连接必须签署 connect.challenge nonce 并需要明确批准。
  • Gateway 认证(gateway.auth.*)仍适用于 所有 连接,无论是本地还是远程。

详情:网关协议配对安全性

协议类型和代码生成

  • TypeBox schemas 定义协议。
  • 从这些 schemas 生成 JSON Schema。
  • 从 JSON Schema 生成 Swift 模型。

远程访问

  • 首选:Tailscale 或 VPN。
  • 替代方案:SSH 隧道
    bash
    ssh -N -L 18789:127.0.0.1:18789 user@host
  • 相同的握手 + 认证令牌通过隧道应用。
  • 对于远程设置中的 WS,可以启用 TLS + 可选固定。

操作快照

  • 启动:openclaw gateway(前台,日志输出到 stdout)。
  • 健康检查:通过 WS 的 health(也包含在 hello-ok 中)。
  • 监督:launchd/systemd 用于自动重启。

不变量

  • 每个主机恰好一个 Gateway 控制单个 Baileys 会话。
  • 握手是强制性的;任何非 JSON 或非连接的第一帧都会硬关闭。
  • 事件不会重放;客户端必须在间隙时刷新。