文档首页/prefs:通用偏好设置的读取、合并和保存

prefs:通用偏好设置的读取、合并和保存

English · 上层架构

如何由其他模块接入

这里的“对外”指仓库内其他 Go 包。Go 的 internal 规则限制了仓库外的直接导入;HTTP 客户端使用已挂载的网关接口。

注入配置和可信存储后挂载模块;读取先合并 YAML 与数据库覆盖,保存只覆盖明确提交的字段,推理策略由独立路由模板管理。

入口或资源 调用方式与返回结果
Module(host) 构造 util.Module,经 Mount/Server.Use 安装
GET /config/list 本示例使用的 HTTP 入口

接入 demo

启动接线可以使用下面的包间接入函数。宿主必须实现表中的接口;reg 可传网关 Server。若使用标准库 ServeMux,按 health demo 适配 Handle。该函数可编译,实际执行依赖完整宿主;下面的 HTTP demo 用于检查挂载后的接口。

package demo

import (
	"github.com/sunqirui1987/xhub/internal/gateway/prefs"
	"github.com/sunqirui1987/xhub/internal/util"
)

// MountDemo 演示启动时挂载模块;h 提供真实宿主能力,reg 接收路由,返回无。
// 调用方须先初始化依赖;挂载会修改路由表,不执行 HTTP 请求。
func MountDemo(h prefs.Host, reg util.Registrar) { prefs.Module(h).Mount(reg) }

先启动已配置的本地网关。设置 XHUB_DEMO_TOKEN 为具有本接口权限的会话令牌。完整宿主接线见 wire.go 和 routes.go,不可用 nil 依赖代替。

在仓库根目录执行以下命令。

curl -sS -i "http://localhost:4000/config/list" \
  -H "Authorization: Bearer $XHUB_DEMO_TOKEN"

返回合并后的通用设置;推理策略在路由模板中管理。

错误、状态与副作用

缺省和显式零不同;数据库按键覆盖 YAML。写设置仍需管理授权,不能把 UI 默认值无条件写回数据库。

职责

通用偏好设置的读取、合并和保存。不执行路由;缺省与显式零不同,合并顺序影响租户生效设置。

Review 顺序

host.go / mount.go → settings.go / page.go → merge.go

先读消费方接口或输入契约,再沿入口阅读辅助函数及旁边的单元测试;涉及请求生命周期时检查上层调用方。

依赖

Host 注入存储、鉴权及 reload。

验证

同目录测试:merge_test.go; cmd/regression/design_cleanup_test.go

仓库根目录执行:go test ./internal/gateway/prefs -count=1

真实 HTTP/持久化契约放 cmd/regression;浏览器 → 网关 → 本地上游流程放 frontend/e2e。测试清理私有 schema 与临时夹具;离线测试不假设有付费供应商凭据。

输入关键词搜索全文,例如:预算、路由、Docker