当前位置:

首页 > 编程开发 > Golang实现请求日志记录方法

Golang实现请求日志记录方法

http.Handler是日志中间件的起点,因其可统一包装处理链、捕获panic、精确记录状态码与耗时,且避免漏记和伪造IP风险。

本文目录

    http.Handler 是日志中间件的起点,因其可统一包装处理链、捕获 panic、精确记录状态码与耗时,且避免漏记和伪造 IP 风险。

    如何使用Golang实现请求日志记录_Web请求日志实现方案

    为什么 http.Handler 是日志中间件的起点

    Go 的 HTTP 服务没有内置请求日志,所有日志必须手动注入到处理链中。最直接、最可控的方式是实现一个符合 http.Handler 接口的包装器——它不改变原有逻辑,只在调用 handler.ServeHTTP() 前后记录时间、状态码、路径等信息。

    绕过 http.Handler(比如只在某个 http.HandleFunc 里写日志)会导致漏记、难以复用、无法捕获 panic 导致的 500 错误;用第三方框架(如 Gin 的 Logger())虽方便,但底层仍是基于同一种包装思路。

    • 必须用指针接收者或闭包保存 logger 实例,避免每次新建日志对象
    • 记录开始时间要用 time.Now(),不能依赖 req.Context().Deadline(),后者是截止时间,不是发起时间
    • 务必在 defer 中调用 rw.WriteHeader() 之后再记录状态码——否则 rw.Status() 拿不到真实值(标准 ResponseWriter 不暴露状态码)

    如何安全获取真实客户端 IP 而不被伪造

    直接读 req.RemoteAddr 在反向代理(Nginx、Cloudflare)后会得到上游服务器地址(如 127.0.0.1:32123),必须解析 X-Forwarded-For 或 X-Real-IP 头。但这些头可被客户端随意设置,不加校验等于开放 IP 伪造漏洞。

    正确做法是:只信任你控制的上游代理所添加的头,并配置可信跳数。例如 Nginx 在转发时加 proxy_set_header X-Real-IP $remote_addr;,且只有一层代理,则取 X-Real-IP;若有多层,需结合 X-Forwarded-For 和 RemoteAddr 白名单判断。

    • 不要无条件取 X-Forwarded-For 的第一个值——那是最易伪造的部分
    • 使用 net.ParseIP() 校验提取出的 IP 是否合法,过滤空值或畸形字符串
    • 生产环境应明确配置可信代理网段(如 10.0.0.0/8, 172.16.0.0/12),仅对来自这些网段的请求才信任其 X-Real-IP

    怎样避免日志中间件影响响应性能和内存

    高频请求下,字符串拼接、JSON 序列化、频繁写磁盘会显著拖慢吞吐。关键不是“要不要记”,而是“怎么记得轻”。

    核心原则:日志构造尽量延迟,I/O 必须异步或缓冲。比如状态码、字节数、耗时可在 defer 中快速读取并格式化为一行字符串,然后交给独立 goroutine 写入带缓冲的 channel;避免在 handler 中调用 log.Printf() 或 json.Marshal()。

    • 不要在中间件里做结构化日志(如 zerolog.Ctx(req.Context()).Info().Str("path", req.URL.Path).Int("status", status)),这会分配大量小对象
    • 用 fmt.Sprintf() 拼接固定格式文本比 fmt.Fprintf() + bytes.Buffer 更快,前提是字段少、格式稳定
    • 如果用 log.SetOutput() 指向文件,确保该文件以 os.O_APPEND | os.O_CREATE 打开,并启用行缓冲(bufio.NewWriterSize(f, 4096))

    如何捕获 panic 并记录为 500 日志

    默认情况下,Go HTTP server 遇到 panic 会打印堆栈到 stderr,但不会返回 500 响应,也不会触发你的日志中间件——因为 panic 发生在 handler.ServeHTTP() 内部,中间件的 defer 已退出。

    解决方案是在日志中间件内部用 defer/recover 包裹 next.ServeHTTP() 调用,并主动写响应、记录错误。注意:recover 只对当前 goroutine 有效,且必须在 defer 函数内直接调用。

    func (l *loggingHandler) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
    	start := time.Now()
    	statusCode := 200
    	w := &responseWriter{ResponseWriter: rw, statusCode: &statusCode}
    
    	defer func() {
    		if r := recover(); r != nil {
    			statusCode = 500
    			http.Error(w, http.StatusText(500), 500)
    			l.logger.Printf("[PANIC] %s %s %d %v %s", req.Method, req.URL.Path, statusCode, r, time.Since(start))
    		} else {
    			l.logger.Printf("%s %s %d %d %s", req.Method, req.URL.Path, statusCode, w.written, time.Since(start))
    		}
    	}()
    
    	next.ServeHTTP(w, req)
    }

    这里 responseWriter 是个自定义类型,实现了 WriteHeader(int) 并保存状态码;否则 panic 后无法得知本该返回什么状态。

    真正难的是区分“业务 panic”和“系统 panic”。前者应转为 500 并记录;后者(如空指针解引用)建议额外上报监控系统,而不是只写日志。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    GitHub六个AI开源项目能做什么?软件理解、语音与求职场景
    GitHub六个AI开源项目能做什么?软件理解、语音与求职场景

    解析六个GitHub AI开源项目的具体用途,包括软件静态分析、智能体回答检查、多语言配音、求职材料生成、本地代码检索及动态歌词展示,帮助开发者根据实际需求筛选工具并正确验证结果。

    opencode安装skills教程及本地配置方法
    opencode安装skills教程及本地配置方法

    遇到OpenCode Skills无法加载或配置无效?本文手把手教你完成Skills的安装、环境变量设置及本地调试,避开常见坑点,让AI助手更懂你的代码习惯。

    如何开启Visual Studio2022实时代码分析警告提示
    如何开启Visual Studio2022实时代码分析警告提示

    解决 Visual Studio 2022 编辑时不显示代码分析警告的问题。指南涵盖 .NET 项目实时分析设置、Roslyn 分析器范围调整及错误列表来源筛选,确保开发者能高效利用实时代码诊断功能。

    如何在Visual Studio2022查看变量监视窗口调试程序
    如何在Visual Studio2022查看变量监视窗口调试程序

    详解 Visual Studio 2022 调试技巧:包括断点设置、监视窗口开启方法、变量添加步骤以及通过 F10 单步执行观察变量值变化的全过程。

    Visual Studio2017设置默认编码为UTF-8不带BOM
    Visual Studio2017设置默认编码为UTF-8不带BOM

    针对 Visual Studio 2017 缺乏全局默认编码选项的情况,详解如何利用 .editorconfig 设定项目级 UTF-8 无 BOM 规则,以及手动转换现有文件并校验字节的方法。

    Visual Studio2022F5调试提示启动项目未配置怎么修复
    Visual Studio2022F5调试提示启动项目未配置怎么修复

    解决 Visual Studio 2022 F5 调试报错问题,通过设置启动项目、检查解决方案属性及正确区分类库与应用项目,快速恢复调试功能。

    Visual Studio2022NuGet包还原失败离线处理方案
    Visual Studio2022NuGet包还原失败离线处理方案

    解决Visual Studio 2022离线环境中NuGet包还原失败的难题,涵盖依赖链分析、本地源配置、包集收集及隔离验证步骤,帮助开发者构建稳定的离线开发环境。

    Visual Studio2017大项目加载缓慢,优化加载性能技巧
    Visual Studio2017大项目加载缓慢,优化加载性能技巧

    解决Visual Studio 2017大型项目加载慢的实用指南。涵盖性能监测、扩展管理、文档恢复优化及版本兼容性检查,帮助开发者精准定位瓶颈并提升工作效率。

    Visual Studio2022设置多启动项目同时调试运行
    Visual Studio2022设置多启动项目同时调试运行

    详解 Visual Studio 2022 多启动项目配置方法,包括启动动作选择、顺序调整及调试技巧,帮助开发者高效调试分布式或前后端分离应用。

    fastapi下载文件接口实现教程
    fastapi下载文件接口实现教程

    深入解析在FastAPI框架中实现文件下载接口的完整方案,涵盖基于FileResponse的本地静态文件传输、基于StreamingResponse的分块流式传输、RFC 5987中文文件名编码规范、路径穿越安全防御及BackgroundTasks临时文件清理,并配备详细代码示例与架构解析图。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。