Files
homeagent-sdk/docs/api/lifecycle.md
JianFeeeee bd73a9b241 feat(sdk): 通用反代声明项(DeclareProxy)+ ToolDef.Serial 串行标记 + 场面策略文档
本次一并提交工作区此前累积的改动(均已验证),并接入工具并发调度所需的
声明项。

把「谁来反代谁」从内核硬编码变成插件可声明。设备网关(remotedevice)
这类**编译进内核、没有独立插件目录与 plugin.json** 的服务,静态扫描扫不到,
此前只能靠约定。新增 DeclareProxy 让它们能自己声明反代路由。

ParallelSafe 的**反向**声明项。判据优先级:Serial 胜出,显式声明不允许被
ParallelSafe 或任何默认值覆盖。

为什么需要它:ParallelSafe 零值 false 已表达「安全/串行」,插件无法区分
「我没想过」和「我确认过必须串行」。没有这个区分,工具作者只能靠命名约定
传递意图,那不是契约。

ParallelSafe 本身也补齐了注释,明确其零值语义(默认串行、保守)与理由
(新语义下并发会改变工具的行为前提,让存量插件意外并发比慢一点危险得多)。

配套 ScenePolicy 声明项的使用说明。

remotedevice/ 整目录(C 实现的设备网关,已由 Go 侧 DeclareProxy 路径取代)。

- sdk/knowledge.go:随场面策略配套调整
- docs/api/*、docs/assets/api-index.json、docs/llms.txt、mkdocs.yml:
  由 tools/apidoc/build.sh 从源码重新生成(行号随 plugin.go 变动漂移)
2026-09-27 16:17:04 +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:389

PluginMgrAPI.ListLoadedPlugins

ListLoadedPlugins() []string

ListLoadedPlugins 列出已加载插件。

plugin.go:387

PluginMgrAPI.ReloadOne

ReloadOne(name string) error

ReloadOne 重载单个插件(停止后重新加载)。

plugin.go:385

PluginSDK.AutoRestart

func (s *PluginSDK) AutoRestart() bool

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

plugin.go:895

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:757

PluginSDK.PluginName

func (s *PluginSDK) PluginName() string

PluginName returns the name of the plugin.

plugin.go:501

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:930

PluginSDK.RegisterPluginAPI

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

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

plugin.go:606

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:905

PluginSDK.RunOnRemoveHandlers

func (s *PluginSDK) RunOnRemoveHandlers()

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

plugin.go:941

PluginSDK.RunStopHandlers

func (s *PluginSDK) RunStopHandlers()

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

plugin.go:916

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:888