Help us shape the future of Go! Take the 2026 Go Developer Survey

registry

package module
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 21, 2026 License: MIT Imports: 8 Imported by: 0

README

registry

注册发现与配置基础设施——SPI/Nacos 实现/Nacos 配置源/sdbridge

🌐 项目主页：https://oekit.github.io/ · 名称由来：Open Easy Kit（开源 · 易用 · 工具集合） 🤖 AI Agent：本仓规范与硬规则见 AGENTS.md；机器可读索引见 llms.txt（接口签名以源码为准）。

这个仓库做什么

registry 是注册发现与配置的基础设施层：provider 无关的服务注册/发现/订阅/配置 SPI、跨框架的服务发现桥接，以及（独立发版的嵌套模块）Nacos 落地实现与 Nacos 客户端门面。 本地配置文件加载（YAML/env/.env）已迁至 core/config。

安装

# 只想要 SPI 接口（根模块**零第三方依赖**）
go get github.com/oekit/registry@v0.4.2

# 要用 Nacos 实现 / Nacos 客户端门面（各自独立发版，按需取）
go get github.com/oekit/registry/nacosimpl@v0.1.0
go get github.com/oekit/registry/nacos@v0.1.0

为什么 Nacos 实现是嵌套模块：实测 nacos-sdk-go/v2 单独引入即拖进 63 个第三方模块 （阿里云 SDK 全家桶 + grpc + prometheus + otel…）。不隔离的话，只想要注册发现接口 的消费方也会被连带拖进去——与「按需取用」的承诺冲突。 嵌套模块的职责是依赖隔离（方向是父←子：只 import registry 的消费者不会拉进 Nacos 的重依赖），不是目录组织。import 路径一个都没变， 变的只是「它由哪个 module 提供」——消费方补一条 go get 即可。

组成

包 做什么 所属 module
registry（模块根） SPI：Registrar/Discoverer/Subscriber/ConfigStore + 实例模型 + 注册地址解析（netutil）。hertz/kitex 适配器面向它编程。v0.4.0 起自 registry/registry 子目录提升至模块根。零第三方依赖 github.com/oekit/registry
nacosimpl Nacos SPI 实现（nacos-sdk-go v2；原 registry/registry/nacos） github.com/oekit/registry/nacosimpl（嵌套模块）
sdbridge 服务发现适配器共享核心（拉取+校验+错误包装），oekit/hertz 与 oekit/kitex 复用 github.com/oekit/registry
registrymocks 四接口的统一测试 mock github.com/oekit/registry
nacos Nacos 客户端门面（nns 默认构造用） github.com/oekit/registry/nacos（嵌套模块）

快速使用

import nacosimpl "github.com/oekit/registry/nacosimpl"

reg, _ := nacosimpl.NewRegistrar(namingCli)    // 服务注册
disc, _ := nacosimpl.NewDiscoverer(namingCli)  // 服务发现

import (
    "github.com/oekit/core/config"   // 本地配置文件（已迁 core）
    nacosreg "github.com/oekit/registry/nacos"
)

cfg, _ := config.LoadBootstrap[MyConfig]("dev") // etc/config-dev.yaml
// Nacos 配置源（实现 core/config.ConfigSource，配 ConfigWatcher 热更新）：
// src := nacosreg.NewConfigClient(...); nacosreg.NewConfigSource(cli, bootstrapCfg)

边界

  • Kitex/Hertz 的注册发现适配器分属 kitex 与 hertz
  • 服务治理高级语义（熔断/换实例重试）在 nns

矩阵总览（24 活跃模块，自动生成）

