mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-09-27 04:43:07 +00:00
0a6e2b7dc4
为插件作者建一个文档站，重点是**能按描述搜到 API**，以及**明确能力边界**。
## 为什么 API 参考要生成而不是手写
公开 API 面有 115 个符号、11 个接口。手抄必然与代码漂移——这是文档站最常见的
死法（本仓 README 里已经有过几处「文档说一套、代码是另一套」）。
所以 `tools/apidoc` 直接从 `sdk/*.go` 提取签名、文档注释与代码块示例，渲染成
`docs/api/*.md`。发现文档不对时改的是**源码注释**，不是生成物。生成页首行带
「勿手改」标记，防止有人改了下次构建白改。
- `extract.go`：go/ast + go/doc 提取（只用标准库，离线可跑，不引入依赖）
- `gensite/`：渲染 Markdown + 检索索引
- `gensite/usages.go`：从 `example/` 21 个示例插件里反查**真实调用点**，
贴在每个 API 下（源码注释里几乎没有可运行示例，但示例插件都是能编译跑的真代码）
## 能力边界：写这个站时查出的三处文档错误
这是本次最有价值的部分。原以为「公开 SDK 里有的 API 外部插件都能用」，
实测对照桥接模板后发现三处不符，站内已更正：
1. **`PluginMgr()` 被写成「仅内置可用」——错的。** 桥接模板第 692 行显式
`base.SetPluginMgrAPI(procPluginMgr{})`，公开 `PluginMgrAPI` 注释也写「外部插件可调用」。
真正的区别是**方法数**：公开面 3 个（ReloadOne/ListLoadedPlugins/IsPluginDisabled），
内部面 9 个。容易混淆是因为两个包里有同名但不同的接口。
2. **`Events()` 外部插件恒为 nil。** `SetEventSubscriber` 全仓只有定义、无调用点，
故 subscriber 从未被注入。外部插件的事件订阅实际由生成的运行时走
`events.subscribe` RPC 完成——旧文档把它当成可用入口，会让人写出必然失效的代码。
3. **`UnregisterOutputChannel` 是静默无效，不是报错。** 桥接只注入 registrar、
不注入 unregistrar，于是 `regOutputUnreg == nil`，函数命中 else 分支**直接返回 nil**
（sdk/plugin.go:539-549）——不报错、通道也没注销。
每条裁定的依据写进 `tools/apidoc/tiers.json`（文件:行号 或 grep 结论），
站上以告警框呈现，读者可自行核对。判断依据三源：桥接模板的 `base.Set*` 注入点、
`internal/sdk` 完整面、`internal/plugin/proc/protocol.go` 的 RPC 表。
## 检索（用户的核心诉求）
两套互补：
- **MkDocs 内置搜索**：全文，中文走 jieba 分词。
- **自建 API 检索**（`docs/javascripts/api-search.js` + `assets/api-index.json`）：
支持四类查询——按名称、**按功能描述**（「注册工具」→ RegisterTool、
「崩溃」→ SetAutoRestart）、按 `限定符.方法`（`memory.recall` → MemoryAPI.Recall）、
按签名片段（`(string) error`）。并标出「仅内置」，避免外部插件作者踩空。
自建的理由：Material 内置搜索按整页文本索引，搜 `InjectText` 会列出所有提到它的
页面，但分不清哪条是它的定义；而且它要等 mkdocs build 才更新。
## 文档结构
- `docs/guide/`：快速开始、Go/Lua 首个插件、能力边界、打包发布、多平台、受限 SDK 与安全
- `docs/api/`：10 个按「你想做什么」划分的章节（工具/阶段/记忆/通道/配置/生命周期/
事件/LLM/常量/桥接）+ 仅内置汇总页
- `docs/versions.md`：SDK 版本语义（跟随内核中版本、patch 恒为 .0）、
1.0.0 是唯一破坏性变更、RPC 协议版本
## 验证
- `mkdocs build --strict` 零告警
- 23 个页面的全部站内链接与锚点可达（自动校验）
- 1440 / 768 / 390px 三视口：无横向溢出、无控制台错误
- 四种检索模式实测有结果且跳转锚点正确
- 构建产物 `site_build/` 已 gitignore
用法：`tools/apidoc/build.sh`（生成+构建）、`tools/apidoc/build.sh serve`（预览）。
231 lines
6.3 KiB
Markdown
231 lines
6.3 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:791`</small>
|
||
|
||
### `Plugin`
|
||
|
||
```go
|
||
type Plugin interface { Name() string Start(sdk *PluginSDK) error Stop() error }
|
||
```
|
||
|
||
Plugin is the interface every plugin must implement.
|
||
|
||
<small>`plugin.go:13`</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:653`</small>
|
||
|
||
### `PluginMgrAPI`
|
||
|
||
```go
|
||
type PluginMgrAPI interface { // ReloadOne 重载单个插件（停止后重新加载）。 ReloadOne(name string) error // ListLoadedPlugins 列出已加载插件。 ListLoa …
|
||
```
|
||
|
||
PluginMgrAPI 提供插件管理能力（外部插件可调用）。
|
||
由 bridge 注入 dispatch 实现，走 C ABI CORE_PLUGIN_RELOAD_ONE 等。
|
||
|
||
<small>`plugin.go:284`</small>
|
||
|
||
### `PluginSDK.PluginName`
|
||
|
||
```go
|
||
func (s *PluginSDK) PluginName() string
|
||
```
|
||
|
||
PluginName returns the name of the plugin.
|
||
|
||
<small>`plugin.go:397`</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:826`</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:502`</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:801`</small>
|
||
|
||
### `PluginSDK.RunOnRemoveHandlers`
|
||
|
||
```go
|
||
func (s *PluginSDK) RunOnRemoveHandlers()
|
||
```
|
||
|
||
RunOnRemoveHandlers 执行全部已注册的 onRemove handler（后注册先执行，执行后清空，幂等）。
|
||
由内核在卸载插件（registry.RemovePlugin）时、插件 Stop() 之后执行。
|
||
|
||
<small>`plugin.go:837`</small>
|
||
|
||
### `PluginSDK.RunStopHandlers`
|
||
|
||
```go
|
||
func (s *PluginSDK) RunStopHandlers()
|
||
```
|
||
|
||
RunStopHandlers 执行全部已注册的 stop handler（后注册先执行，执行后清空，幂等）。
|
||
由内核（内置插件）或插件桥接层（外部插件 z_bridge 的 StopPlugin）在调用插件 Stop() 前执行。
|
||
|
||
<small>`plugin.go:812`</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:784`</small>
|
||
|