跳转到内容

插件与生命周期

每个被加载的插件都拥有一个 Fiber 作用域,其状态如下:

PENDING → LOADING → ACTIVE
↘ FAILED
ACTIVE → UNLOADING → DISPOSED
状态含义
PENDING已声明,但所需依赖未就绪
LOADING依赖就绪,正在执行 apply
ACTIVE插件运行中
FAILEDapply 抛出异常
UNLOADING插件正在卸载并释放资源
DISPOSED已完全卸载

声明了 inject 的插件会等待所有必需服务就绪:

export const inject = ['tools', 'llm']
export function apply(ctx: Context) {
// ctx.tools and ctx.llm are ready here.
}

如果依赖的服务消失(例如提供方被替换时),插件会被自动卸载(ACTIVE → DISPOSED),待服务恢复后重新加载。

通过 ctx 做的任何注册,在插件卸载时都会自动撤销:

export function apply(ctx: Context) {
// Event listener: removed automatically on unload.
ctx.on('some-event', handler)
// Custom resource: the returned disposer runs on unload.
ctx.effect(() => {
const connection = createConnection()
return () => connection.close()
})
}

以下操作都会被自动追踪和清理:

  • ctx.on(event, handler) — 事件监听
  • ctx.tools.register(tool) — 工具注册
  • ctx.llm.registerAdapter(names, adapter) — LLM(大语言模型)适配器注册
  • ctx.effect(() => cleanup) — 自定义资源

插件卸载时,处置器按注册顺序的逆序开始调用,但多个异步处置器会并发执行,不保证逐个完成。存在顺序依赖的清理步骤必须放进同一个 ctx.effect() 返回的处置器中,由该处置器负责串行等待。

ctx.plugin() 创建子 Fiber,它继承父上下文但有独立的生命周期:

export function apply(ctx: Context) {
// Register a child plugin.
ctx.plugin(childPlugin)
// The child has its own Fiber and unloads with its parent.
}

当你需要提前终止一个插件实例:

import type { Context } from '@deepseek-ai/cordis'
declare const ctx: Context
declare function myPlugin(ctx: Context): void
const fiber = ctx.plugin(myPlugin)
// Dispose it manually later.
await fiber.dispose()

dispose 保证:

  1. 该插件拥有的所有注册均被移除
  2. 它的子插件也被递归卸载
  3. 返回的 Promise 会在所有异步清理完成后兑现

通过 cordis.yml 加载 @deepseek-ai/cordis-plugin-hmr 后,修改插件源文件会触发:

  1. 卸载旧插件(清理所有注册)
  2. 重新加载新代码
  3. 执行新的 apply

因为插件注册会被自动清理,所以热替换不会保留旧实例的注册。

export function apply(ctx: Context) {
console.log('plugin loading')
ctx.effect(() => {
console.log('effect registered')
return () => console.log('effect cleaned up')
})
}

加载时输出:

plugin loading
effect registered

卸载时输出:

effect cleaned up