模块 内容 矩阵内依赖
pkg 微工具集 23 合 1（errors/bloomx/contextx/container/stringx/slicex/enumx/convert/encoding/jsonrepair/httpjson/mathx/pathx/pagination/ptrx/timex/cache/bufiox/strmap/singleflighttest/urlguard/cli/pack；v0.10.0 起 uidgen/validator 拆至 kitx）；errors（v0.12.0 起）New/As/Is/Unwrap 与 stdlib 同型透传——下游哨兵/As 判定单 import 即可，类型同一性红线可完整执行；cache（v0.4.0 起）含缓存接口 CacheAside + BatchGetter 批量能力（MGet）+ LocalCache/SingleFlightCache + cachetest 契约（Run 真实时间 + RunWithClock 假时钟确定性 TTL 边界）+ Checker；LocalCache 时钟可注入（LocalConfig.Now——TTL/NullTTL 全路径确定性测试，v0.13.0 起）；v0.16.0 起 LocalCache 可选形状——NoBackgroundSweep 关闭后台清扫 goroutine（嵌入式/短命进程，公开 Sweep 手动清扫口）、CloneOnRead 读命中返回副本（调用方可改写不污染缓存）、EvictPolicy 可选 LRU（默认 FIFO 不变）、GetEx 区分未命中与值为 nil（新增能力以可选接口 Sweeper/HitGetter 外置，不破坏其它后端）；container（v0.9.0 起，收编原 collectionx）泛型容器 Set/Ring/Queue/SafeMap + Map（sync.Map 背书）/Slice（并发安全）；mathx/jsonrepair（v0.11.0）Unstable 单边向上抖动 Upward / 宽松解析 UnmarshalLenient / 抽对象与抽数组对称原语 ExtractObject·ExtractArray（v0.18.0 起——多段数组与散文含 '{' 的数组文本不再整段作废，取首个口径与对象面一致）；timex/stringx（v0.7.0 起）时间段边界 BeginningOf/EndOf 七对（分/时/日/周/月/季/年，周起始显式参数）+ trie 多模式替换器 Replacer（最长匹配）/ NewMask 敏感词遮罩；stringx Masker（v0.16.0 起）正则脱敏——按形态分类打码（形态标签进掩码供审计读）+ 保留首尾各 ≤4 字符定位线索且不可复原（保留位封顶不随长度变化），规则表由调用方完全提供；singleflighttest（v0.8.0 起）singleflight 共享契约测试套件（internal 与 concurrency 双侧引用）；urlguard（v0.15.0 起）出站 SSRF 防护原语——CheckURL 字面量校验（私网/loopback/链路本地含云元数据 169.254.169.254/CGNAT/ULA/组播保留、.internal·.local·localhost 域名、scheme 白名单、IPv4-mapped IPv6 归一）+ DialFunc 拨号层预解析校验与实际 RemoteAddr 端点核对闭合 TOCTOU（Happy-Eyeballs 覆盖），构造态豁免 WithAllowPrivate/WithAllowCIDRs/WithAllowDomains，与 httpx WithDialFunc 一行组合（httpx#11）；cli（v0.16.0 起）框架无关可单测的子命令分发原语——App/Command + 退出码 0/1/2 写死在包里、usage 按 Summary 自动生成、不读 os.Args 不调 os.Exit（输出流全由调用方给）；pack（v0.16.0 起）迁移包容器原语——zip + manifest（格式版本/条数/每文件 SHA-256）+ JSONL 流式读写 + Inspect 体检一次列全问题并区分包损坏与版本不认识 —
concurrency 并发与流控原语（async/gopool/group/singleflight/progress/syncx/ratelimit/retry）+ window 滑动窗口 / breaker 自适应熔断（规范哨兵 ErrCircuitOpen）/ shedding CPU 自适应降载 / batch 攒批执行器（满条数/满字节/窗口去重）/ timewheel 单级时间轮；v0.5.0 起 retry 指数退避+抖动（MaxDelay 封顶/溢出饱和）、loop 周期原语（忙时丢 tick/单轮 panic 收编/FirstDelay 可打断）、async labeled RunSafe（panic 按任务标签上报）、syncx.FanInErr 逐槽错误（panic 槽显式标记）、KeyedLimiter 增强（容量护栏/RetryAfter/速率热更）并接入 pkg/singleflighttest 契约测试；v0.8.0 起 singleflight DoShared 折叠可观测（Result.Waiters）、async panic 统一收编 typed *PanicError（errors.As 可辨、携带栈）+ 实例级 Runner panic 路由、retry DelayHint（服务端 Retry-After 建议优先）+ JitterRatio 比例抖动 + retry/httpx Retryable 可重试性判定；v0.9.0 起 breaker 显式三态状态机 closed/open/half-open——冷却（WithProbeTimeout 缺省 1m）期满首个放行即半开探测、探测成功关闸清窗/失败重开、失联超时自动回收 + AbandonGen 显式放弃，GenBreaker 代绑定（AllowGen/SuccessGen/FailureGen/AbandonGen：代仅在探测放行自增、陈旧代回报整体作废、开放期失败不后移冷却）；v0.10.0 起 WithCooldown 独立业务冷却期（缺省回落 probeTimeout）+ WithConsecutiveFailures 连续失败计数触发（与速率型并联，补低 QPS 信号，对齐 Envoy consecutive_5xx）；v0.11.0 起 ratelimit Lockout 防爆破锁（fail2ban 形态：滑窗失败计数→阈值锁定拒绝 LockDuration→成功 Reset 清零/到期自解，CheckLocked 返回剩余时长）；v0.12.0 起 retry/httpx RetryableWithHeaders（403 + Retry-After/X-RateLimit-Remaining 头感知可重试判定，HeaderSource 零依赖抽象）、syncx FanInLimit 受限并发扇出（固定 worker 防下游过载）+ FanInLimitCtx（v0.14.0，ctx 感知：ctx 已取消未启动项 fn 一次不调、剩余槽快速排空 Canceled、在飞项照常落槽）、ratelimit WithTokenClock 时钟注入；v0.13.0 起 breaker 熔断期收敛到探测级（forcePass 强制探活 + 冷却期满半开探测，其余拒绝——SRE 公式退役为 closed→open 触发器，WithConsecutiveFailures 触发后流量真停）+ State()/State 枚举可观测出口；v0.16.0 起 ratelimit NewKeyedLimiterByFunc[K]——factory func(K) Limiter 按 key 定配额（一个管理器按接口维度分档位，NewKeyedLimiterOf 零破坏随迁；未登记 key 拿 factory 兜底档的坑已在 doc 点名，#31）；v0.17.0 起 KeyedLimiter.Create 护栏内原子登记（表满先回收空闲与 Allow 同路、仍满拒绝计 OverCapHits、已存在不覆盖——热更走 Replace；解决 ByFunc factory 库锁内调用致消费方锁序倒置，#33）；v0.18.0 起 retry.DoValue 泛型伴生——带返回值的重试（DoValue[T](ctx, cfg, fn func(attempt int) (T, error))；Do 改为委托给 DoValue——退避序列/抖动/MaxDelay 封顶/DelayHint 优先/Retryable 门控/ctx 取消只有一份实现，杜绝「同一个仓里两份实现」；失败返回零值与最后一次错误） pkg
logx 统一日志门面（多后端可替换 + caller 归属；Sink 已迁嵌套模块 logx/sink，根包纯 stdlib）；WithFilter 脱敏/丢弃包装（FilterKey 命中键替换 ***/FilterFunc 丢整条，子 logger 保持规则）、Slogger/SlogHandler 正向桥（三方 slog 直接消费 logx 生态）、TraceHandler 任意 slog.Handler 自动注入 trace_id、NewAuditLogger 审计留痕（级别锁 Info，不受 LOG_LEVEL 降级）、LevelEnabler 热路径提前判级、ParseLogLevel 返回 (Level, error) + ParseLogLevelOr 配错退默认（v0.7.0）；优雅关停正身在 core/lifecycle.Manager（logx/shutdown 仅余 Deprecated 别名）；桥接子包 hlog/hertzlog/kitexlog 为嵌套模块按需引入 core
core 应用基建件——governance 治理 schema、config 配置加载（LoadBootstrap/LoadDotEnv/Get* 系、default/env/range/options tag 校验、OverlaySource 多源叠加热更、ApplyEnvOverlay env 优先 12-factor 形态）、transport 协议无关传输上下文（Transporter/Header/Server·Client ctx 存取，仅标准库）、chain 中间件链（Handler/Middleware/Chain/Recovery/Timeout，与 nns-endpoint.Endpoint 同形）、lifecycle 契约 + Manager 优雅关停（自 logx/shutdown 迁入，日志 *slog.Logger——core 不再依赖 logx）、network IP 工具、version；v0.9.0 起 config FieldSet 显式提供集合（yaml 显式 port:0 不再被 default/env 覆盖——LoadBootstrap 默认接线，免全量指针化）+ require tag（必须 yaml/env 提供，缺失列全并附 env 提示）+ v0.9.1 修 yaml:,inline 字段在 FieldSet 下漏标记（inline 叶子显式零值曾被 default 覆盖）；v0.9.2 env 卫生改纯静态（仅格式/重名，移除依赖进程环境的拼写冒烟检查——误报 PATH/HOME、漏无人设置的真拼错，core#8），命名一致性走 LintEnvNaming 诊断 / WithEnvNamingLint 可选 fail-closed / ignorederived="true" 豁免；v0.10.0 起 config 严格模式——LoadBootstrap[T](envFlag string, opts ...LoadOption) 传 config.WithStrict() 开启：未知键拒载（不再静默忽略），错误带嵌套路径 + 该层合法键清单 + 近似拼写建议（UnknownKeyError）；默认行为不变，严格模式显式开启；v0.11.0 起 config 加载入口按来源拆开——LoadFile（任意路径：CLI -config 路径、容器内固定挂载位）+ Unmarshal（字节源：API 下发 / 模板渲染 / 测试夹具），与 LoadBootstrap（etc/ 约定）共享同一条解码线，因此严格模式诊断面（嵌套路径 / 合法键清单 / 拼写建议）与来源无关；LoadBootstrap 行为与错误文案逐字不变 —
kitx 标识与校验——uidgen（Snowflake 全局单例+Extract 元数据、手写 RFC 4122 v4 UUID 零第三方依赖、RandomHex/RandomString 拒绝采样随机串）+ validator（go-playground/validator v10 接口化门面：struct tag 校验/自定义规则注册/ValidationError Unwrap 为 BizError 400 对接 middleware.Fail）+ hash（v0.2.0 起非密码学哈希助手 Md5Hex/Md5Bytes——缓存键/幂等键/短唯一 code，格式稳定承诺，pkg 2026-09-15 治理移除弱哈希后 kitx 侧收编 pkg#10），自 pkg v0.10.0 拆出 pkg
metrics Prometheus 门面 + 弹性指标族 core
tracing OpenTelemetry 追踪 + trace_id 真相源（v0.3.0 起 OTLP 双协议导出：gRPC 缺省 / HTTP，Config.Protocol + Headers，切换协议不丢传播器/指标/旧 provider 关闭） logx
registry 注册发现核心 + Nacos 实现 + Nacos 配置源 + sdbridge core、logx
data 数据访问门面——复刻 ekit data/ 能力面：cache/rediscache/crud/distlock/gormx/redisx/timertask/cachetest 八子包 re-export（类型同一，实现住 pkg 与各子仓）+ cached 缓存读写编排（写后失效/事务提交后失效/查询缓存版本号失效/GetByIDs 批量点读 MGet 快路径/bloom 防穿透）+ twolevel 两级缓存与跨实例失效广播（v0.7.0 起本仓唯二非 re-export 实现）；v0.15.0 起壳跟随源仓演进——cache 壳补 LocalCache 可选形状（EvictPolicy/Sweeper/HitGetter）、cachetest 壳补 5 个契约套件入口（套件 8 → 13 场景）、timertask 壳的 Redis 形态随源仓 v0.2.0 迁至嵌套模块 timertask/redis（壳不再转发 RedisBackend/ShardManager，Redis 形态直接依赖该嵌套模块）；all/ 聚合模块已废弃 retract concurrency、gormx、logx、pkg、redisx、timertask
gormx SQL/GORM 全家——连接池增强、框架无关 CRUD Service、仓储（原 oekit/gorm，v0.3.0 更名） logx、pkg
redisx Redis 全家——客户端封装（根包）、分布式缓存 cache/、分布式锁 distlock（Locker 同形可互换；Renew 手动续期（false=锁丢失，不进 Locker 接口保 etcdx 互换）+ WithAutoRenew 覆盖 TryLock 自动续期（v0.8.0 feat!：此前组合不续期）；Semaphore ZSET 槽位信号量（v0.8.0：Acquire 同 identifier 幂等刷新 + Lua 内原子清过期槽崩溃自愈、Renew 仅未过期槽可续、Cleanup 返条数、无 Redis 降级 fail-fast））、分布式限流 ratelimit（Lua 三态 + 故障本地兜底）；v0.9.0 起 distlock Lockout 分布式防爆破锁（Redis 侧 fail2ban：滑窗失败计数→阈值锁定 Penalty→Reset 清零，与 concurrency/ratelimit.Lockout 进程内孪生——多实例共享计数是存在理由；惩罚只按首次触发计算、nil client fail-fast 不降级，#6） concurrency、logx、pkg
etcdx etcd 全家——客户端封装（根包：生产默认值/Health 探活/Close(ctx) 幂等）、registry 注册发现实现（SPI 对接 registry/nacos 链路：Lease KeepAlive 注册 + 丢约指数退避自动重注册、prefix Watch 订阅推送、ConfigStore KV 配置监听）、distlock 分布式锁（Session+concurrency.Mutex 公平排队，接口与 redisx/distlock.Locker 同形可互换，可选无 etcd 降级放行） concurrency、logx、registry
httpx HTTP 客户端 + 负载均衡——服务发现/熔断（规范哨兵 ErrCircuitOpen）/重试/指标/OTel 透传；loadbalance Selector 形态（RoundRobin/Random/Weighted/一致性哈希权重感知虚拟副本/p2c 自适应——EWMA 经 DoneFunc 回写建立、Err 计 1s 惩罚；WithFilter 按元数据过滤；v0.4.0 起 Balancer 全家族删除无兼容路径）；codec 注册制编解码器（json 内置 + form 表单，DoCodec 请求按 codec 序列化、响应按 Content-Type 反查回退请求 codec）；v0.6.0 起 net/http 桥接层 NewRoundTripper/StdClient——存量标准库外呼一行 Transport 接入熔断/重试/指标/链路（重试缺省关显式开、非 2xx 非错误、hop-by-hop 隔离，#8）；v0.8.0 起 SafeDialFunc/WithSafeDial 出站 SSRF 防护胶水（判定单源 pkg/urlguard v0.15.0：解析 IP 全量预检 + 实际 RemoteAddr 端点核对闭合重解析 TOCTOU、Happy-Eyeballs 覆盖，构造态豁免；v0.7.0 内置的独立 httpx/urlguard 实现收敛删除，#11） concurrency、logx、metrics、pkg、registry、tracing
network 轻量网络客户端——WebSocket/NATS/MQ 抽象、连接与流工具 concurrency、logx、tracing
timertask 分片定时任务（FNV-1a、心跳续约）；v0.1.5 起可选可靠投递 DeliveryAtLeastOnce（租约 + Ack + 可见性超时；过期租约回扫重投/死信、停机 best-effort 收租，v0.1.7 接入生命周期真正生效）；v0.2.0 起 Redis 后端迁至嵌套模块 timertask/redis（根包不再引 go-redis/logx/concurrency，require 仅 pkg——import timertask 与 import timertask/local 的模块依赖面均无 redis，纯 stdlib 嵌入式场景可用）+ 新增 local 子包 cron 调度器 Scheduler（表达式复用 pkg/timex/cron 不另写一份；并发度/CatchUp 补跑/退出语义明确，FakeClock 假时钟驱动、触发点序列可确定性断言） pkg
middleware Hertz 标准中间件栈（模块根 mw，双层目录已收平）+ contrib 桥接 + hmw + SheddingMiddleware 自适应降载 + chainmw 子包（transport 感知框架无关中间件，基于 core/chain+transport：Recovery 带 panic 隔离上报钩子 WithRecoveryReporter、AccessLog skip+redact+自定义字段、MetadataPropagate——kitex 经 kitex/chainmw.ToKitex 复用同一实现，根包 Recovery/AccessLog 已薄壳化复用 chainmw 内核、下游 handler 可经 transport.FromServerContext 读协议无关传输信息）；v0.6.0 起 accesslog 凭证路径脱敏（WithAccessLogRedactPathPrefixes）、ratelimit 默认 KeyFunc 去端口（连接桶→地址桶）；v0.11.0 起 WithAccessLogSink 落库 sink（AccessRecord{Method,Path,Status,Latency,ClientIP,UserAgent,TraceID} 与日志同源、c 同传可读业务键、error/panic 只记 Warn 不影响主链路、SkipPaths 命中不触发）+ chainmw.WithSink 内核同构（kitex 随 ToKitex 获得）+ StackConfig.DisableResponseWrap 响应自管一键形态（TraceID→Recovery→AccessLog）与 AccessLogOptions 透传 + doc/README「适用边界」段（响应契约统一 vs handler 自管的推荐组合，#18）；v0.12.0 起 AccessLog panic 恢复点产出记录（AccessRecord.Panic 标记 + Err 摘要，Hertz status 按 Recovery 缺省 500）后按原值重抛——panic 请求不再零访问记录，sink/kitex 桥接同步留痕，#20 concurrency、core、logx、metrics、pkg、registry、tracing
k8s Kubernetes 客户端封装——RESTConfig/Clientset/DynamicClient 构建（显式 kubeconfig → in-cluster 自动 → KUBECONFIG/~/.kube/config 逐级回退，QPS/Burst 限流默认 50/100）+ leaderelection 子包 Lease 选主简化封装（OnStartedLeading/OnStoppedLeading/OnNewLeader 回调，主备单活，仅要求 Lease CRUD 权限） logx
nns NNS 服务治理客户端——provider 无关发现/配置/实例缓存 concurrency、core、logx、registry
nns-endpoint NNS 端点工厂——per-service 熔断、换实例重试、gRPC 池 httpx、logx、metrics、nns、registry
bootstrap 应用生命周期引导——New(WithServiceName/WithShutdownTimeout/WithBeforeServe) + Run(fn) + healthz；App.Ready/ReadyChan/IsReady 就绪门（幂等并发安全）——嵌套 bootstrap/nacos 自 v0.3.0 起 NNS 注册延迟到 Ready 之后（server 就绪 → userFn 触发 Ready → 才进注册中心）、关停序 nns 反注册先于 server 关闭；Metrics/Tracing 在嵌套模块 bootstrap/obs concurrency、core、logx
hertz Hertz 运行时集成（模块根扁平化）——日志桥接、生命周期、SSE/health/metrics、适配器、OTel、crudh/validatorh（基于 kitx/validator）/versionh（原 handler 微库收编）；RunServer 变参就绪门 WithOnReady（全部 HostPort TCP 探活可建连后回调，探活超时按启动失败优雅关机；缺省超时 5s 经 WithReadyProbeTimeout 调整——探活目标是 server 自动取到的全部 HostPort，无探活地址覆盖选项（kitex 侧才有 WithReadyAddr）），配合 bootstrap Ready 实现 NNS 延迟注册；transportx（hertz→core/transport 同构适配器）+ chainmw 桥接 bootstrap、concurrency、core、gormx、kitx、logx、metrics、middleware、nns、pkg、registry、tracing
kitex Kitex 生态——日志桥接、治理热更、生命周期、BizError 桥接、kitexotel、istio（xDS 动态熔断，原 istio 微库收编）；RunServer 变参就绪门（WithOnReady/WithReadyAddr/WithReadyProbeTimeout）+ chainmw.ToKitex（core/chain.Middleware → kitex 中间件，与 hertz 共享 middleware/chainmw 实现）+ transportx bootstrap、concurrency、core、logx、metrics、nns、pkg、registry
workflow 组合式流程编排——串行/并行/异步/条件分支 + Hook AOP concurrency、logx
kitex-examples Kitex echo 示例——client/server + IDL + 治理配置 bootstrap、core、kitex、logx、registry、tracing

