Files
homeagent-sdk/docs/api/bridge.md
JianFeeeee a176cc3e20 feat(sdk): 反代声明(ProxyDef / RegisterProxy)—— 插件声明服务,HomeAgent 反代出去
配套核心仓「webui 通用反向代理」。SDK 1.4.0 尚未发布,接口未冻结,
本次按开发期自由变更处理(正式发版时并入版本号推进)。

## 声明契约

plugin.json 的 proxies 字段(声明式,静态可发现)或 RegisterProxy
(运行期,供没有 plugin.json 的内置插件用):

    {"name":"ui","host":"myapp","path":"/p/myapp","strip_path":true,
     "target":"127.0.0.1:12100","auth":"homeagent"}

命名与既有能力对齐(ToolDef / ChannelDef / ConfigDef / RegisterTool /
ToolRegistrar)——第一版写成 ProxyDecl / DeclareProxy / ProxyDeclarer
被评审指出「跟 SDK 其他接口不是一个风格」,已全面改名。

## strip_path:Path 的两种语义

Path 不能一刀切成「原样保留」,真实需求有两种且**不能自动判定**
(同一个 path 在两种语义下都说得通,猜错即全部 404 且像上游故障):

  strip_path 缺省/false(别名模式)—— path 是上游真实路径的一部分
    /api/v1/device/ws + path=/api/v1/device → 上游收到原样
    适用:客户端**已硬编码**路径的机器接口(设备网关即如此)

  strip_path=true(前缀模式)—— path 只是门户上的挂载点
    /p/myapp/api/status + path=/p/myapp → 上游收到 /api/status
    适用:自带 UI 的服务(前端用相对路径)

非法组合(strip_path 而无 path)被 ValidateProxyDef 挡住。

## 单一入口原则(契约级要求)

一个声明 = 一个入口。两种挂载形态对「根路径」处理截然不同:
Host 形态下根路径是插件的根(fetch('/api/x') 天然正确);
Path 形态下根路径**属于门户**,同样代码会打到门户自己身上
(静默错路由:页面能开、功能全坏)。

故被反代的插件必须**一律使用相对路径**,绝不硬编码以 / 开头的绝对路径。
这样同一份前端在两种形态下都正确,插件不必知道自己被挂在哪,
反代层也能按外部条件(子域是否有证书/放行)自由选择形态。

## 判据

sdk/proxy_test.go:两种语义的映射、非法组合、单一入口原则的契约存在性。
hmapdev proxy_config_test.go:schema 漂移保护(新增字段忘了同步就判红)、
非法声明在**打包时**就被拒(不必装到 HomeAgent 才看到)。

两模块 go test 全绿;文档站已重新生成(ProxyDef 与单一入口原则进入
docs/api/misc.md 与 llms-full.txt)。

## 顺带修回的一处(此前随工作树丢失)

writePluginJSON 漏写 proxies 键 —— 漏写的话插件装得上、启动正常、
就是不出现,没有任何报错。该 bug 曾在核心仓侧出现过(判据抓到过),
这次移植时由 TestWritePluginJSONPreservesProxies 再次判红并修复。
2026-09-26 14:08:30 +08:00

5.3 KiB
Raw Blame History

桥接装配点(Bridge)

以下方法不是给插件业务代码调的——它们由 hmapdev 生成的运行时在启动时调用,用来把内核能力注入到 SDK 实例。列在这里是为了让「公开 API 面」完整,并说明每个注入点对应什么能力。

APIRegistrar

type APIRegistrar func(name string) error

APIRegistrar registers a plugin API for external access.

plugin.go:311

InputChannelRegistrar

type InputChannelRegistrar func(name string, def ChannelDef) error

InputChannelRegistrar registers an input channel with its memory behavior.

plugin.go:314

OutputChannelRegistrar

type OutputChannelRegistrar func(name string, caps int, desc string, def ChannelDef, handler ToolHandler) error

OutputChannelRegistrar registers an output channel that the output_send tool can use.

plugin.go:317

OutputChannelUnregistrar

type OutputChannelUnregistrar func(name string) error

OutputChannelUnregistrar 注销一个输出通道。

