0

0

Golang Web API统一错误处理_构建标准JSON错误响应结构

P粉602998670

P粉602998670

发布时间:2026-02-13 12:36:12

|

689人浏览过

|

来源于php中文网

原创

go http handler中需用defer+recover统一拦截panic并转为json错误,优先使用框架自定义recovery中间件,业务error应实现apierror接口以映射状态码和错误码,请求id须在入口注入context并透传至响应,避免responsewriter多次写入。

golang web api统一错误处理_构建标准json错误响应结构

Go HTTP handler 中如何统一拦截 panic 并转为 JSON 错误

panic 会直接终止 handler 执行并返回空白响应或 500 页面,前端收不到结构化错误。必须用 recover() 拦住,再手动写入标准 JSON 错误体。

  • 所有顶层 handler(如 http.HandleFunc 或 Gin 的 c.Next() 前)都得包一层 defer + recover()
  • 恢复后别直接 log.Fatal,要调用你封装的错误响应函数,比如 writeJSONError(w, http.StatusInternalServerError, "internal_error", "server panic")
  • Gin/Echo 等框架已有中间件机制,优先用 gin.Recovery(),但默认不输出 JSON;需自定义 recovery 中间件,替换掉原 http.Error() 调用
  • 注意:recover 只对当前 goroutine 有效,异步 goroutine(如 go func(){}())里的 panic 不会被捕获

error 类型怎么映射到 HTTP 状态码和错误码字符串

不能靠 err.Error() 字符串匹配来判断类型——太脆弱。应该让业务 error 实现自定义接口,携带状态码和 code 字段。

  • 定义接口:type APIError interface { Error() string; StatusCode() int; Code() string }
  • 业务层主动返回实现该接口的 struct,比如 &ValidationError{Msg: "email invalid", Field: "email"}
  • 中间件中用 errors.As(err, &target) 判断是否是 APIError,再取 target.StatusCode()target.Code()
  • 别把数据库错误(如 "pq: duplicate key")直接透出给前端,要兜底转换成通用错误码如 "resource_conflict"

JSON 错误响应结构要不要包含 trace_id 或 request_id

要,但不能硬编码生成,也不能全靠日志库自动注入。必须在请求进入时就生成并透传到错误响应里。

聪豹Wiseal
聪豹Wiseal

聪豹Wiseal是一个专业的历史时间线收集整理工具

下载
  • 用中间件在 context.Context 中塞入 request_id,比如 ctx = context.WithValue(r.Context(), ctxKeyRequestID, id)
  • 错误响应结构体里留一个 RequestID 字段,写响应时从 r.Context().Value() 里取
  • 别用 uuid.New().String() 在错误构造时临时生成——会导致日志和响应中的 ID 不一致
  • 如果用了 OpenTelemetry,优先从 trace.SpanFromContext(r.Context()).SpanContext().TraceID() 提取,更利于链路追踪对齐

为什么不能在 defer 里直接 json.Marshal 错误再写入 ResponseWriter

因为 ResponseWriter 可能已被部分写入(比如之前调用了 w.WriteHeader(200)),此时再写 JSON 会触发 http: multiple response.WriteHeader calls 错误。

立即学习go语言免费学习笔记(深入)”;

  • 必须在写任何 body 前就决定最终状态码,错误处理逻辑应尽早介入,而不是等最后才“补救”
  • 推荐做法:用包装过的 ResponseWriter(如 responseWriterWrapper),记录是否已写 header/body,错误发生时先检查、再清理已写内容(仅限开发环境)或直接 panic(生产环境不该走到这步)
  • 更稳妥方案:所有 handler 返回 error,由顶层路由层统一判断并写响应,避免中途写入
  • Gin 用户注意:c.AbortWithStatusJSON() 是安全的,它会自动处理 header 冲突;但别在 defer 里调它,而应在 recover 后显式调用

真正难的不是结构定义,而是让每个业务 error 都老老实实实现接口、每条中间件都记得透传 context、每次异步操作都意识到 panic 不会被捕获——这些地方一漏,标准就塌一角。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

206

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

235

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

346

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

212

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

402

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

322

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

197

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

824

2025.06.17

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

1

2026.02.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 9.2万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.3万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号