依赖严格自底向上；微库已合并为 pkg，旧微库仓已删除。

本仓在矩阵中的位置与依赖见上表「矩阵内依赖」列。历史沿革：源自 ekit 单体库 （git.enjoye.top/enjoydream/ekit v0.34.0，冻结维护），2026-10 拆分为独立 module。

License

MIT — 见 LICENSE

Documentation

Overview

Package registry 提供与服务注册中心无关的服务注册与发现抽象接口。

本包定义核心接口（Registrar、Discoverer、Subscriber、ConfigStore）， 不依赖任何具体的注册中心 SDK。各注册中心（如 Nacos）的实现放在**嵌套模块**里 （github.com/oekit/registry/nacos、github.com/oekit/registry/nacosimpl）—— 它们各自把 Nacos SDK 的重依赖隔离在模块边界之外，父仓保持零第三方依赖。

注意：registry 是底层 SPI 和框架薄适配，只供 NNS、测试、极简接入使用。 不包含缓存、降级、singleflight 等治理能力。新服务推荐通过 nns 包接入。

设计目标

  • 解耦：上层（如 nns 包）依赖接口而非具体 SDK，便于测试和替换实现。
  • 可测试：通过接口可以轻松注入 mock，解决上层核心逻辑难以测试的问题。
  • 可扩展：未来新增 etcd/consul/k8s 等实现时，上层无需改动。

