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

kitex

module
v0.3.5 Latest Latest
Warning

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

Go to latest
Published: Oct 15, 2026 License: MIT

README

kitex

Kitex RPC 生态——日志桥接、治理热更、生命周期、BizError 桥接、方法级指标与 OTel。

项目主页:https://oekit.github.io/oekit/ · 名称由来:Open Easy Kit(开源 · 易用 · 工具集合)

本仓库是 ekit(git.enjoye.top/enjoydream/ekit v0.34.0) 拆分出的独立 Go module,属于 oekit oekit(Open Easy Kit)模块矩阵。

安装

go get github.com/oekit/kitex@v0.3.4

包清单

  • `kitex/` — klog→logx 桥接、GovernanceConfig(Nacos 热更)、RunServer、WithBizErrorBridge、PanicLogMiddleware、NewServerTracingSuite
  • `kitex/kitexmeta/` — trace_id + metainfo 跨 RPC 透传
  • `registry/kitex/`、`nns/kitex/` — Kitex 注册发现适配器
  • `observability/metrics/instrumentation/kitexprom/` — 方法级 RPC 指标
  • `observability/tracing/instrumentation/kitexotel/` — OTel server/client suite
  • `examples/` — kitex echo 示例;`internal/e2e/` — e2e 生成代码

Istio Proxyless 已迁 ekit-istio;echo 示例已迁 ekit-kitex-examples——本仓库生产代码不再依赖 bootstrap 链(go.mod 中 bootstrap require 仅供本仓测试用例引用,消费者构建图不含它)。

矩阵总览(20 活跃仓 + 19 微库,自动生成)

