0

0

如何为Go API返回结构化错误_Go API错误结构设计指南

P粉602998670

P粉602998670

发布时间:2025-12-19 20:11:32

|

638人浏览过

|

来源于php中文网

原创

Go API结构化错误的核心是统一JSON格式,含Status、Code、Message、Detail(debug模式)、RequestID字段;需分层封装、避免裸error透出,集成HTTP处理器并设正确状态码,支持i18n与错误码文档化。

如何为go api返回结构化错误_go api错误结构设计指南

Go API 返回结构化错误的核心是:统一错误格式、区分错误类型、保留原始上下文、便于前端解析。不建议直接返回 error 字符串或裸 panic,而应设计可序列化、含状态码、错误码、用户提示和调试信息的 JSON 错误响应。

定义标准错误结构体

一个实用的错误结构需包含 HTTP 状态码、业务错误码、用户友好的消息、机器可读的错误 ID(可选)、以及开发用的详细原因(仅 debug 模式暴露):

  • Status:对应 HTTP 状态码(如 400、401、404、500)
  • Code:自定义业务错误码(如 "USER_NOT_FOUND"、"INVALID_EMAIL"),字符串更易维护和国际化
  • Message:面向终端用户的简明提示(如 "用户不存在")
  • Detail:可选字段,仅在 debug=true 时返回(如具体校验失败字段、SQL 错误原文)
  • RequestID:关联日志追踪,方便后端排查

示例结构:

type APIError struct {
    Status    int    `json:"status"`
    Code      string `json:"code"`
    Message   string `json:"message"`
    Detail    string `json:"detail,omitempty"`
    RequestID string `json:"request_id,omitempty"`
}

func (e *APIError) Error() string { return e.Message }

分层封装错误,避免裸 error 透出

不要让数据库错误、JSON 解析错误等底层 error 直接返回给客户端。应在 handler 层统一拦截并转换:

  • 使用中间件或 defer 捕获 panic,并转为 500 类错误
  • 对已知业务错误(如用户未登录、权限不足)主动构造 *APIError
  • 对未知错误(如第三方服务超时、DB 连接失败)统一降级为 500 + 通用码(如 "INTERNAL_ERROR"),不暴露敏感细节
  • 可借助 errors.Is / errors.As 判断错误类型,再做映射(例如识别 pgx.ErrNoRows → 404 + "USER_NOT_FOUND")

与 HTTP 处理器集成(以 net/http 为例)

在 handler 中返回错误时,不直接写 http.Error,而是统一调用一个响应函数:

万兴爱画
万兴爱画

万兴爱画AI绘画生成工具

下载
  • 成功时:writeJSON(w, http.StatusOK, data)
  • 失败时:writeError(w, err) —— 内部判断是否为 *APIError,否则包装为 500
  • 确保 Content-Type 设为 application/json; charset=utf-8
  • 设置合适的 HTTP 状态码(别让所有错误都返回 200 + {“error”:…})

这样前端可通过 HTTP 状态码快速区分网络/服务异常 vs 业务异常。

可选增强:支持 i18n 与错误码文档化

若需多语言支持,Message 不宜硬编码,可改为 key(如 "user.not_found"),由前端或网关根据 Accept-Language 渲染;同时维护一份公开的错误码表(Markdown 或 OpenAPI x-error-codes 扩展),标注每个 Code 对应的场景、HTTP 状态、是否可重试等,提升协作效率。

基本上就这些。结构化错误不是堆砌字段,而是让错误成为 API 的一部分契约 —— 前端能预期、后端好定位、运维可追踪。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

749

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

328

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

350

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

1283

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

361

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

861

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

581

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

423

2024.04.29

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

14

2026.01.30

热门下载

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

精品课程

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

共101课时 | 8.6万人学习

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

共39课时 | 3.2万人学习

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

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