Go语言如何做gRPC错误码规范_Golang status与codes使用方法

P粉328763957

P粉328763957

2026-05-27

943人浏览

原创

grpc错误码必须用status.error()构造且客户端用status.fromerror()解包,否则默认为codes.unknown;结构化详情需注册类型,codes.unavailable与codes.internal语义不可混用。

go语言如何做grpc错误码规范_golang status与codes使用方法

gRPC 错误码不是随便 return errors.New() 就能生效的——服务端不调 status.Error(),客户端永远收到 codes.Unknown;客户端不用 status.FromError() 解包,就只能靠字符串匹配硬刚,一升级就崩。

服务端必须用 status.Error() 构造错误,不能直接返回原生 error

gRPC 协议要求状态码、消息、详情必须编码进响应头的 grpc-statusgrpc-message 字段。只有 status.Status 类型才能被序列化成这个结构。

  • return nil, errors.New("user not found") → 客户端看到 codes.Unknown(整数 2),st.Message() 是空字符串
  • return nil, fmt.Errorf("id %s invalid", req.Id) → 同样降级为 codes.Unknown,且可能泄露用户输入
  • ✅ 正确写法:return nil, status.Error(codes.NotFound, "user not found")
  • 需要导入:google.golang.org/grpc/statusgoogle.golang.org/grpc/codes
  • status.Errorf() 可用于格式化,但别拼接不可信输入(如 req.Email)进 message

客户端必须用 status.FromError() 解包,不能靠 strings.Contains()errors.Is()

原生 error 经过 gRPC 序列化/反序列化后,类型链已断。客户端拿到的是封装过的 *status.Status,不是你服务端定义的 struct error。

Go语言(Golang)1.26.0
Go语言(Golang)1.26.0

Go语言(Golang)1.26.0版本提供 Go 官方 Windows amd64 MSI 安装包下载入口,版本号 1.26.0,可用于旧项目维护、兼容性测试和指定版本开发环境配置。

下载
  • if strings.Contains(err.Error(), "not found") → 脆弱、不可跨语言、message 可能被翻译或裁剪
  • if errors.Is(err, mypkg.ErrUserNotFound) → 永远 false,因为类型信息丢失
  • ✅ 正确模式:st, ok := status.FromError(err),再判断 st.Code() == codes.NotFound
  • 如果 ok == false,说明是网络层错误(如 context canceled、DNS 失败),应走兜底逻辑,不是业务重试路径

要传结构化详情(如字段名、重试建议),得用 status.WithDetails() 并提前注册类型

想让客户端拿到 errdetails.BadRequest 或自定义 proto message,光塞进去没用——未注册的类型在反序列化时会被跳过。

  • 服务端注册(一次即可,推荐 main() 开头):status.RegisterErrorDetail(&errdetails.BadRequest{})
  • 构造错误:status.WithDetails(status.Error(codes.InvalidArgument, "validation failed"), &errdetails.BadRequest{FieldViolations: [...]})
  • 客户端解包:for _, d := range st.Details() { if v, ok := d.(*errdetails.BadRequest); ok { /* 处理 */ } },注意必须用 proto.Unmarshal() 或直接类型断言(前提是注册过)
  • ⚠️ 别在 details 里塞敏感数据(如 token、密码),它会随响应头透出,可能被网关或前端日志打印

codes.Unavailablecodes.Internal 语义不能互换

这两个码直接影响客户端是否重试、监控告警是否触发、SLO 是否计入——混用会导致故障响应策略失效。

  • codes.Unavailable:服务暂时不可达(如下游 DB 连接池耗尽、K8s Pod 正在滚动更新),客户端可安全重试
  • codes.Internal:服务自身逻辑崩溃(如 panic 恢复后未处理、空指针、配置加载失败),不应重试,应立刻告警
  • 常见误用:codes.ResourceExhausted 不该用于“余额不足”这类业务错误;那是 status.OK + 响应体里的 error_code 字段的事
  • 业务错误和传输层错误必须分层:gRPC 状态码只管“能不能通”,不管“业务对不对”

最易被忽略的一点:中间件或拦截器里如果调了 err.(interface{ Err() error }).Err()status.Convert(),可能把 status.Status 又转回普通 error,导致下游收不到真实码——所有中间件都得检查是否无意破坏了 status 链。

golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

golang go语言

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

1376

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

1562

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

692

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

551

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

910

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

1128

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

1685

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

5680

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

420

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
golang入门到项目实战教程
golang入门到项目实战教程

共0课时 | 0人学习

golang socket 编程
golang socket 编程

共2课时 | 0.2万人学习