middleware

README

middleware

Hertz 标准中间件栈——一键标准栈/统一错误出口/contrib 桥接

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

安装

go get github.com/oekit/middleware@v0.2.0

这个仓库做什么

middleware 是 Hertz 自研标准中间件栈 + 社区库桥接：一组生产调过参的中间件 （统一响应格式、限流、认证、访问日志、panic recovery）加上 hertz-contrib 生态的桥接层。

组成

包	做什么
middleware（包名 mw）	DefaultMiddleware 一键标准栈：TraceID → Recovery → Response → AccessLog（零指标强制）；另有 Prometheus 指标/RateLimit/BearerTokenAuth/I18n/Fail 等
contrib	hertz-contrib 桥接：JWT/Sessions/Swagger/CSRF/pprof/Debug/Gzip/ETag/BasicAuth/ReverseProxy/Sentinel/Lark
hmw	requestid/trace_id 注入 RequestContext

快速使用

import mw "github.com/oekit/middleware/middleware"

// 标准栈一键注册（顺序已调好，零指标强制）
for _, m := range mw.DefaultMiddleware(mw.StackConfig{SkipPaths: []string{"/healthz"}}) {
    h.Use(m)
}

// 需要 HTTP 指标时显式拼在栈最前（Registry 缺省 nil = ekit 统一注册表）
pm := mw.NewPrometheusMetrics(mw.PrometheusConfig{Namespace: "myapp", ServiceName: "my-service"})
h.Use(pm.Middleware())

统一错误出口

func getOrder(ctx context.Context, c *app.RequestContext) {
    ord, err := svc.Get(ctx, id)
    if err != nil {
        mw.Fail(ctx, c, err) // BizError→业务码；NotFound→404；兜底 500 + 结构化日志
        return
    }
}

边界

• Hertz 运行时（日志桥接/生命周期/SSE）在 hertz
• mw.Fail 识别的 BizError 定义在 pkg/errors——整条链路必须用同一套 errors（类型同一性红线）

矩阵总览

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

模块	内容	矩阵内依赖
pkg	微工具集 16 合 1（errors/validator/stringx/…）	—
concurrency	并发与流控原语	—
logx	日志门面 + shutdown	—
core	应用基建件	—
istio	Istio XDS	—
metrics	Prometheus 门面	core
tracing	OTel + traceid	logx
registry	注册发现 + Nacos + 配置	core、logx
data	缓存检查器	concurrency、logx
gorm	SQL/CRUD	logx、pkg
redis	Redis 全家	concurrency、data、logx
httpx	HTTP 客户端	concurrency、core、logx、metrics、registry、tracing
network	轻量网络件	concurrency、logx、tracing
timertask	定时任务	concurrency、logx
middleware	Hertz 中间件栈	concurrency、core、logx、metrics、pkg、registry、tracing
nns	服务治理门面	concurrency、core、logx、registry
nns-endpoint	端点熔断重试	concurrency、core、httpx、logx、metrics、nns、registry
bootstrap	应用引导	concurrency、logx
handler	CRUD handler	concurrency、core、gorm、logx、metrics、middleware、pkg、registry、tracing
hertz	Hertz 运行时	bootstrap、concurrency、core、logx、metrics、nns、registry、tracing
kitex	Kitex 生态	bootstrap、concurrency、core、logx、metrics、nns、pkg、registry
workflow	流程编排	concurrency、logx
kitex-examples	Kitex 示例	bootstrap、concurrency、core、kitex、logx、metrics、nns、pkg、registry、tracing

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

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

License

MIT — 见 LICENSE