三层架构 

registry/nacos        Nacos 客户端封装（嵌套模块：Bootstrap 配置、client 工厂、config 加载）
registry              provider 无关的抽象接口（本包，根模块）
registry/nacosimpl    Nacos 实现（嵌套模块：封装 naming_client/config_client）

上层门面 nns 依赖 registry 接口，默认使用 registry/nacosimpl 实现， 也可通过依赖注入替换为 mock 或其他 provider。

快速接入

使用 Nacos 实现： 

reg, err := nacosimpl.NewRegistrar(namingClient, nacosimpl.WithGroup("DEFAULT_GROUP"))
if err != nil {
    log.Fatal(err)
}
err = reg.Register(ctx, registry.Instance{
    Service:  "my-service",
    IP:       "10.0.0.1",
    Port:     8080,
    Metadata: version.Metadata(),
})

发现服务实例： 

disc, err := nacosimpl.NewDiscoverer(namingClient)
instances, err := disc.Discover(ctx, "user-service")

Index

Constants

This section is empty.

Variables

View Source 
var ErrNoInstances = errors.New("registry: no instances found")

ErrNoInstances 表示服务发现未找到任何实例。

Functions

func EncodeTargetTags 

func EncodeTargetTags(host string, tags map[string]string) string

EncodeTargetTags 将 host 和 tags 编码为确定性的缓存 key。 tags 的 key 按字典序排序，确保相同 tags 产生相同结果（Go map 迭代顺序不确定）。 当 tags 为空时直接返回 host。

