1.5 Go 业务开发中 Error & Context - 毛剑

• 语言: 中文（简体）
• 格式: .pdf
• 来源: github.com/gopherchina

摘要

文档主要介绍了Go业务开发中Error和Context的最佳实践。Error部分强调了将错误抛给调用者而非到处打日志，在最顶部的调用者统一打印return。推荐使用errorgroup集中处理错误，并介绍了其WithContext、Go、Wait等方法。同时建议全仓库支持pkg/errors，对标准库和第三方库返回的error进行Wrap或Wrapf包装以记录完整调用栈。定义了适配业务的Error Type，包含Code（业务错误码）、Message（标准库错误消息）、Details（业务Hint），以及Code包级别的Equal方法用于检测错误码一致性。Context部分介绍了其用于超时和取消控制，以及元数据传递，包括同进程同步/异步生命周期传递和跨进程网络传递。建议在流量入口（如HTTP、gRPC）设置超时控制，基础库内继承超时以规避OOM。

AI总结

在 Go 业务开发中，Error 和 Context 是两个核心概念，正确使用它们能显著提升代码的健壮性和可维护性。

**Error 处理最佳实践**

1. **核心原则**：错误应该被抛给调用者处理，而不是在每一层都打印日志。统一在最顶层的调用者或 worker goroutine 中进行日志记录。
2. **避免常见问题**：
* 分层开发容易导致“处处打印日志”，造成日志冗余且难以关联。
* 直接返回标准库错误会导致根因丢失，难以获取详细的堆栈信息。
3. **推荐方案**：
* 使用 `pkg/errors` 库对标准库和第三方库返回的 error 进行 `Wrap` 或 `Wrapf`，以完整记录调用栈。对于基础库自身的 error，则无需重复包装。
* 定义适配业务的 Error Type，包含 `Code`（业务错误码）、`Message`（标准错误消息）和 `Details`（业务提示信息）。
* 提供 `Cause` 方法适配 `pkg/errors` 用于获取根因，以及 `Equal` 方法用于比较错误码。
4. **并发错误处理**：
* 使用 `errgroup.Group` 来集中处理多个 goroutine 的错误，但需注意其 `WithContext` 返回的 context 容易误用，且对扇出（fan-out）的控制不足，业务代码中容易发生 panic。

**Context 使用最佳实践**

1. **核心功能**：Context 主要用于超时控制、取消信号传递以及请求范围内的元数据传递。
2. **超时与取消**：
* 在流量入口（如 HTTP、gRPC）设置超时控制，基础库内部应继承此超时，以尽可能避免 OOM。
* 通常做法是从父 context 获取 deadline，与配置的超时时间比较，取较小值，并预留少量缓冲时间（如 20ms）。
3. **元数据传递**：
* Context 中的值应仅限于在进程和 API 边界间传递的请求范围数据，不应作为函数的可选参数。
* 元数据传递包括：同进程的同步/异步生命周期传递，以及跨进程的网络传递。

**总结与建议**

* 业务基础库的设计并不简单，应追求简单可靠，确保每个人都能正确使用。
* 提倡“去大师化编程”，注重代码的鲁棒性和健壮性。
* 持续反思与进步：观察消费者的使用方式，在 CaseStudy 中记录常见错误点，不断质疑并参考优秀的设计方案。