package
module
Version:
v0.1.1
Opens a new window with list of versions in this module.
Published: Oct 17, 2026
License: MIT
Opens a new window with license information.
Imports: 0
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
README
¶
kitx
标识与校验——Snowflake / UUID / 随机串 + go-playground/validator 门面
🌐 项目主页:https://oekit.github.io/ · 名称由来:Open Easy Kit(开源 · 易用 · 工具集合)
🤖 AI Agent:本仓规范与硬规则见 AGENTS.md;机器可读索引见 llms.txt(接口签名以源码为准)。
安装
go get github.com/oekit/kitx@v0.1.0
这个仓库做什么
kitx 是 标识与校验 工具仓(自 oekit/pkg v0.10.0 拆出,pkg 本体自此零第三方依赖):
uidgen —— 分布式唯一 ID 与随机串:Snowflake(全局单例 + Extract 元数据提取)、
RFC 4122 v4 UUID(标准库手写,零第三方依赖,语义与 google/uuid 对齐)、
crypto/rand 随机串(RandomHex / 拒绝采样 RandomString,无 mod 偏置)
validator —— go-playground/validator 的接口化门面:struct tag 校验、
自定义规则注册、ValidationError(Unwrap 为 pkg/errors BizError 400,
middleware.Fail 自动映射 HTTP 400)
组成
| 包 |
import 路径 |
做什么 |
uidgen |
github.com/oekit/kitx/uidgen |
InitSnowflake(machineID) / SnowflakeID()(不返错,auto-init 兜底)+ ExtractSnowflake* 元数据;UUID/ShortUUID/UUIDToUpper/ShortUUIDToUpper/UUIDWithHyphen(手写 v4,零第三方);RandomHex(n) / RandomString(alphabet, n)(crypto/rand,拒绝采样) |
validator |
github.com/oekit/kitx/validator |
Validate(obj) / ValidateVar(field, tag)(struct tag);RegisterValidation(⚠️ 仅限 init 阶段,底层注册非并发安全);ValidationError.Errors()/Map()/Len() 结构化字段错误;SetDefault/Default 可替换实现(atomic.Pointer 并发安全) |
快速使用
import (
"github.com/oekit/kitx/uidgen"
"github.com/oekit/kitx/validator"
)
// 唯一 ID
uidgen.InitSnowflake(7) // 一次性初始化, machineID ∈ [0, 1023]
id := uidgen.SnowflakeID() // int64
uid := uidgen.UUID() // 32 位无连字符 v4 UUID
secret := uidgen.RandomHex(32) // 64 字符高熵随机串
// 参数校验
type CreateUserReq struct {
Name string `json:"name" validate:"required,min=1,max=100"`
Email string `json:"email" validate:"required,email"`
}
if err := validator.Validate(&req); err != nil {
var ve *validator.ValidationError
if errors.As(err, &ve) {
// ve.Map() → field→message,直接喂 JSON 响应
}
}
设计说明
- 为什么 validator 依赖
pkg/errors:ValidationError.Unwrap 返回
BizError(400),让 middleware.Fail / gormx / kitex bridge 的错误映射链
把参数错误归为 HTTP 400 而非 500——这是行为契约,不能断。
- 为什么 UUID 手写:v4 只需 16 随机字节 + version/variant 位,引整个
google/uuid(解析/各版本/marshal)为单一生成场景不划算,且少一个
dependabot 升级通道。
矩阵总览(24 活跃模块,自动生成)
| 模块 |
内容 |
矩阵内依赖 |
| pkg |
微工具集 19 合 1(errors/bloomx/contextx/container/stringx/slicex/enumx/convert/encoding/jsonrepair/httpjson/mathx/pathx/pagination/ptrx/timex/cache/bufiox/strmap;v0.10.0 起 uidgen/validator 拆至 kitx);cache(v0.4.0 起)含缓存接口 CacheAside + BatchGetter 批量能力(MGet)+ LocalCache/SingleFlightCache + cachetest 契约 + Checker;container(v0.9.0 起,收编原 collectionx)泛型容器 Set/Ring/Queue/SafeMap + Map(sync.Map 背书)/Slice(并发安全);timex/stringx(v0.7.0 起)时间段边界 BeginningOf/EndOf 七对(分/时/日/周/月/季/年,周起始显式参数)+ trie 多模式替换器 Replacer(最长匹配)/ NewMask 敏感词遮罩;singleflighttest(v0.8.0 起)singleflight 共享契约测试套件(internal 与 concurrency 双侧引用) |
— |
| concurrency |
并发与流控原语(async/gopool/group/singleflight/progress/syncx/ratelimit/retry)+ window 滑动窗口 / breaker 自适应熔断(规范哨兵 ErrCircuitOpen)/ shedding CPU 自适应降载 / batch 攒批执行器(满条数/满字节/窗口去重)/ timewheel 单级时间轮 |
pkg |
| logx |
统一日志门面(多后端可替换 + Sink + caller 归属)+ 优雅关停;桥接子包 hlog/hertzlog/kitexlog 为嵌套模块按需引入 |
— |
| core |
应用基建件(governance 治理 schema / config 配置加载 + default/env/range/options tag 校验 / lifecycle 契约 / network IP 工具 / version) |
— |
| kitx |
标识与校验——uidgen(Snowflake 全局单例+Extract 元数据、手写 RFC 4122 v4 UUID 零第三方依赖、RandomHex/RandomString 拒绝采样随机串)+ validator(go-playground/validator v10 接口化门面:struct tag 校验/自定义规则注册/ValidationError Unwrap 为 BizError 400 对接 middleware.Fail),自 pkg v0.10.0 拆出 |
pkg |
| metrics |
Prometheus 门面 + 弹性指标族 |
core |
| tracing |
OpenTelemetry 追踪 + trace_id 真相源 |
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 实现);all/ 聚合模块已废弃 retract |
concurrency、gormx、logx、pkg、redisx、timertask |
| gormx |
SQL/GORM 全家——连接池增强、框架无关 CRUD Service、仓储(原 oekit/gorm,v0.3.0 更名) |
logx、pkg |
| redisx |
Redis 全家——客户端封装(根包)、分布式缓存 cache/、分布式锁 distlock、分布式限流 ratelimit(Lua 三态 + 故障本地兜底) |
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、core、logx、registry |
| httpx |
HTTP 客户端 + 负载均衡——服务发现/熔断(规范哨兵 ErrCircuitOpen)/重试/指标/OTel 透传/一致性哈希(权重感知虚拟副本) |
concurrency、core、logx、metrics、registry、tracing |
| network |
轻量网络客户端——WebSocket/NATS/MQ 抽象、连接与流工具 |
concurrency、logx、tracing |
| timertask |
分片定时任务(FNV-1a、心跳续约) |
concurrency、logx |
| middleware |
Hertz 自研标准中间件栈 + contrib 桥接 + hmw + SheddingMiddleware 自适应降载 |
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 池 |
concurrency、core、httpx、logx、metrics、nns、registry |
| bootstrap |
应用生命周期引导——bootstrap.Run 骨架 + healthz |
concurrency、logx |
| hertz |
Hertz 运行时集成——日志桥接、生命周期、SSE/health/metrics、适配器、OTel、crudh/validatorh/versionh(原 handler 微库收编) |
bootstrap、concurrency、core、gormx、kitx、logx、metrics、middleware、nns、pkg、registry、tracing |
| kitex |
Kitex 生态——日志桥接、治理热更、生命周期、BizError 桥接、kitexotel、istio(xDS 动态熔断,原 istio 微库收编) |
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、pkg、registry、tracing |
Documentation
¶
Package kitx 是 oekit 的标识与校验工具仓。
自 oekit/pkg v0.10.0 拆分而来,包含两个子包:
- uidgen:分布式唯一 ID(Snowflake 全局单例 + Extract 元数据)、
RFC 4122 v4 UUID(标准库手写,零第三方依赖)、crypto/rand 随机串
(RandomHex / 拒绝采样 RandomString)
- validator:go-playground/validator 接口化门面——struct tag 校验、
自定义规则注册、ValidationError(Unwrap 为 pkg/errors BizError 400,
middleware.Fail 自动映射 HTTP 400)
基础微工具(errors/stringx/timex/container 等)仍在 github.com/oekit/pkg。
Source Files
¶
Directories
¶
Package uidgen 提供分布式唯一 ID 生成器.
|
Package uidgen 提供分布式唯一 ID 生成器. |
Package validator 提供统一的参数验证能力。
|
Package validator 提供统一的参数验证能力。 |
Click to show internal directories.
Click to hide internal directories.