kitex-examples

README

kitex-examples

Kitex echo 示例——client/server + Thrift IDL + 治理配置样例。

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

本仓库是 ekit 拆分矩阵的成员（Round-3 自 ekit-kitex 迁出）， 使 ekit-kitex 主模块不再依赖 bootstrap 全链。

能做什么

• 真实 codegen：thrift IDL → kitex_gen，业务实现 EchoService 接口
• 双端齐备：server（Kitex Registry 注册）+ client（Discoverer 发现）
• 治理样例：configs/ 下 retry/rpc_timeout/limit JSON 样例
• 零 Nacos 也能跑：mock/静态实例配置

使用示例

运行

go run ./server  # 先起 server
go run ./client  # 再起 client

IDL 在 idl/echo.thrift，改完用 kitex 工具重新生成 kitex_gen。

结构

• kitex_gen/ — thrift 生成的 echo 服务代码
• client/、server/ — 示例客户端与服务端（接入 bootstrap + Nacos + 治理配置）
• idl/echo.thrift — IDL
• configs/ — retry/rpc_timeout/limit 治理配置样例

运行

go run ./server    # 先起 server（注册到 Nacos / mock 模式）
go run ./client

依赖：ekit-kitex、ekit-bootstrap、ekit-registry、ekit-logx、ekit-tracing。

License

见 LICENSE

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

模块	内容	矩阵内依赖
pkg	微工具集 16 合 1（errors/validator/stringx/slicex/enumx/convert/encoding/jsonrepair/httpjson/mathx/pathx/pagination/ptrx/timex/uidgen/cache）	—
concurrency	并发与流控原语（async/group/singleflight/progress/syncx/ratelimit/retry）	—
logx	统一日志门面（多后端可替换 + Sink + caller 归属）+ 优雅关停	—
core	应用基建件（governance 治理 schema / lifecycle 契约 / network IP 工具 / version）	—
istio	Istio Proxyless——Kitex xDS 动态熔断	—
metrics	Prometheus 门面 + 弹性指标族	core
tracing	OpenTelemetry 追踪 + trace_id 真相源	logx
registry	注册发现核心 + Nacos 实现 + 配置加载 + sdbridge	core、logx
data	缓存检查器（TTL/failTTL/inflight 合并）+ LocalCache	concurrency、logx
gorm	SQL/GORM 全家——连接池增强、框架无关 CRUD Service、仓储	logx、pkg
redis	Redis 全家——客户端封装、缓存后端、分布式锁	concurrency、data、logx
httpx	HTTP 客户端 + 负载均衡——服务发现/熔断/重试/指标/OTel 透传	concurrency、core、logx、metrics、registry、tracing
network	轻量网络客户端——WebSocket/NATS/MQ 抽象、连接与流工具、Octopus 推送	concurrency、logx、tracing
timertask	分片定时任务（FNV-1a、心跳续约）	concurrency、logx
middleware	Hertz 自研标准中间件栈 + contrib 桥接 + hmw	concurrency、core、logx、metrics、pkg、registry、tracing
nns	NNS 服务治理客户端——provider 无关发现/配置/实例缓存	concurrency、core、logx、registry
nns-endpoint	NNS 端点工厂——per-service 熔断、换实例重试、gRPC 池	concurrency、core、httpx、logx、metrics、nns、registry
bootstrap	应用生命周期引导——bootstrap.Run 骨架 + healthz	concurrency、logx
handler	HTTP handler 层——通用 CRUD Handler、参数绑定、版本端点	concurrency、core、gorm、logx、metrics、middleware、pkg、registry、tracing
hertz	Hertz 运行时集成——日志桥接、生命周期、SSE/health/metrics、适配器、OTel	bootstrap、concurrency、core、logx、metrics、nns、registry、tracing
kitex	Kitex 生态——日志桥接、治理热更、生命周期、BizError 桥接、kitexotel	bootstrap、concurrency、core、logx、metrics、nns、pkg、registry
workflow	组合式流程编排——串行/并行/异步/条件分支 + Hook AOP	concurrency、logx
kitex-examples	Kitex echo 示例——client/server + IDL + 治理配置	bootstrap、concurrency、core、kitex、logx、metrics、nns、registry、tracing

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