func ParseAddr 

func ParseAddr(addr net.Addr) (string, int, error)

ParseAddr 从 net.Addr 解析出 IP 和端口号。 当 host 为未指定地址（空、"::" 或 "0.0.0.0"——kitex/hertz 对 ":9090" 这类 通配监听时，listener.Addr() 与 WithServiceAddr 会产生这些形式）时， 自动使用 network.GetPodIP() 获取本机 IP（支持 K8s POD_IP），保证注册出去 的实例地址对其他节点可拨号。 这是 ekit 中解析注册地址的唯一实现，kitex/registry、hertz/registry、kitex/nns 应委托至此，避免逻辑重复。

Types

type ConfigStore 

type ConfigStore interface {
	// GetConfig 拉取指定 dataID 的配置内容。
	//
	// 返回空字符串表示配置不存在（非错误）。
	GetConfig(ctx context.Context, dataID, group string) (string, error)

	// ListenConfig 监听指定 dataID 的配置变更，内容变化时回调 onChange。
	//
	// onChange 接收最新的配置内容字符串。实现应确保回调在独立 goroutine
	// 中执行或不会阻塞监听循环。
	ListenConfig(ctx context.Context, dataID, group string, onChange func(data string)) error

	// StopListenConfig 停止监听指定 dataID 的配置变更。
	StopListenConfig(ctx context.Context, dataID, group string) error
}

