shutdown<\/code><\/td>\n| \u670d\u52a1\u5668\u63a8\u9001<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n \u6743\u5a01\u5217\u8868\u5728 src\/gateway\/server.ts<\/code>\uff08METHODS<\/code>\u3001EVENTS<\/code>\uff09\u4e2d\u3002<\/p>\n\u6a21\u5f0f\u6240\u5728\u4f4d\u7f6e<\/h2>\n\n- \u6e90\u7801\uff1a
src\/gateway\/protocol\/schema.ts<\/code><\/li>\n- \u8fd0\u884c\u65f6\u9a8c\u8bc1\u5668\uff08AJV\uff09\uff1a
src\/gateway\/protocol\/index.ts<\/code><\/li>\n- \u670d\u52a1\u5668\u63e1\u624b + \u65b9\u6cd5\u5206\u53d1\uff1a
src\/gateway\/server.ts<\/code><\/li>\n- \u8282\u70b9\u5ba2\u6237\u7aef\uff1a
src\/gateway\/client.ts<\/code><\/li>\n- \u751f\u6210\u7684 JSON Schema\uff1a
dist\/protocol.schema.json<\/code><\/li>\n- \u751f\u6210\u7684 Swift \u6a21\u578b\uff1a
apps\/macos\/Sources\/OpenClawProtocol\/GatewayModels.swift<\/code><\/li>\n<\/ul>\n\u5f53\u524d\u6d41\u7a0b<\/h2>\n\npnpm protocol:gen<\/code><\/li>\n- \u5c06 JSON Schema\uff08draft\u201107\uff09\u5199\u5165
dist\/protocol.schema.json<\/code><\/li>\npnpm protocol:gen:swift<\/code><\/li>\n- \u751f\u6210 Swift Gateway \u7f51\u5173\u6a21\u578b<\/li>\n
pnpm protocol:check<\/code><\/li>\n- \u8fd0\u884c\u4e24\u4e2a\u751f\u6210\u5668\u5e76\u9a8c\u8bc1\u8f93\u51fa\u5df2\u63d0\u4ea4<\/li>\n<\/ul>\n
\u6a21\u5f0f\u5728\u8fd0\u884c\u65f6\u7684\u4f7f\u7528\u65b9\u5f0f<\/h2>\n\n- \u670d\u52a1\u5668\u7aef<\/strong>\uff1a\u6bcf\u4e2a\u5165\u7ad9\u5e27\u90fd\u7528 AJV \u9a8c\u8bc1\u3002\u63e1\u624b\u4ec5\u63a5\u53d7\u53c2\u6570\u5339\u914d
ConnectParams<\/code> \u7684 connect<\/code> \u8bf7\u6c42\u3002<\/li>\n- \u5ba2\u6237\u7aef<\/strong>\uff1aJS \u5ba2\u6237\u7aef\u5728\u4f7f\u7528\u4e4b\u524d\u9a8c\u8bc1\u4e8b\u4ef6\u548c\u54cd\u5e94\u5e27\u3002<\/li>\n
- \u65b9\u6cd5\u8868\u9762<\/strong>\uff1aGateway \u7f51\u5173\u5728
hello-ok<\/code> \u4e2d\u516c\u5e03\u652f\u6301\u7684 methods<\/code> \u548c events<\/code>\u3002<\/li>\n<\/ul>\n\u793a\u4f8b\u5e27<\/h2>\nConnect\uff08\u7b2c\u4e00\u6761\u6d88\u606f\uff09\uff1a<\/p>\n “`json theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
\n{
\n “type”: “req”,
\n “id”: “c1”,
\n “method”: “connect”,
\n “params”: {
\n “minProtocol”: 2,
\n “maxProtocol”: 2,
\n “client”: {
\n “id”: “openclaw-macos”,
\n “displayName”: “macos”,
\n “version”: “1.0.0”,
\n “platform”: “macos 15.1”,
\n “mode”: “ui”,
\n “instanceId”: “A1B2”
\n }
\n }
\n}<\/p>\n \nHello-ok \u54cd\u5e94\uff1a\n\n```json theme={"theme":{"light":"min-light","dark":"min-dark"}}\n{\n "type": "res",\n "id": "c1",\n "ok": true,\n "payload": {\n "type": "hello-ok",\n "protocol": 2,\n "server": { "version": "dev", "connId": "ws-1" },\n "features": { "methods": ["health"], "events": ["tick"] },\n "snapshot": {\n "presence": [],\n "health": {},\n "stateVersion": { "presence": 0, "health": 0 },\n "uptimeMs": 0\n },\n "policy": { "maxPayload": 1048576, "maxBufferedBytes": 1048576, "tickIntervalMs": 30000 }\n }\n}\n<\/code><\/pre>\n\u8bf7\u6c42 + \u54cd\u5e94\uff1a<\/p>\n “`json theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
\n{ “type”: “req”, “id”: “r1”, “method”: “health” }<\/p>\n \n```json theme={"theme":{"light":"min-light","dark":"min-dark"}}\n{ "type": "res", "id": "r1", "ok": true, "payload": { "ok": true } }\n<\/code><\/pre>\n\u4e8b\u4ef6\uff1a<\/p>\n “`json theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
\n{ “type”: “event”, “event”: “tick”, “payload”: { “ts”: 1730000000 }, “seq”: 12 }<\/p>\n \n## \u6700\u5c0f\u5ba2\u6237\u7aef\uff08Node.js\uff09\n\n\u6700\u5c0f\u53ef\u7528\u6d41\u7a0b\uff1aconnect + health\u3002\n\n```ts theme={"theme":{"light":"min-light","dark":"min-dark"}}\nimport { WebSocket } from "ws";\n\nconst ws = new WebSocket("ws:\/\/127.0.0.1:18789");\n\nws.on("open", () => {\n ws.send(\n JSON.stringify({\n type: "req",\n id: "c1",\n method: "connect",\n params: {\n minProtocol: 3,\n maxProtocol: 3,\n client: {\n id: "cli",\n displayName: "example",\n version: "dev",\n platform: "node",\n mode: "cli",\n },\n },\n }),\n );\n});\n\nws.on("message", (data) => {\n const msg = JSON.parse(String(data));\n if (msg.type === "res" && msg.id === "c1" && msg.ok) {\n ws.send(JSON.stringify({ type: "req", id: "h1", method: "health" }));\n }\n if (msg.type === "res" && msg.id === "h1") {\n console.log("health:", msg.payload);\n ws.close();\n }\n});\n<\/code><\/pre>\n\u5b9e\u8df5\u793a\u4f8b\uff1a\u7aef\u5230\u7aef\u6dfb\u52a0\u65b9\u6cd5<\/h2>\n\u793a\u4f8b\uff1a\u6dfb\u52a0\u4e00\u4e2a\u65b0\u7684 system.echo<\/code> \u8bf7\u6c42\uff0c\u8fd4\u56de { ok: true, text }<\/code>\u3002<\/p>\n\n- \u6a21\u5f0f\uff08\u4e8b\u5b9e\u6765\u6e90\uff09<\/strong><\/li>\n<\/ol>\n
\u6dfb\u52a0\u5230 src\/gateway\/protocol\/schema.ts<\/code>\uff1a<\/p>\n“`ts theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
\nexport const SystemEchoParamsSchema = Type.Object(
\n { text: NonEmptyString },
\n { additionalProperties: false },
\n);<\/p>\n export const SystemEchoResultSchema = Type.Object(
\n { ok: Type.Boolean(), text: NonEmptyString },
\n { additionalProperties: false },
\n);<\/p>\n \n\u5c06\u4e24\u8005\u6dfb\u52a0\u5230 `ProtocolSchemas` \u5e76\u5bfc\u51fa\u7c7b\u578b\uff1a\n\n```ts theme={"theme":{"light":"min-light","dark":"min-dark"}}\n SystemEchoParams: SystemEchoParamsSchema,\n SystemEchoResult: SystemEchoResultSchema,\n<\/code><\/pre>\n“`ts theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
\nexport type SystemEchoParams = Static;
\nexport type SystemEchoResult = Static;<\/p>\n \n2. **\u9a8c\u8bc1**\n\n\u5728 `src\/gateway\/protocol\/index.ts` \u4e2d\uff0c\u5bfc\u51fa\u4e00\u4e2a AJV \u9a8c\u8bc1\u5668\uff1a\n\n```ts theme={"theme":{"light":"min-light","dark":"min-dark"}}\nexport const validateSystemEchoParams = ajv.compile<SystemEchoParams>(SystemEchoParamsSchema);\n<\/code><\/pre>\n\n- \u670d\u52a1\u5668\u884c\u4e3a<\/strong><\/li>\n<\/ol>\n
\u5728 src\/gateway\/server-methods\/system.ts<\/code> \u4e2d\u6dfb\u52a0\u5904\u7406\u7a0b\u5e8f\uff1a<\/p>\n“`ts theme={“theme”:{“light”:”min-light”,”dark”:”min-dark”}}
\nexport const systemHandlers: GatewayRequestHandlers = {
\n “system.echo”: ({ params, respond }) => {
\n const text = String(params.text ?? “”);
\n respond(true, { ok: true, text });
\n },
\n};<\/p>\n \n\u5728 `src\/gateway\/server-methods.ts` \u4e2d\u6ce8\u518c\uff08\u5df2\u5408\u5e76 `systemHandlers`\uff09\uff0c\u7136\u540e\u5c06 `"system.echo"` \u6dfb\u52a0\u5230 `src\/gateway\/server.ts` \u4e2d\u7684 `METHODS`\u3002\n\n4. **\u91cd\u65b0\u751f\u6210**\n\n```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}\npnpm protocol:check\n<\/code><\/pre>\n\n- \u6d4b\u8bd5 + \u6587\u6863<\/strong><\/li>\n<\/ol>\n
\u5728 src\/gateway\/server.*.test.ts<\/code> \u4e2d\u6dfb\u52a0\u670d\u52a1\u5668\u6d4b\u8bd5\uff0c\u5e76\u5728\u6587\u6863\u4e2d\u8bb0\u5f55\u8be5\u65b9\u6cd5\u3002<\/p>\nSwift \u4ee3\u7801\u751f\u6210\u884c\u4e3a<\/h2>\nSwift \u751f\u6210\u5668\u8f93\u51fa\uff1a<\/p>\n \n- \u5e26\u6709
req<\/code>\u3001res<\/code>\u3001event<\/code> \u548c unknown<\/code> \u60c5\u51b5\u7684 GatewayFrame<\/code> \u679a\u4e3e<\/li>\n- \u5f3a\u7c7b\u578b\u7684 payload \u7ed3\u6784\u4f53\/\u679a\u4e3e<\/li>\n
ErrorCode<\/code> \u503c\u548c GATEWAY_PROTOCOL_VERSION<\/code><\/li>\n<\/ul>\n\u672a\u77e5\u7684\u5e27\u7c7b\u578b\u4fdd\u7559\u4e3a\u539f\u59cb payload \u4ee5\u5b9e\u73b0\u5411\u524d\u517c\u5bb9\u3002<\/p>\n
|