错误处理

gRPC 如何处理错误,以及 gRPC 错误码。

错误处理

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
Authority 元数据中设置了无效主机GRPC_STATUS_UNAUTHENTICATED
解析响应 Protocol Buffer 时出错GRPC_STATUS_INTERNAL
解析请求 Protocol Buffer 时出错GRPC_STATUS_INTERNAL

语言支持

提供多种语言的示例代码,说明如何处理标准错误以及更丰富的错误详细信息。

语言示例
C++C++ 错误处理示例
C++ 错误详细信息示例
GoGo 错误处理示例
Go 错误详细信息示例
JavaJava 错误处理示例
Java 错误详细信息示例
NodeNode 错误处理示例
PythonPython 错误详细信息示例

The grpc-errors 仓库也包含额外的错误处理示例。

最后修改于 2024 年 2 月 29 日:状态码用户指南 (#1263) (fb661d4)