事件

工程开发 社区

技能解读

当前原文的自动摘译,尚未人工审校。

概述

WPS (Wave PubSub) 是 Wave Terminal 的发布-订阅事件系统,使应用程序的不同部分能够异步通信。系统使用代理模式根据事件类型和范围将事件从发布者路由到订阅者。

关键文件

pkg/wps/wpstypes.go - 事件类型常量和数据结构 pkg/wps/wps.go - 代理实现和核心逻辑 pkg/wcore/wcore.go - 示例使用模式

事件结构

WPS 中的事件具有以下结构:

第 2 步:添加到所有事件

将新常量添加到 pkg/wps/wpstypes.go 中的 AllEvents 切片中:

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
工程开发
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@wavetermdev · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
即装即用
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第 1 步:定义事件常量

将事件类型常量添加到 `pkg/wps/wpstypes.go`: 命名约定:使用描述性 PascalCase 作为常量名称,并带有 `Event_` 前缀 使用小写字母和冒号作为字符串值(例如,“namespace:eventname”) 将具有相同命名空间前缀的相关事件分组

02
第 2 步:添加到所有事件

将新常量添加到 `pkg/wps/wpstypes.go` 中的 `AllEvents` 切片:

03
第 3 步:在 WaveEventDataTypes 中注册(必需)

您必须将条目添加到`pkg/tsgen/tsgenevent.go`中的`WaveEventDataTypes`。这会驱动事件的 `data` 字段的 TypeScript 类型生成: 对于值类型使用 `reflect.TypeOf(YourType{})` 对于指针类型使用 `reflect.TypeOf((*YourType)(nil))` 如果没有为事件发送数据,则使用 `nil`

04
步骤 4:定义事件数据结构(可选)

如果您的事件携带结构化数据,请为其定义一个类型:

05
第 5 步:向前端公开类型(如果需要)

如果您的事件数据类型尚未通过 RPC 调用公开,则需要将其添加到 `pkg/tsgen/tsgen.go` 以便生成 TypeScript 类型:然后运行代码生成:这将使用类型的 TypeScript 定义更新 `frontend/types/gotypes.d.ts`,确保处理这些事件时前端的类型安全。

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。