仓库 内容 矩阵内依赖
ekit-bootstrap (见 README) ekit-bootstrap, ekit-concurrency, ekit-core, ekit-logx, ekit-metrics, ekit-nns, ekit-registry, ekit-tracing
ekit-cache 进程内缓存微库——LRU O(1)、TOCTOU 修复的 LocalCache —
ekit-concurrency (见 README) ekit-concurrency
ekit-convert 类型转换微库——字符串/数字/布尔/切片的宽容转换 —
ekit-core Go 后端基础工具库——应用基建件(governance 治理 schema / lifecycle 生命周期契约 / network IP 工具 / version) ekit-core
ekit-data (见 README) ekit-concurrency, ekit-logx
ekit-encoding 编解码微库——JSON/msgpack 等序列化助手 —
ekit-enumx 枚举工具微库——确定性顺序的 All/Values/解析 —
ekit-errors 错误处理微库——Wrap/Cause 链、BizError(业务码/HTTP 码双轨)、sentinel 错误 —
ekit-gorm (见 README) ekit-errors, ekit-gorm, ekit-logx, ekit-pagination
ekit-handler (见 README) ekit-core, ekit-errors, ekit-gorm, ekit-handler, ekit-middleware, ekit-pagination, ekit-tracing, ekit-validator
ekit-hertz (见 README) ekit-concurrency, ekit-core, ekit-hertz, ekit-logx, ekit-metrics, ekit-nns, ekit-registry, ekit-tracing
ekit-httpjson HTTP JSON 微库——DoJSON 带 retry 语义与 Retry-After 尊重 ekit-stringx
ekit-httpx (见 README) ekit-concurrency, ekit-httpx, ekit-logx, ekit-metrics, ekit-registry
ekit-istio (见 README) —
ekit-jsonrepair JSON 修复微库——宽容修复链:截断/尾逗号/单引号/非标准值归一 —
ekit-kitex (见 README) ekit-concurrency, ekit-core, ekit-errors, ekit-kitex, ekit-logx, ekit-metrics, ekit-nns, ekit-registry, ekit-tracing
ekit-kitex-examples (见 README) ekit-bootstrap, ekit-kitex, ekit-kitex-examples, ekit-logx, ekit-registry, ekit-tracing
ekit-logx (见 README) ekit-logx
ekit-mathx 数学工具微库——安全随机、区间、平均值等评测统计助手 —
ekit-metrics (见 README) ekit-core, ekit-metrics
ekit-middleware (见 README) ekit-concurrency, ekit-errors, ekit-logx, ekit-metrics, ekit-middleware, ekit-pathx, ekit-registry, ekit-tracing
ekit-network (见 README) ekit-concurrency, ekit-logx, ekit-tracing
ekit-nns (见 README) ekit-concurrency, ekit-core, ekit-logx, ekit-nns, ekit-registry
ekit-nns-endpoint NNS 端点工厂——per-service 熔断(4xx 不计失败)、HTTP 换实例重试、gRPC 连接池、弹性指标 ekit-httpx, ekit-logx, ekit-metrics, ekit-nns, ekit-registry
ekit-pagination 分页微库——PageRequest/PageResponse 与换算 —
ekit-pathx 路径匹配微库——glob(vendor/**、*.test)匹配 —
ekit-ptrx 指针工具微库——To/From/安全解引用 —
ekit-redis (见 README) ekit-concurrency, ekit-data, ekit-logx, ekit-redis
ekit-registry (见 README) ekit-core, ekit-logx, ekit-registry
ekit-slicex 切片工具微库——Partition 二分组、GroupBy、去重与映射 —
ekit-stringx 字符串工具微库——ID 生成、关键词匹配、缩进、复数化、模板替换 —
ekit-timertask 定时任务微库——分片定时任务(FNV-1a hash、心跳续约) ekit-concurrency, ekit-logx
ekit-timex 时间工具微库——格式化/解析/时间戳 + cron 表达式 —
ekit-tracing (见 README) ekit-logx
ekit-uidgen ID 生成微库——UUID、雪花、随机串 —
ekit-validator 参数校验微库——go-playground/validator 封装,ValidationError 归一为 BizError(400) ekit-errors
ekit-workflow (见 README) ekit-concurrency, ekit-logx

ekit-observability 已在 Round-2 解散归档;本表由源码 import 自动生成。 依赖严格单向:工具微库/L0 → 可观测门面 → registry → data/httpx/middleware → nns/bootstrap → hertz/kitex。

当前仓库依赖

详见上方矩阵表中本仓库行。

与 ekit 单体仓库的关系

  • 代码与 ekit v0.34.0 等价,module 路径 git.enjoye.top/enjoydream/ekit/... → github.com/oekit/kitex/...
  • 各子仓库独立发版(SemVer);开发规范沿用 ekit AGENTS.md 约定

License

见 LICENSE

Directories

Path Synopsis
internal
e2e/kitex_gen/kitex/echo/echoservice
Code generated by Kitex v0.16.3.
Code generated by Kitex v0.16.3.
istio module
Package kitex 为 CloudWeGo Kitex RPC 框架提供 ekit 生态集成。
Package kitex 为 CloudWeGo Kitex RPC 框架提供 ekit 生态集成。
kitexmeta
Package kitexmeta 桥接 kitex transmeta 体系 + ekit traceid,让 trace_id / 用户身份 / 空间码等业务元数据在 kitex server 入口注入 到 ctx,通过 kitex client transmeta 自动透传到下游 server。
Package kitexmeta 桥接 kitex transmeta 体系 + ekit traceid,让 trace_id / 用户身份 / 空间码等业务元数据在 kitex server 入口注入 到 ctx,通过 kitex client transmeta 自动透传到下游 server。
nns
kitex
Package kitex 提供 NNS 门面到 CloudWeGo Kitex 框架的适配器。
Package kitex 提供 NNS 门面到 CloudWeGo Kitex 框架的适配器。
observability
metrics/instrumentation/kitexprom
Package kitexprom 桥接 kitex-contrib/monitor-prometheus,为 Kitex 提供 方法级 RPC 指标(吞吐/时延,labels 含 caller/callee/method/status/retry)。
Package kitexprom 桥接 kitex-contrib/monitor-prometheus,为 Kitex 提供 方法级 RPC 指标(吞吐/时延,labels 含 caller/callee/method/status/retry)。
tracing/instrumentation/kitexotel
Package kitexotel 提供 Kitex 客户端/服务端的 metainfo propagation 启用 helper,以及 OTel 链路透传(通过 metainfo carrier)选项。
Package kitexotel 提供 Kitex 客户端/服务端的 metainfo propagation 启用 helper,以及 OTel 链路透传(通过 metainfo carrier)选项。
registry
kitex
Package kitex 提供 ekit registry 抽象到 CloudWeGo Kitex 框架的适配器。
Package kitex 提供 ekit registry 抽象到 CloudWeGo Kitex 框架的适配器。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL