跳转至

生命周期（Lifecycle）

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

Plugin

Plugin is the interface every plugin must implement.

方法 说明
Name
Start
Stop

Plugin.Name

Name() string

plugin.go:15

Plugin.Start

Start(sdk *PluginSDK) error

plugin.go:16

Plugin.Stop

Stop() error

plugin.go:17

PluginMgrAPI

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

方法 说明
IsPluginDisabled IsPluginDisabled 查询插件是否被持久禁用。
IsPluginRuntimeStopped IsPluginRuntimeStopped 查询插件是否处于运行态关闭。
ListLoadedPlugins ListLoadedPlugins 列出已加载插件。
ReloadOne ReloadOne 重载单个插件（停止后重新加载）。
StartPlugin StartPlugin 运行态启动：现在拉起，不解除持久禁用。
StopPlugin StopPlugin 运行态关闭：现在停掉，不改持久状态。重启后按

PluginMgrAPI.IsPluginDisabled

IsPluginDisabled(name string) bool

IsPluginDisabled 查询插件是否被持久禁用。

plugin.go:537

PluginMgrAPI.IsPluginRuntimeStopped

IsPluginRuntimeStopped(name string) bool

IsPluginRuntimeStopped 查询插件是否处于运行态关闭。

plugin.go:564

PluginMgrAPI.ListLoadedPlugins

ListLoadedPlugins() []string

ListLoadedPlugins 列出已加载插件。

plugin.go:535

PluginMgrAPI.ReloadOne

ReloadOne(name string) error

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

plugin.go:533

PluginMgrAPI.StartPlugin

StartPlugin(name string) error

StartPlugin 运行态启动：现在拉起，不解除持久禁用。

被持久禁用的插件会被拒绝（提示先用 EnablePlugin）—— 持久禁用是用户的明确决定，运行态操作不该绕过它。

plugin.go:562

PluginMgrAPI.StopPlugin

StopPlugin(name string) error

StopPlugin 运行态关闭：现在停掉，不改持久状态。重启后按 auto_start + disabled_plugins 正常决定。

拒绝作用于 pluginmgr 自身与 webui（自锁/失联，内核层面拦死）。

plugin.go:557

PluginSDK.AutoRestart

func (s *PluginSDK) AutoRestart() bool

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

plugin.go:1176

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

PluginSDK.PluginName

func (s *PluginSDK) PluginName() string

PluginName returns the name of the plugin.

plugin.go:681

PluginSDK.RegisterOnRemoveHandler

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

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

plugin.go:1211

PluginSDK.RegisterPluginAPI

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

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

plugin.go:837

PluginSDK.RegisterStopHandler

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

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

plugin.go:1186

PluginSDK.RunOnRemoveHandlers

func (s *PluginSDK) RunOnRemoveHandlers()

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

plugin.go:1222

PluginSDK.RunStopHandlers

func (s *PluginSDK) RunStopHandlers()

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

plugin.go:1197

PluginSDK.SetAutoRestart

func (s *PluginSDK) SetAutoRestart(enabled bool)

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

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

示例插件里的真实用法

插件 位置 代码
feiyu_voice example/feiyu_voice/plugin.go:63 s.SetAutoRestart(true)

plugin.go:1169