错误处理
gRPC 如何处理错误,以及 gRPC 错误代码。
错误处理
标准错误模型
正如您在我们的概念文档和示例中看到的,当 gRPC 调用成功完成时,服务器会向客户端返回一个 OK
状态(根据语言,OK
状态可能在您的代码中直接使用,也可能不直接使用)。但如果调用不成功会怎样?
如果发生错误,gRPC 会返回其错误状态码之一,并附带一个可选的字符串错误消息,提供关于发生情况的更多详细信息。所有支持的语言中的 gRPC 客户端都可以获取错误信息。
更丰富的错误模型
上述错误模型是官方的 gRPC 错误模型,受所有 gRPC 客户端/服务器库支持,并且独立于 gRPC 数据格式(无论是 Protocol Buffers 还是其他格式)。您可能已经注意到它相当有限,不包括传达错误详情的能力。
但是,如果您使用 Protocol Buffers 作为数据格式,您可能希望考虑使用 Google 开发和使用的更丰富的错误模型,如此处所述。此模型使服务器能够返回,并使客户端能够使用表示为一个或多个 protobuf 消息的额外错误详情。它进一步指定了一组标准错误消息类型来满足最常见的需求(例如无效参数、配额违规和堆栈跟踪)。此额外错误信息的 protobuf 二进制编码以尾随元数据的形式在响应中提供。
这种更丰富的错误模型已在 C++、Go、Java、Python 和 Ruby 库中得到支持,并且至少 grpc-web 和 Node.js 库有未解决的问题要求支持它。如果未来有需求,其他语言库可能会添加支持,因此如果感兴趣请查看它们的 GitHub 仓库。但是请注意,用 C 编写的 grpc-core 库不太可能支持它,因为它被设计为与数据格式无关。
如果您不使用 Protocol Buffers,可以使用类似的方法(将错误详情放入尾随响应元数据),但您可能需要寻找或开发库支持来访问这些数据,以便在您的 API 中实际使用它。
但是,在决定是否使用这种扩展的错误模型时,需要注意一些重要的考虑因素,包括:
- 扩展错误模型的库实现在不同语言之间,对于错误详情负载的要求和期望可能不一致
- 现有的代理、日志记录器和其他标准 HTTP 请求处理器无法查看错误详情,因此无法利用它们进行监控或其他目的
- 尾随元数据中额外的错误详情会干扰队头阻塞,并因更频繁的缓存未命中而降低 HTTP/2 头部压缩效率
- 更大的错误详情负载可能会超出协议限制(如最大头部大小),从而导致原始错误信息丢失
错误状态码
gRPC 在各种情况下都会引发错误,从网络故障到未经身份验证的连接,每种情况都与特定的状态码相关联。所有 gRPC 语言都支持以下错误状态码。
一般错误
情况 | 状态码 |
---|---|
客户端应用取消了请求 | GRPC_STATUS_CANCELLED |
在服务器返回状态之前截止日期已过期 | GRPC_STATUS_DEADLINE_EXCEEDED |
服务器上未找到方法 | GRPC_STATUS_UNIMPLEMENTED |
服务器正在关闭 | GRPC_STATUS_UNAVAILABLE |
服务器抛出了异常(或执行了除返回状态码以终止 RPC 之外的其他操作) | GRPC_STATUS_UNKNOWN |
网络故障
情况 | 状态码 |
---|---|
在截止日期过期前未传输任何数据。也适用于传输了部分数据但在截止日期过期前未检测到其他故障的情况 | GRPC_STATUS_DEADLINE_EXCEEDED |
在连接中断前传输了部分数据(例如,请求元数据已写入 TCP 连接) | GRPC_STATUS_UNAVAILABLE |
协议错误
情况 | 状态码 |
---|---|
无法解压缩但支持压缩算法 | GRPC_STATUS_INTERNAL |
客户端使用的压缩机制不受服务器支持 | GRPC_STATUS_UNIMPLEMENTED |
流控制资源限制已达到 | GRPC_STATUS_RESOURCE_EXHAUSTED |
流控制协议违规 | GRPC_STATUS_INTERNAL |
解析返回状态时出错 | GRPC_STATUS_UNKNOWN |
未经身份验证:凭据未能获取元数据 | GRPC_STATUS_UNAUTHENTICATED |
授权元数据中设置的主机无效 | GRPC_STATUS_UNAUTHENTICATED |
解析响应协议缓冲区时出错 | GRPC_STATUS_INTERNAL |
解析请求协议缓冲区时出错 | GRPC_STATUS_INTERNAL |
语言支持
提供了多种语言的示例代码,演示如何处理标准错误以及更丰富的错误详情。
语言 | 示例 |
---|---|
C++ | C++ 错误处理示例 |
C++ 错误详情示例 | |
Go | Go 错误处理示例 |
Go 错误详情示例 | |
Java | Java 错误处理示例 |
Java 错误详情示例 | |
Node | Node 错误处理示例 |
Python | Python 错误详情示例 |
grpc-errors 仓库还包含其他错误处理示例。