讲师中心 微信公众号
AI工具推荐 视频效率加速

Gin框架自定义Logger中间件输出JSON格式日志

雨瑶大大_3382

雨瑶大大_3382

发布时间:2026-08-25 08:57:00

|

696人浏览过

|

来源于php中文网

原创

因为Gin默认Logger中间件专为开发调试设计,输出可读性优先的固定文本格式,不支持结构化输出,无法被ELK等工具解析,且未暴露响应状态码等底层字段供JSON组装。

gin框架自定义logger中间件输出json格式日志

为什么 Gin 默认 Logger 中间件不输出 JSON?

Gin 自带的 gin.Logger() 是为开发调试设计的,输出的是可读性优先的文本格式(比如 [GIN] 2024/04/01 - 10:23:41 | 200 | 1.234ms | 127.0.0.1 | GET /api/users),没有结构化字段,无法被 ELK、Loki 或 Datadog 直接解析。它也不暴露底层 gin.ResponseWriter 的状态码和响应体长度获取逻辑供你自由组装 JSON。

用 gin.LoggerWithConfig + 自定义 gin.LogFormatter 实现 JSON 日志

核心是替换日志格式器(LogFormatter),而非重写整个中间件。Gin 支持传入自定义格式函数,返回字符串 —— 你只需在这个函数里拼 JSON 字符串即可。

注意:JSON 字符串必须是单行(不能换行或缩进),否则日志采集工具会按行切分失败。

  • gin.LogFormatter 函数签名固定:func(param gin.LogFormatterParams) string
  • param.StatusCode、param.Latency、param.ClientIP 等字段可直接用,但 param.ErrorMessage 只在 panic 时非空,正常错误需靠其他方式捕获
  • 别用 json.Marshal 直接序列化 param —— 它含函数和未导出字段,会 panic

示例(精简版):

Browser Js
Browser Js

轻量级CDP浏览器控制,适用于AI代理。相较于内置浏览器工具,token消耗降低3‑10倍,仅在浏览时使用。

下载
logJSON := func(param gin.LogFormatterParams) string {
    return fmt.Sprintf(`{"time":"%s","status":%d,"method":"%s","path":"%s","ip":"%s","latency_ms":%.3f,"user_agent":"%s"}`+"\n",
        param.TimeStamp.Format(time.RFC3339),
        param.StatusCode,
        param.Method,
        param.Path,
        param.ClientIP,
        float64(param.Latency.Nanoseconds())/1e6,
        param.Request.UserAgent(),
    )
}
<p>r.Use(gin.LoggerWithConfig(gin.LoggerConfig{
Formatter: logJSON,
}))

如何记录请求体和响应体?

Gin 默认不读取请求体(避免重复读取破坏流),响应体更不提供访问接口。强行记录会影响性能,且可能破坏 http.ResponseWriter 行为。

如果真需要,必须自己封装 ResponseWriter 拦截写入,并用 io.TeeReader 或临时 buffer 读取 *http.Request.Body —— 但仅限调试,生产环境禁用。

  • 记录请求体:调用 param.Request.Body 前先 param.Request.Body = ioutil.NopCloser(bytes.NewBuffer(bodyBytes))(已读过一次后不可再读)
  • 记录响应体:需实现 responseWriter 结构体,包装原 http.ResponseWriter,在 Write 和 WriteHeader 中缓存数据
  • 这两步都会显著增加内存分配和延迟,QPS 高时容易触发 GC 压力

生产环境 JSON 日志的几个硬性提醒

JSON 日志不是加个 Formatter 就完事。你得确保下游能正确消费:

  • 日志输出到 stdout 时,确保容器运行时(如 Docker)没做行缓冲干扰 —— 加 os.Stdout.Sync() 或设 GIN_MODE=release 启用默认 sync
  • 字段名统一用小写+下划线(如 client_ip),避免不同服务字段命名冲突
  • 时间字段必须用 ISO8601(如 2024-04-01T10:23:41Z),别用本地时区或自定义格式
  • 如果用了 Zap、Zerolog 等结构化日志库,不要混用 Gin 的 Logger 中间件 —— 直接写一个兼容 gin.HandlerFunc 的中间件,用你自己的 logger 实例打日志