ConfigStore 提供服务配置的拉取和动态监听能力。

这与服务发现（Discoverer/Subscriber）是正交关注点： 服务发现返回实例列表（IP/Port），而 ConfigStore 返回服务的运行时配置 （如超时、重试、负载均衡策略等，通常以 JSON 等格式存储）。

nns 包的 ServiceClient 同时使用 ConfigStore 和服务发现接口， 将配置和实例信息组合为完整的 ServiceBasic。

type Discoverer 

type Discoverer interface {
	// Discover 根据服务名称返回健康实例列表。
	Discover(ctx context.Context, serviceName string) ([]Instance, error)

	// DiscoverAll 根据服务名称返回全部实例列表（包括不健康的实例）。
	// 用于调试、监控等场景；生产调用应优先使用 Discover。
	DiscoverAll(ctx context.Context, serviceName string) ([]Instance, error)
}

Discoverer 提供服务实例的拉取发现能力。

type Instance 

type Instance struct {
	// Service 是服务名称。
	Service string
	// IP 是实例的 IP 地址。
	IP string
	// Port 是实例的端口。
	Port int
	// Weight 是实例的权重，用于加权负载均衡。
	Weight float64
	// Metadata 是实例的元数据，可携带版本、颜色、区域等信息。
	Metadata map[string]string
	// Group 是分组名称。空值时使用 Registrar 的默认 Group。
	Group string
	// Cluster 是集群名称。空值时使用 Registrar 的默认 Cluster。
	Cluster string
}

