go语言error go语言error诟病( 二 )


并非所有错误都是相同的,并且向调用者返回适当的错误是 API 设计的重要部分,无论是对于内部包还是 REST API。
不必担心在你的代码中重复 if err != nil ——这就是 Go 中的代码应该看起来的样子 。
自定义错误类型和错误包装
从导出的方法返回错误时,请考虑指定自定义错误类型 , 而不是单独使用错误字符串 。字符串在意外代码中是可以的,但在导出的函数中,它们成为函数公共 API 的一部分 。更改错误字符串将是一项重大更改——如果没有明确的错误类型,需要检查返回错误类型的单元测试将不得不依赖原始字符串值!事实上,基于字符串的错误也使得在私有方法中测试不同的错误案例变得困难,因此您也应该考虑在包中使用它们 。回到错误与异常的争论,返回错误也使代码比抛出异常更容易测试,因为错误只是要检查的返回值 。不需要测试框架或在测试中捕获异常。
可以在 database/sql 包中找到简单自定义错误类型的一个很好的示例 。它定义了一个导出常量列表,表示包可以返回的错误类型,最著名的是 sql.ErrNoRows 。虽然从 API 设计的角度来看,这种特定的错误类型有点问题(您可能会争辩说 API 应该返回一个空结构而不是错误),但任何需要检查空行的应用程序都可以导入该常量并在代码中使用它不必担心错误消息本身会改变和破坏代码 。
对于更复杂的错误处理,您可以通过实现返回错误字符串的 Error() 方法来定义自定义错误类型 。自定义错误可以包括元数据,例如错误代码或原始请求参数 。如果您想表示错误类别,它们很有用 。DigitalOcean 的本教程展示了如何使用自定义错误类型来表示可以重试的一类临时错误 。
通常,错误会通过将低级错误与更高级别的解释包装起来,从而在程序的调用堆栈中传播 。例如,数据库错误可能会以下列格式记录在 API 调用处理程序中:调用 CreateUser 端点时出错:查询数据库时出错:pq:检测到死锁 。这很有用 , 因为它可以帮助我们跟踪错误在系统中传播的过程,向我们展示根本原因(数据库事务引擎中的死锁)以及它对更广泛系统的影响(调用者无法创建新用户) 。
自 Go 1.13 以来 , 此模式具有特殊的语言支持,并带有错误包装 。通过在创建字符串错误时使用 %w 动词,可以使用 Unwrap() 方法访问底层错误 。除了比较错误相等性的函数 errors.Is() 和 errors.As() 外,程序还可以获取包装错误的原始类型或标识 。这在某些情况下可能很有用,尽管我认为在确定如何处理所述错误时最好使用顶级错误的类型 。
Panics
不要 panic()!长时间运行的应用程序应该优雅地处理错误而不是panic 。即使在无法恢复的情况下(例如在启动时验证配置),最好记录一个错误并优雅地退出 。panic比错误消息更难诊断,并且可能会跳过被推迟的重要关闭代码 。
Logging
我还想简要介绍一下日志记录,因为它是处理错误的关键部分 。通常你能做的最好的事情就是记录收到的错误并继续下一个请求 。
除非您正在构建简单的命令行工具或个人项目,否则您的应用程序应该使用结构化的日志库 , 该库可以为日志添加时间戳 , 并提供对日志级别的控制 。最后一部分特别重要,因为它将允许您突出显示应用程序记录的所有错误和警告 。通过帮助将它们与信息级日志分开,这将为您节省无数时间 。
微服务架构还应该在日志行中包含服务的名称以及机器实例的名称 。默认情况下记录这些时,程序代码不必担心包含它们 。您也可以在日志的结构化部分中记录其他字段,例如收到的错误(如果您不想将其嵌入日志消息本身)或有问题的请求或响应 。只需确保您的日志没有泄露任何敏感数据,例如密码、API 密钥或用户的个人数据!

推荐阅读