最常被跳过的点:没处理 param.ErrorMessage 的空值安全,导致 JSON 字段缺失或格式错乱;还有把 param.Latency 当毫秒用,实际是 time.Duration,直接 %v 会输出 "123456789ns" 而不是数字。

热门AI工具

更多
VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

相关专题

更多
Golang 入门学习路线:从零基础到上手开发
Golang 入门学习路线:从零基础到上手开发

Golang 入门路线涵盖从零到上手的核心路径:首先打牢基础语法与切片等底层机制;随后攻克 Go 的灵魂——接口设计与 Goroutine 并发模型;接着通过 Gin 框架与 GORM 深入 Web 开发实战;最后在微服务与云原生工具开发中进阶,旨在培养具备高性能并发处理能力的后端工程师。

206

2026.02.24

Golang 疑难杂症解决指南:常见问题排查与优化
Golang 疑难杂症解决指南:常见问题排查与优化

《Golang 疑难杂症解决指南》聚焦开发过程中常见却棘手的问题,从并发模型、内存管理、性能瓶颈到工程化实践逐步拆解。通过真实案例与调试思路,帮助开发者定位问题根因,建立系统化排查方法。不只给出答案,更强调分析路径与工具使用,让你在复杂 Go 项目中具备持续解决问题的能力。

113

2026.02.24

Golang 运行与部署实战:从本地到云端
Golang 运行与部署实战:从本地到云端

《Golang 运行与部署实战》围绕 Go 应用从开发完成到稳定上线的完整流程展开,系统讲解编译构建、环境配置、日志与配置管理、容器化部署以及常见运维问题处理。结合真实项目场景,拆解自动化构建与持续部署思路,帮助开发者建立可靠的发布流程,提升服务稳定性与可维护性。

637

2026.02.24

Golang 面试题精选:高频问题与解答
Golang 面试题精选:高频问题与解答

Golang 面试题精选》系统整理企业常见 Go 技术面试问题,覆盖语言基础、并发模型、内存与调度机制、网络编程、工程实践与性能优化等核心知识点。每道题不仅给出答案,还拆解背后的设计原理与考察思路,帮助读者建立完整知识结构,在面试与实际开发中都能更从容应对复杂问题。

198

2026.02.24

Golang 性能优化专题:提升应用效率
Golang 性能优化专题:提升应用效率

《Golang 性能优化专题》聚焦 Go 应用在高并发与大规模服务中的性能问题,从 profiling、内存分配、Goroutine 调度、GC 机制到 I/O 与锁竞争逐层分析。结合真实案例讲解定位瓶颈的方法与优化策略,帮助开发者建立系统化性能调优思维,在保证代码可维护性的同时显著提升服务吞吐与稳定性。

457

2026.02.24

Golang 生态工具与框架:扩展开发能力
Golang 生态工具与框架:扩展开发能力

《Golang 生态工具与框架》系统梳理 Go 语言在实际工程中的主流工具链与框架选型思路,涵盖 Web 框架、RPC 通信、依赖管理、测试工具、代码生成与项目结构设计等内容。通过真实项目场景解析不同工具的适用边界与组合方式,帮助开发者构建高效、可维护的 Go 工程体系,并提升团队协作与交付效率。

188

2026.02.24

Golang 并发编程专题:掌握多核时代的核心技能
Golang 并发编程专题:掌握多核时代的核心技能

《Golang 并发编程专题:掌握多核时代的核心技能》系统讲解 Go 在并发领域的设计哲学与实践方法,深入剖析 goroutine、channel、调度模型与并发安全机制,结合真实场景与性能思维,帮助开发者构建高吞吐、低延迟、可扩展的并发程序,全面提升多核时代的工程能力。

544

2026.02.26

Golang Web 开发路线:构建高效后端服务
Golang Web 开发路线:构建高效后端服务

《Golang Web 开发路线:构建高效后端服务》围绕 Go 在后端领域的工程实践,系统讲解 Web 框架选型、路由设计、中间件机制、数据库访问与接口规范,结合高并发与可维护性思维,逐步构建稳定、高性能、易扩展的后端服务体系,帮助开发者形成完整的 Go Web 架构能力。

225

2026.02.26

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Gin框架快速入门指南
Gin框架快速入门指南

共0课时 | 0人学习

Gin框架官方中文文档
Gin框架官方中文文档

共0课时 | 0人学习

Go语言Gin框架全套实战教程
Go语言Gin框架全套实战教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn