mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-09-25 11:28:06 +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`（预览）。
112 lines
3.3 KiB
Markdown
112 lines
3.3 KiB
Markdown
# 第一个 Lua 插件
|
||
|
||
Lua 插件适合**轻量、快速原型**：不需要 Go 编译环境，改完重启内核即可生效。
|
||
但它有一个必须理解的限制 —— 执行模型是**被动回调**。
|
||
|
||
## 执行模型（先读这段）
|
||
|
||
Lua 插件跑在内核进程内的 gopher-lua 解释器里（单 Lua 状态 + 互斥锁）：
|
||
|
||
- **被动回调**：`main.lua` 只在加载时执行一次。此后工具、阶段钩子、
|
||
输入输出通道全部由内核事件驱动回调你的 Lua 函数。**插件不能自己启动后台任务。**
|
||
- **没有并发**：Lua 侧没有 goroutine、协程调度，也没有 `os` / `io` 库和 socket 监听。
|
||
唯一主动出站通道是 `sdk.http.get/post`（同步请求）。
|
||
- **任何阻塞循环都会持锁卡死该插件的全部调用。**
|
||
|
||
!!! warning "要常驻服务就用 Go 插件"
|
||
需要监听端口、后台轮询、定时任务的，请用 [Go 插件](first-plugin.md)
|
||
（可自行启动 goroutine）。Lua 侧的等价做法是**事件驱动**：把逻辑挂在
|
||
工具、阶段钩子或通道回调上。
|
||
|
||
## 生成工程
|
||
|
||
```bash
|
||
hmapdev init myluaplugin --lua
|
||
cd myluaplugin
|
||
```
|
||
|
||
结构：
|
||
|
||
```
|
||
myluaplugin/
|
||
├── plg.json — entry: "main.lua", targets: "lua"
|
||
├── main.lua — 插件实现
|
||
├── sdk.lua — SDK 模拟层（支持独立测试）
|
||
└── README.md
|
||
```
|
||
|
||
## 一个完整的插件
|
||
|
||
```lua
|
||
-- main.lua
|
||
local plugin = {
|
||
name = "myluaplugin"
|
||
}
|
||
|
||
function plugin.start(sdk)
|
||
sdk.log("info", "myluaplugin starting...")
|
||
|
||
sdk.register_tool("myluaplugin_hello", {
|
||
description = "向指定的人打招呼",
|
||
parameters = {
|
||
type = "object",
|
||
properties = {
|
||
who = { type = "string", description = "要打招呼的对象" }
|
||
},
|
||
required = { "who" }
|
||
}
|
||
}, function(args)
|
||
return { content = "hello, " .. (args.who or "world") .. "!" }
|
||
end)
|
||
|
||
sdk.log("info", "myluaplugin started")
|
||
end
|
||
|
||
function plugin.stop()
|
||
sdk.log("info", "myluaplugin stopped")
|
||
end
|
||
|
||
return plugin
|
||
```
|
||
|
||
## 本地测试
|
||
|
||
`sdk.lua` 是纯 Lua 的 SDK 模拟实现，可以直接用解释器跑：
|
||
|
||
```bash
|
||
lua main.lua
|
||
# [lua-plugin] info: myluaplugin starting...
|
||
# [lua-plugin] register_tool: myluaplugin_hello
|
||
# [lua-plugin] info: myluaplugin started
|
||
```
|
||
|
||
在内核里运行时，`sdk.*` 由 Go 层注入，`sdk.lua` 里所有 `-- !impl` 标记的函数
|
||
会被替换成真实实现。
|
||
|
||
## API 约定的两点
|
||
|
||
- **注册类函数调用即时报错**（抛 Lua error）—— 注册失败不会静默。
|
||
- **数据类函数统一返回 `(result, err)`**，`err` 为 nil 表示成功。
|
||
核心未装配的子系统（如 SocialAPI）返回空值而非报错。
|
||
|
||
Lua 侧的 `sdk.*` 能力与外部 Go 插件对齐至 SDK 1.3.0（需内核 1.4.0+）。
|
||
|
||
!!! note "历史提醒"
|
||
1.1–1.3 期间，媒体 / 注入标志位 / 优先级能力只在 Go 侧有，Lua 侧静默缺失。
|
||
现已全量对齐，并由 `internal/plugin/lua_surface_test.go` 的契约测试守住
|
||
「`sdk.lua` 承诺的每个函数都有运行时绑定」。
|
||
|
||
## 构建
|
||
|
||
```bash
|
||
hmapdev build # → dist/myluaplugin_lua.hmap
|
||
```
|
||
|
||
Lua 插件直接打包源码，不经过编译。
|
||
|
||
## 下一步
|
||
|
||
- [能力边界](capability-boundary.md) —— Lua 与 Go 外部插件的能力面一致
|
||
- [打包与发布](packaging.md)
|
||
- [示例](../examples/index.md) —— `example/luademo` 是 Lua 版参考实现
|