mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-09-30 22:33:03 +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 再次判红并修复。
210 lines
5.7 KiB
Markdown
210 lines
5.7 KiB
Markdown
<!-- 本页由 tools/apidoc/gensite 从源码生成，请勿手改；要改文档就改 sdk/*.go 的注释。 -->
|
||
|
||
# 生命周期（Lifecycle）
|
||
|
||
插件的启动、停止与卸载回调。停止与卸载是两件事：**停止**是进程/加载状态变化，**卸载**（onRemove）是插件被删除前的清理机会。
|
||
|
||
## `Plugin`
|
||
|
||
Plugin is the interface every plugin must implement.
|
||
|
||
| 方法 | 说明 |
|
||
|---|---|
|
||
| [`Name`](#pluginname) | |
|
||
| [`Start`](#pluginstart) | |
|
||
| [`Stop`](#pluginstop) | |
|
||
|
||
### `Plugin.Name`
|
||
|
||
```go
|
||
Name() string
|
||
```
|
||
|
||
<small>`plugin.go:14`</small>
|
||
|
||
### `Plugin.Start`
|
||
|
||
```go
|
||
Start(sdk *PluginSDK) error
|
||
```
|
||
|
||
<small>`plugin.go:15`</small>
|
||
|
||
### `Plugin.Stop`
|
||
|
||
```go
|
||
Stop() error
|
||
```
|
||
|
||
<small>`plugin.go:16`</small>
|
||
|
||
## `PluginMgrAPI`
|
||
|
||
PluginMgrAPI 提供插件管理能力（外部插件可调用）。
|
||
由 bridge 注入 dispatch 实现，走 C ABI CORE_PLUGIN_RELOAD_ONE 等。
|
||
|
||
| 方法 | 说明 |
|
||
|---|---|
|
||
| [`IsPluginDisabled`](#pluginmgrapiisplugindisabled) | IsPluginDisabled 查询插件是否被禁用。 |
|
||
| [`ListLoadedPlugins`](#pluginmgrapilistloadedplugins) | ListLoadedPlugins 列出已加载插件。 |
|
||
| [`ReloadOne`](#pluginmgrapireloadone) | ReloadOne 重载单个插件（停止后重新加载）。 |
|
||
|
||
### `PluginMgrAPI.IsPluginDisabled`
|
||
|
||
```go
|
||
IsPluginDisabled(name string) bool
|
||
```
|
||
|
||
IsPluginDisabled 查询插件是否被禁用。
|
||
|
||
<small>`plugin.go:290`</small>
|
||
|
||
### `PluginMgrAPI.ListLoadedPlugins`
|
||
|
||
```go
|
||
ListLoadedPlugins() []string
|
||
```
|
||
|
||
ListLoadedPlugins 列出已加载插件。
|
||
|
||
<small>`plugin.go:288`</small>
|
||
|
||
### `PluginMgrAPI.ReloadOne`
|
||
|
||
```go
|
||
ReloadOne(name string) error
|
||
```
|
||
|
||
ReloadOne 重载单个插件（停止后重新加载）。
|
||
|
||
<small>`plugin.go:286`</small>
|
||
|
||
### `PluginSDK.AutoRestart`
|
||
|
||
```go
|
||
func (s *PluginSDK) AutoRestart() bool
|
||
```
|
||
|
||
AutoRestart 返回插件是否允许自动重启。
|
||
|
||
<small>`plugin.go:796`</small>
|
||
|
||
### `PluginSDK.PluginMgr`
|
||
|
||
```go
|
||
func (s *PluginSDK) PluginMgr() PluginMgrAPI
|
||
```
|
||
|
||
PluginMgr returns the plugin manager API (ReloadOne / ReloadPlugins / list).
|
||
May be nil if the host did not wire it.
|
||
|
||
<small>`plugin.go:658`</small>
|
||
|
||
### `PluginSDK.PluginName`
|
||
|
||
```go
|
||
func (s *PluginSDK) PluginName() string
|
||
```
|
||
|
||
PluginName returns the name of the plugin.
|
||
|
||
<small>`plugin.go:402`</small>
|
||
|
||
### `PluginSDK.RegisterOnRemoveHandler`
|
||
|
||
```go
|
||
func (s *PluginSDK) RegisterOnRemoveHandler(fn func())
|
||
```
|
||
|
||
RegisterOnRemoveHandler 注册插件被删除（卸载）时的清理回调。
|
||
注册的 handler 会在插件目录被移除前按"后注册先执行"的顺序调用，
|
||
适用于清理外部资源、删除配置表、下线状态等删除后处理。
|
||
可注册多个；执行后清空（一次删除只执行一次）。
|
||
|
||
**示例插件里的真实用法**
|
||
|
||
| 插件 | 位置 | 代码 |
|
||
|---|---|---|
|
||
| [`calendar`](../examples/index.md#calendar) | `example/calendar/plugin.go:296` | `s.RegisterOnRemoveHandler(p.cleanupData)` |
|
||
| [`memo`](../examples/index.md#memo) | `example/memo/plugin.go:69` | `s.RegisterOnRemoveHandler(p.cleanupData)` |
|
||
| [`rss`](../examples/index.md#rss) | `example/rss/plugin.go:127` | `s.RegisterOnRemoveHandler(p.cleanupData)` |
|
||
|
||
<small>`plugin.go:831`</small>
|
||
|
||
### `PluginSDK.RegisterPluginAPI`
|
||
|
||
```go
|
||
func (s *PluginSDK) RegisterPluginAPI(name string) error
|
||
```
|
||
|
||
RegisterPluginAPI registers this plugin's API for access by other plugins.
|
||
|
||
<small>`plugin.go:507`</small>
|
||
|
||
### `PluginSDK.RegisterStopHandler`
|
||
|
||
```go
|
||
func (s *PluginSDK) RegisterStopHandler(fn func())
|
||
```
|
||
|
||
RegisterStopHandler 注册插件停止阶段的清理回调。
|
||
注册的 handler 会在插件 Stop() 之前按"后注册先执行"的顺序调用，
|
||
适用于释放资源、落盘状态、关闭子进程等停止时清理操作。
|
||
可注册多个；执行后清空（进程停止前只执行一次）。
|
||
|
||
**示例插件里的真实用法**
|
||
|
||
| 插件 | 位置 | 代码 |
|
||
|---|---|---|
|
||
| [`calendar`](../examples/index.md#calendar) | `example/calendar/plugin.go:294` | `s.RegisterStopHandler(p.saveEvents)` |
|
||
| [`deepsearch`](../examples/index.md#deepsearch) | `example/deepsearch/plugin.go:695` | `s.RegisterStopHandler(func() { p.shutdownSearxng() })` |
|
||
|
||
<small>`plugin.go:806`</small>
|
||
|
||
### `PluginSDK.RunOnRemoveHandlers`
|
||
|
||
```go
|
||
func (s *PluginSDK) RunOnRemoveHandlers()
|
||
```
|
||
|
||
RunOnRemoveHandlers 执行全部已注册的 onRemove handler（后注册先执行，执行后清空，幂等）。
|
||
由内核在卸载插件（registry.RemovePlugin）时、插件 Stop() 之后执行。
|
||
|
||
<small>`plugin.go:842`</small>
|
||
|
||
### `PluginSDK.RunStopHandlers`
|
||
|
||
```go
|
||
func (s *PluginSDK) RunStopHandlers()
|
||
```
|
||
|
||
RunStopHandlers 执行全部已注册的 stop handler（后注册先执行，执行后清空，幂等）。
|
||
由内核（内置插件）或插件桥接层（外部插件 z_bridge 的 StopPlugin）在调用插件 Stop() 前执行。
|
||
|
||
<small>`plugin.go:817`</small>
|
||
|
||
### `PluginSDK.SetAutoRestart`
|
||
|
||
```go
|
||
func (s *PluginSDK) SetAutoRestart(enabled bool)
|
||
```
|
||
|
||
SetAutoRestart 设置插件崩溃后内核是否自动重启它。
|
||
默认 true。如果插件有无法恢复的状态（如外部连接），应设为 false。
|
||
|
||
重启是有限度的：线性退避（第 n 次等 n×1s，即 1s→2s→3s），
|
||
且同一 5 分钟窗口内第 4 次崩溃就停下不再拉起（详见 README）。
|
||
注意这与「重载」（换 plugin.bin 后重新加载）是两回事。
|
||
|
||
**示例插件里的真实用法**
|
||
|
||
| 插件 | 位置 | 代码 |
|
||
|---|---|---|
|
||
| [`a2a`](../examples/index.md#a2a) | `example/a2a/plugin.go:47` | `s.SetAutoRestart(true)` |
|
||
| [`acp`](../examples/index.md#acp) | `example/acp/plugin.go:47` | `s.SetAutoRestart(true)` |
|
||
| [`ai_image`](../examples/index.md#ai_image) | `example/ai_image/plugin.go:110` | `s.SetAutoRestart(true)` |
|
||
| [`bili`](../examples/index.md#bili) | `example/bili/plugin.go:25` | `s.SetAutoRestart(true)` |
|
||
|
||
<small>`plugin.go:789`</small>
|
||
|