前言
这是Go十大常见错误系列的第5篇:go语言Error管理。素材来源于Go布道者,现Docker公司资深工程师Teiva Harsanyi[1]。
本文涉及的源代码全部开源在:Go十大常见错误源代码[2],欢迎大家关注公众号,及时获取本系列最新更新。
场景
Go语言在错误处理(error handling)机制上经常被诟病。
在Go 1.13版本之前,Go标准库里只有一个用于构建error的errors.New
函数,没有其它函数。
pkg/errors包
由于Go标准库里errors包的功能比较少,所以很多人可能用过开源的*pkg/errors*[3]包来处理Go语言里的error。
比较早使用Go语言做开发,并且使用*pkg/errors*[4]包的开发者也会犯一些错误,下文会详细讲到。
pkg/errors
包的代码风格很好,遵循了下面的error处理法则。
An error should be handled only once. Logging an error is handling an error. So an error should either be logged or propagated.
翻译成中文就是:
error只应该被处理一次,打印error也是对error的一种处理。所以对于error,要么打印出来,要么就把error返回传递给上一层。
很多开发者在日常开发中,如果某个函数里遇到了error,可能会先打印error,同时把error也返回给上层调用方,这就没有遵循上面的最佳实践。
我们接下来看一个具体的示例,代码逻辑是后台收到了一个RESTful的接口请求,触发了数据库报错。我们想打印如下的堆栈信息:
unable to serve HTTP POST request for customer 1234
|_ unable to insert customer contract abcd
|_ unable to commit transaction
假设我们使用pkg/errors
包,我们可以使用如下代码来实现: