jianf/homeagent-sdk
1
0
Fork 0
mirror of https://gitcode.com/JianFeeeee/homeagent-sdk.git synced 2026-09-26 12:23:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
255d6479ada839339d894bcb7292bee8a68a3e31
homeagent-sdk/docs/api/lifecycle.md
JianFeeeee 9b6abe1b73 fix(docs): 中文搜不到英文注释的 API —— 补关键词层 
## 问题（实测）

SDK 里 100 个有摘要的符号中 **66 个是英文注释**，例如：

    RegisterTool registers a tool that the LLM can call.

于是搜「注册工具」——中文受众最自然的问法——**RegisterTool 得分 0，一条都搜不到**。
更糟的是逐字匹配把噪声顶上来了：搜「注册工具」返回 24 条，排第一的是
`SetToolBlocks`（描述里有「工具」二字），`RegisterTool` 根本不在列表里。

## 修法

不改源码注释（那会让代码与文档脱节），而是在检索索引上加一层**人工标注的
中文功能词**：`tools/apidoc/keywords.json`。

- `rules`：按符号名前缀/子串批量覆盖（`Register*` 全带「注册」，`*Memory*` 带「记忆」）
- `symbols`：逐符号补充（重点 API、或规则覆盖不到的）

词只进 `api-index.json` 的 `g` 字段，**不影响页面展示**；检索结果里会显示
（「为何命中」），读者能理解排序依据。

同时把中文逐字匹配从主信号降为**弱信号**（要求 60% 以上字符命中）——
它正是噪声来源：凡是含「工具」二字的说明都会被「注册工具」匹上。

## 结果

| 查询 | 修改前 | 修改后 |
|---|---|---|
| 注册工具 | 24 条，RegisterTool 缺席 | **7 条，RegisterTool 第一** |
| 崩溃 | 1 条 | 2 条（SetAutoRestart + AutoRestart）|
| InjectText | 7 条（含重复）| 6 条 |
| memory.recall | 1 条 | 1 条（不变）|

顺带修掉索引重复：接口会同时作为 `type` 符号与接口本身被加两次
（`MemoryAPI` 等 11 个各重复一条）。现在接口只走接口那条路径，索引 200 → 189 条。

keywords.json 是**可选**的：读不到只警告不中断，检索退化为原行为。
2026-09-24 13:00:32 +08:00

5.7 KiB
Raw Blame History

生命周期（Lifecycle）

插件的启动、停止与卸载回调。停止与卸载是两件事：停止是进程/加载状态变化，卸载（onRemove）是插件被删除前的清理机会。

Plugin

Plugin is the interface every plugin must implement.

方法 说明
Name
Start
Stop

Plugin.Name

Name() string

plugin.go:14

Plugin.Start

Start(sdk *PluginSDK) error

plugin.go:15

Plugin.Stop

Stop() error

plugin.go:16

PluginMgrAPI

PluginMgrAPI 提供插件管理能力（外部插件可调用）。 由 bridge 注入 dispatch 实现，走 C ABI CORE_PLUGIN_RELOAD_ONE 等。

方法 说明
IsPluginDisabled IsPluginDisabled 查询插件是否被禁用。
ListLoadedPlugins ListLoadedPlugins 列出已加载插件。
ReloadOne ReloadOne 重载单个插件（停止后重新加载）。

PluginMgrAPI.IsPluginDisabled

IsPluginDisabled(name string) bool

IsPluginDisabled 查询插件是否被禁用。

plugin.go:290

PluginMgrAPI.ListLoadedPlugins

ListLoadedPlugins() []string

ListLoadedPlugins 列出已加载插件。

plugin.go:288

PluginMgrAPI.ReloadOne

ReloadOne(name string) error

ReloadOne 重载单个插件（停止后重新加载）。

plugin.go:286

PluginSDK.AutoRestart

func (s *PluginSDK) AutoRestart() bool

AutoRestart 返回插件是否允许自动重启。

plugin.go:791

PluginSDK.PluginMgr

func (s *PluginSDK) PluginMgr() PluginMgrAPI

PluginMgr returns the plugin manager API (ReloadOne / ReloadPlugins / list). May be nil if the host did not wire it.

plugin.go:653

PluginSDK.PluginName

func (s *PluginSDK) PluginName() string

PluginName returns the name of the plugin.

plugin.go:397

PluginSDK.RegisterOnRemoveHandler

func (s *PluginSDK) RegisterOnRemoveHandler(fn func())

RegisterOnRemoveHandler 注册插件被删除（卸载）时的清理回调。 注册的 handler 会在插件目录被移除前按"后注册先执行"的顺序调用， 适用于清理外部资源、删除配置表、下线状态等删除后处理。 可注册多个；执行后清空（一次删除只执行一次）。

示例插件里的真实用法

插件 位置 代码
calendar example/calendar/plugin.go:296 s.RegisterOnRemoveHandler(p.cleanupData)
memo example/memo/plugin.go:69 s.RegisterOnRemoveHandler(p.cleanupData)
rss example/rss/plugin.go:127 s.RegisterOnRemoveHandler(p.cleanupData)

plugin.go:826

PluginSDK.RegisterPluginAPI

func (s *PluginSDK) RegisterPluginAPI(name string) error

RegisterPluginAPI registers this plugin's API for access by other plugins.

plugin.go:502

PluginSDK.RegisterStopHandler

func (s *PluginSDK) RegisterStopHandler(fn func())

RegisterStopHandler 注册插件停止阶段的清理回调。 注册的 handler 会在插件 Stop() 之前按"后注册先执行"的顺序调用， 适用于释放资源、落盘状态、关闭子进程等停止时清理操作。 可注册多个；执行后清空（进程停止前只执行一次）。

示例插件里的真实用法

插件 位置 代码
calendar example/calendar/plugin.go:294 s.RegisterStopHandler(p.saveEvents)
deepsearch example/deepsearch/plugin.go:695 s.RegisterStopHandler(func() { p.shutdownSearxng() })

plugin.go:801

PluginSDK.RunOnRemoveHandlers

func (s *PluginSDK) RunOnRemoveHandlers()

RunOnRemoveHandlers 执行全部已注册的 onRemove handler（后注册先执行，执行后清空，幂等）。 由内核在卸载插件（registry.RemovePlugin）时、插件 Stop() 之后执行。

plugin.go:837

PluginSDK.RunStopHandlers

func (s *PluginSDK) RunStopHandlers()

RunStopHandlers 执行全部已注册的 stop handler（后注册先执行，执行后清空，幂等）。 由内核（内置插件）或插件桥接层（外部插件 z_bridge 的 StopPlugin）在调用插件 Stop() 前执行。

plugin.go:812

PluginSDK.SetAutoRestart

func (s *PluginSDK) SetAutoRestart(enabled bool)

SetAutoRestart 设置插件崩溃后内核是否自动重启它。 默认 true。如果插件有无法恢复的状态（如外部连接），应设为 false。

重启是有限度的：线性退避（第 n 次等 n×1s，即 1s→2s→3s）， 且同一 5 分钟窗口内第 4 次崩溃就停下不再拉起（详见 README）。 注意这与「重载」（换 plugin.bin 后重新加载）是两回事。

示例插件里的真实用法

插件 位置 代码
a2a example/a2a/plugin.go:47 s.SetAutoRestart(true)
acp example/acp/plugin.go:47 s.SetAutoRestart(true)
ai_image example/ai_image/plugin.go:110 s.SetAutoRestart(true)
bili example/bili/plugin.go:25 s.SetAutoRestart(true)

plugin.go:784