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

Golang微服务如何统一错误码_Golang微服务错误处理规范

雨芳同学_7312

雨芳同学_7312

发布时间:2026-02-02 16:04:02

|

386人浏览过

|

来源于php中文网

原创

错误码必须分层唯一且全局统一,采用SSS-TT-NNN格式定义在公共module中;所有错误须经工厂函数创建并实现StatusCoder接口;message支持i18n,reason仅用于日志;traceID须从入参context提取。

golang微服务如何统一错误码_golang微服务错误处理规范

错误码必须分层唯一,不能靠字符串匹配判断

微服务里最常见也最危险的错误处理方式,就是用 strings.Contains(err.Error(), "not found") 这类逻辑做分支——一旦日志加了前缀、message被翻译、甚至只是拼写多空格,整个判断就失效。真正可靠的方式是让错误本身携带可识别的语义:每个错误码全局唯一、按模块分段(如 101-02-001 表示用户服务的「资源未找到」),且所有服务共用同一套编号规则。

  • 推荐格式:SSS-TT-NNN(3位服务号 + 2位类型 + 3位序号),避免用 iota 连续编号——跨服务时极易冲突
  • 错误码不随语言/服务变化,前端、网关、监控系统都依赖它做决策,所以必须定义在公共 module(如 common/errors)中
  • 禁止在 HTTP 响应体里塞 error: "db timeout" 字段——这违反协议层约定,gRPC 应用 status.Error(),HTTP 应返回标准 JSON 错误体

构造函数必须统一入口,禁止裸写 fmt.Errorf 或 errors.New

业务代码里随手写 return fmt.Errorf("user %s not found", id),看似简单,实则埋下三个坑:无法提取 Code、丢失 traceID、下游无法结构化解析。所有错误创建必须走封装好的工厂函数,比如 NewError(code, msg, fields),它负责注入上下文、校验合法性、并确保实现对应协议接口。

  • NewError 内部应从 context.Context 提取 traceID 和 service name,而不是硬编码或用 context.Background()
  • 对底层 error(如数据库驱动错误)要用 Wrap 包装,保留原始堆栈,同时升级为业务语义:errors.Wrap(dbErr, ErrUserNotFound)
  • 构造函数需校验 code 是否在合法区间,非法值应 panic 或 fallback 到通用错误(如 50001),而非静默忽略

HTTP 中间件要区分 ErrorCoder 和非结构化 error

中间件不是“兜底 catch all”的地方,而是分类响应的枢纽。它必须能明确区分两类错误:实现了 StatusCoder 接口的业务错误(可取 StatusCode()),和未封装的底层 error(如 json.SyntaxError、io.EOF)。前者走标准 JSON 响应,后者统一转为 500 并记录日志,绝不暴露细节。

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载
  • 定义接口:type StatusCoder interface { StatusCode() int },让 *AppError 或 *bizError 实现它
  • 中间件里不要用 recover() 捕获所有 panic 来替代显式错误返回——这会让参数校验失败和空指针崩溃混为一谈,掩盖真实问题位置
  • 响应体字段要分离用途:code 是业务码(如 2001),status 是 HTTP 状态码(如 404),message 仅作前端提示,details 仅用于调试且生产环境脱敏

错误 message 必须支持 i18n,但 reason 绝不返回给前端

你看到的 "user not found" 是日志里的 reason,不是给用户的提示。真正的用户文案应该由调用方根据 code 查多语言表生成,比如请求头带 Accept-Language: zh-CN,就返回 "用户不存在";开发时还可强制切英文便于排查。

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

  • reason 存在错误码元信息映射表里(如 ErrCodeMeta[2001].Reason),只用于日志和 debug
  • message 字段在 ErrorCoder.Message() 方法中动态取值,不硬编码在错误结构体里
  • 前端不应解析 error 字符串,而应查 code 映射表——这样换语言、改文案、加新 locale 都不影响 API 兼容性

最容易被忽略的是 traceID 的传递时机:它必须从入参 context.Context 中提取,而不是在 NewError 里调用 trace.FromContext(context.Background())——后者永远拿不到真实链路 ID。错误一旦离开当前 goroutine,上下文就断了,再补就晚了。

热门AI工具

更多
超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

DeepSeek

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

豆包大模型

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

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

二狗PPT
二狗PPT Hot

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

WorkBuddy

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

相关专题

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

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

519

2024.02.23

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

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

596

2024.02.23

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

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

1156

2024.02.23

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

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

771

2024.03.05

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

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

1706

2024.05.21

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

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

4794

2025.06.09

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

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

2214

2025.06.10

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

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

4086

2025.06.17

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

0

2026.10.22

热门下载

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

精品课程

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

共101课时 | 21.1万人学习

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

共39课时 | 4.9万人学习

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

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