为什么需要它:输出通道不止有"启动时注册一次"的静态通道,还有随外部资源生灭的 动态通道 —— 典型是远程设备:device/<id> 只在设备在线期间存在,设备掉线后 必须注销,否则 output_list_channels 会一直列着它、模型会往一个死通道发消息。

plugin.go:324

PluginSDK.SetDocMemoryAPI

!!! info "桥接装配点" 桥接运行时注入点(由 hmapdev 生成的 proc_main 调用,插件业务代码不调用)

func (s *PluginSDK) SetDocMemoryAPI(dm DocMemoryAPI)

plugin.go:619

PluginSDK.SetEventSubscriber

!!! warning "仅内核内置插件可用" 同上:无调用点。标 builtin 而非 bridge,因为连桥接运行时都不注入它——外部插件无法用它获得事件订阅能力。

func (s *PluginSDK) SetEventSubscriber(es EventSubscriber)

plugin.go:643

PluginSDK.SetIOInjector

!!! info "桥接装配点" 桥接运行时注入点(由 hmapdev 生成的 proc_main 调用,插件业务代码不调用)

func (s *PluginSDK) SetIOInjector(io IOInjector)

SetIOInjector sets the IO injector (called by the core at startup).

plugin.go:600

PluginSDK.SetInputChannelRegistrar

!!! info "桥接装配点" 桥接运行时注入点(由 hmapdev 生成的 proc_main 调用,插件业务代码不调用)

func (s *PluginSDK) SetInputChannelRegistrar(r InputChannelRegistrar)

SetInputChannelRegistrar sets the input channel registrar (called by the core at startup).

plugin.go:593

PluginSDK.SetKnowledgeAPI

!!! info "桥接装配点" 桥接运行时注入点(由 hmapdev 生成的 proc_main 调用,插件业务代码不调用)

func (s *PluginSDK) SetKnowledgeAPI(kn KnowledgeAPI)

plugin.go:625

PluginSDK.SetLLMAPI

!!! info "桥接装配点" 桥接运行时注入点(由 hmapdev 生成的 proc_main 调用,插件业务代码不调用)

func (s *PluginSDK) SetLLMAPI(llm LLMAPI)

plugin.go:631

PluginSDK.SetMemoryAPI

!!! info "桥接装配点" 桥接运行时注入点(由 hmapdev 生成的 proc_main 调用,插件业务代码不调用)

func (s *PluginSDK) SetMemoryAPI(mem MemoryAPI)

SetMemoryAPI sets the memory API (called by the core at startup).

plugin.go:607

PluginSDK.SetOutputChannelRegistrar

!!! info "桥接装配点" 桥接运行时注入点(由 hmapdev 生成的 proc_main 调用,插件业务代码不调用)

func (s *PluginSDK) SetOutputChannelRegistrar(r OutputChannelRegistrar)

SetOutputChannelRegistrar sets the output channel registrar (called by the core at startup).

plugin.go:579

PluginSDK.SetOutputChannelUnregistrar

!!! warning "仅内核内置插件可用" 同上,桥接模板不注入。

func (s *PluginSDK) SetOutputChannelUnregistrar(r OutputChannelUnregistrar)

SetOutputChannelUnregistrar sets the output channel unregistrar (called by the core at startup).

plugin.go:586

PluginSDK.SetPluginMgrAPI

!!! info "桥接装配点" 桥接运行时注入点(由 hmapdev 生成的 proc_main 调用,插件业务代码不调用)

func (s *PluginSDK) SetPluginMgrAPI(pm PluginMgrAPI)

SetPluginMgrAPI sets the plugin manager API (called by the bridge at startup).

plugin.go:650

PluginSDK.SetSocialAPI

!!! info "桥接装配点" 桥接运行时注入点(由 hmapdev 生成的 proc_main 调用,插件业务代码不调用)

func (s *PluginSDK) SetSocialAPI(social SocialAPI)

plugin.go:637

PluginSDK.SetTextMemoryAPI

!!! info "桥接装配点" 桥接运行时注入点(由 hmapdev 生成的 proc_main 调用,插件业务代码不调用)

func (s *PluginSDK) SetTextMemoryAPI(tm TextMemoryAPI)

plugin.go:613

ToolRegistrar

type ToolRegistrar func(name string, def ToolDef, handler ToolHandler) error

ToolRegistrar registers a tool dynamically.

plugin.go:305