Instance 表示注册中心中的一个服务实例，与具体 provider 无关。

func InfoFrom 

func InfoFrom(name string, addr net.Addr, weight, defaultWeight int, tags map[string]string) (Instance, error)

InfoFrom 从通用字段构造 Instance，内部调用 ParseAddr 解析地址。

name 是服务名称，addr 是注册地址（如 *net.TCPAddr）， weight 是实例权重（<=0 时使用 defaultWeight），tags 是元数据。 defaultWeight 用于 weight<=0 的回退值。

func (Instance) Addr 

func (i Instance) Addr() string

Addr 返回实例的地址字符串，格式为 "IP:Port"。

type RegisterOption 

type RegisterOption struct {
	// Weight 是实例权重，默认 10。
	Weight float64
	// Metadata 是实例元数据。
	Metadata map[string]string
	// Cluster 是集群名称（部分 provider 支持）。
	Cluster string
	// Group 是分组名称（部分 provider 支持）。
	Group string
}

RegisterOption 是服务注册的可选配置，与具体 provider 无关。

各 provider 实现会将这些字段映射到自身 SDK 的参数。 如果某个字段在目标 provider 中不存在，实现应安全地忽略它。

func Apply 

func Apply(opts ...RegisterOptionFunc) *RegisterOption

Apply 将多个选项函数应用到一个新的 RegisterOption 上，返回最终配置。

