写点规范的 Go 代码

在公司进行代码开发，一般都会制定一套编程规范。良好的代码规范可以改善项目可读性，提高团队开发的合作效率。具体在 Go 语言中，我们可以借鉴 Go 官方的 Go Code Review Comments、Uber 开源的 uber-go/guide 项目，大家感兴趣可以去学习。

本文我们聚焦于一个点：Go 的 error 判断。

启示代码

我们直接看一段代码

type MyselfError struct{}

func (m *MyselfError) Error() string {
 return "实现 error 接口的 Error 方法"
}

func someWork() *MyselfError {
 return nil
}

func main() {
 var err error
 err = someWork()
 fmt.Println(err == nil)
}

// output: false

这个例子的输出可能会让你感到意外？

这是由于在 Go 中，两个 nil 的比较也许并不相等。在[Go 语言类型可比性] 一文中我们说过：对于接口 interface 而言，它的比较存在两个维度，分别是动态类型和动态值。接口的==比较，只有在类型与值均相等的情况下才会为真。

type error interface {
    Error() string
}

someWork函数返回的 err 它是类型为 MyselfError，值为 nil 的 error 接口，显然不满足要求：只有类型和值同时都为 nil 的情况下，接口类型的 nil 判断才会为真。

主分支代码

有了上面的铺垫，你应该懂我要说什么了吧？

在 Go 中，不要通过<span style="font-size: 15px;">err == nil来做逻辑判断条件。这不光是由于使用它会产生潜在的 bug，这样的代码交于测试童鞋，他们可能也会喷你，你知道是为什么吗？

我们可以把代码分为主干代码和分支代码，主干代码代表正常逻辑，分支代码记录异常case。两者最简单的区分方法就是：在一个函数中，主干代码与最左侧只隔一个 tab 距离，超过一个 tab 距离的为分支代码。

在处理错误返回的函数中，我们应该先做错误异常的处理，错误处理的逻辑属于分支代码，而正常逻辑则应在主干代码上。

错误示例

func bar() {
 var err error
 err = foo()
 if err == nil {
  // 程序正常的代码逻辑
 } else {
  switch err.(type) {
  case err1:
   // 做错误处理1
  case err2:
   // 做错误处理2
  default:
   // 做通用错误处理
  }
 }
}

现在你能知道测试童鞋为什么喷你吗？

有一个词叫做测试覆盖率，它代表测试用例走过的代码行数。如果你将err==nil的判断前置，那这段代码就对于测试不友好。

在测试过程中，有时我们很难人为构造错误的发生，那么很可能测试用例只会走err==nil下面的代码逻辑。

规范示例

func main() {
 var err error
 err = foo()
 if err != nil {
  switch err.(type) {
  case err1:
   // 做错误处理1
  case err2:
   // 做错误处理2
  default:
   // 做通用错误处理
  }
 }
 // 程序正常的代码逻辑
}

这样的代码规范，让我们在初次接手新项目，或者 code review 其他人的代码时，能够通过阅读主干代码而快速理解地代码业务逻辑，而不至于陷入琐碎的 case 处理中。

总结

今天的文章虽然很短，但是希望能给大家带来启示。

在 Go 中 err == nil 不需要判断，而该判断异常 case，正常逻辑置于主干，异常代码置于分支。

在开发组内建立起一套良好的代码规范，会有助于提升代码可读性以及工作协作效率。如果你们还没有类似的规范，那就去参考 Go Code Review Comments、 uber-go/guide 来整活一套？

参考

Go Code Review Comments：https://github.com/golang/go/wiki/CodeReviewComments

uber-go/guide：https://github.com/uber-go/guide