mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-10-03 07:34:23 +00:00
a176cc3e20
配套核心仓「webui 通用反向代理」。SDK 1.4.0 尚未发布，接口未冻结，
本次按开发期自由变更处理（正式发版时并入版本号推进）。
## 声明契约
plugin.json 的 proxies 字段（声明式，静态可发现）或 RegisterProxy
（运行期，供没有 plugin.json 的内置插件用）：
{"name":"ui","host":"myapp","path":"/p/myapp","strip_path":true,
"target":"127.0.0.1:12100","auth":"homeagent"}
命名与既有能力对齐（ToolDef / ChannelDef / ConfigDef / RegisterTool /
ToolRegistrar）——第一版写成 ProxyDecl / DeclareProxy / ProxyDeclarer
被评审指出「跟 SDK 其他接口不是一个风格」，已全面改名。
## strip_path：Path 的两种语义
Path 不能一刀切成「原样保留」，真实需求有两种且**不能自动判定**
（同一个 path 在两种语义下都说得通，猜错即全部 404 且像上游故障）：
strip_path 缺省/false（别名模式）—— path 是上游真实路径的一部分
/api/v1/device/ws + path=/api/v1/device → 上游收到原样
适用：客户端**已硬编码**路径的机器接口（设备网关即如此）
strip_path=true（前缀模式）—— path 只是门户上的挂载点
/p/myapp/api/status + path=/p/myapp → 上游收到 /api/status
适用：自带 UI 的服务（前端用相对路径）
非法组合（strip_path 而无 path）被 ValidateProxyDef 挡住。
## 单一入口原则（契约级要求）
一个声明 = 一个入口。两种挂载形态对「根路径」处理截然不同：
Host 形态下根路径是插件的根（fetch('/api/x') 天然正确）；
Path 形态下根路径**属于门户**，同样代码会打到门户自己身上
（静默错路由：页面能开、功能全坏）。
故被反代的插件必须**一律使用相对路径**，绝不硬编码以 / 开头的绝对路径。
这样同一份前端在两种形态下都正确，插件不必知道自己被挂在哪，
反代层也能按外部条件（子域是否有证书/放行）自由选择形态。
## 判据
sdk/proxy_test.go：两种语义的映射、非法组合、单一入口原则的契约存在性。
hmapdev proxy_config_test.go：schema 漂移保护（新增字段忘了同步就判红）、
非法声明在**打包时**就被拒（不必装到 HomeAgent 才看到）。
两模块 go test 全绿；文档站已重新生成（ProxyDef 与单一入口原则进入
docs/api/misc.md 与 llms-full.txt）。
## 顺带修回的一处（此前随工作树丢失）
writePluginJSON 漏写 proxies 键 —— 漏写的话插件装得上、启动正常、
就是不出现，没有任何报错。该 bug 曾在核心仓侧出现过（判据抓到过），
这次移植时由 TestWritePluginJSONPreservesProxies 再次判红并修复。
70 lines
2.0 KiB
Markdown
70 lines
2.0 KiB
Markdown
<!-- 本页由 tools/apidoc/gensite 从源码生成，请勿手改；要改文档就改 sdk/*.go 的注释。 -->
|
||
|
||
# 事件（Events）
|
||
|
||
订阅内核事件。**注意**：外部分布式插件的事件订阅不走 `Events()`（该接口在外部插件路径上未被注入，恒为 nil），而是由 `hmapdev` 生成的运行时通过 `events.subscribe` 完成。详见下方说明。
|
||
|
||
## `EventSubscriber`
|
||
|
||
EventSubscriber allows plugins to subscribe to kernel events.
|
||
This is a restricted interface: plugins can subscribe but the kernel
|
||
controls which events are delivered.
|
||
|
||
| 方法 | 说明 |
|
||
|---|---|
|
||
| [`Subscribe`](#eventsubscribersubscribe) | |
|
||
|
||
### `EventSubscriber.Subscribe`
|
||
|
||
!!! warning "仅内核内置插件可用"
|
||
|
||
```go
|
||
Subscribe(eventType EventType, handler EventHandler) func()
|
||
```
|
||
|
||
<small>`plugin.go:279`</small>
|
||
|
||
### `Event`
|
||
|
||
```go
|
||
type Event struct { Type EventType `json:"type"` Source string `json:"source"` Payload map[string]interface{} `json:"payload"` T …
|
||
```
|
||
|
||
Event represents a system event published by the kernel.
|
||
|
||
<small>`plugin.go:265`</small>
|
||
|
||
### `EventHandler`
|
||
|
||
```go
|
||
type EventHandler func(evt *Event)
|
||
```
|
||
|
||
EventHandler processes a system event.
|
||
|
||
<small>`plugin.go:273`</small>
|
||
|
||
### `EventType`
|
||
|
||
```go
|
||
type EventType string
|
||
```
|
||
|
||
EventType identifies the kind of system event.
|
||
|
||
<small>`plugin.go:247`</small>
|
||
|
||
### `PluginSDK.Events`
|
||
|
||
!!! warning "仅内核内置插件可用"
|
||
实测全仓 SetEventSubscriber 只有定义、无任何调用点（grep -rn SetEventSubscriber --include=*.go 仅命中 sdk/plugin.go 的定义与 lua_plugin.go 的一句注释）。外部插件拿到的 Events() 恒为 nil。外部插件订阅事件走的是桥接运行时的 events.subscribe RPC（proc_main.go.tmpl:1421 在插件侧分发、内核 protocol.go MethodEventsSubscribe），Lua 插件则走内部 SDK 的 Subscribe。这正是 PLUGIN_DEV.md 里没有说清的一处。
|
||
|
||
```go
|
||
func (s *PluginSDK) Events() EventSubscriber
|
||
```
|
||
|
||
Events returns the event subscriber for listening to kernel events (may be nil if not available).
|
||
|
||
<small>`plugin.go:451`</small>
|
||
|