用法： 

opt := Apply(registry.WithWeight(20), registry.WithMetadata(meta))

type RegisterOptionFunc 

type RegisterOptionFunc func(*RegisterOption)

RegisterOptionFunc 是配置 RegisterOption 的函数选项类型。

func WithCluster 

func WithCluster(cluster string) RegisterOptionFunc

WithCluster 设置服务实例所属的集群名称。

func WithGroup 

func WithGroup(group string) RegisterOptionFunc

WithGroup 设置服务实例所属的分组名称。

func WithMetadata 

func WithMetadata(metadata map[string]string) RegisterOptionFunc

WithMetadata 设置服务实例的元数据。

多次调用会合并而非覆盖。

func WithWeight 

func WithWeight(weight float64) RegisterOptionFunc

WithWeight 设置服务实例的权重。

type Registrar 

type Registrar interface {
	// Register 将服务实例注册到注册中心。
	Register(ctx context.Context, inst Instance) error
	// Deregister 从注册中心注销服务实例。
	Deregister(ctx context.Context, inst Instance) error
}

Registrar 提供服务实例的注册和注销能力。

type Subscriber 

type Subscriber interface {
	// Subscribe 订阅指定服务的实例变更，当实例列表变化时回调 cb。
	Subscribe(ctx context.Context, serviceName string, cb func([]Instance)) error
	// Unsubscribe 取消订阅指定服务的实例变更。
	Unsubscribe(ctx context.Context, serviceName string) error
}

Subscriber 提供服务实例变更的订阅推送能力。

Source Files

View all Source files

Directories

Path Synopsis
nacos module
nacosimpl module
Package registrymocks 提供 registry 包 4 个接口（Registrar/Discoverer/Subscriber/ConfigStore） 的统一 mock 实现，供单元测试使用（原为 ekit internal 包，拆分后跨模块复用故公开）。
 Package registrymocks 提供 registry 包 4 个接口（Registrar/Discoverer/Subscriber/ConfigStore） 的统一 mock 实现，供单元测试使用（原为 ekit internal 包，拆分后跨模块复用故公开）。
Package sdbridge 提供服务发现适配器的框架无关共享核心。
 Package sdbridge 提供服务发现适配器的框架无关共享核心。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.