社区编辑申请
注册/登录
写点规范的 Go 代码,你学会了吗?
开发 后端
在公司进行代码开发,一般都会制定一套编程规范。良好的代码规范可以改善项目可读性,提高团队开发的合作效率。

本文转载自微信公众号「Golang技术分享」,作者机器铃砍菜刀。转载本文请联系Golang技术分享公众号。

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

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

启示代码

我们直接看一段代码

  1. type MyselfError struct{} 
  2.  
  3. func (m *MyselfError) Error() string { 
  4.  return "实现 error 接口的 Error 方法" 
  5.  
  6. func someWork() *MyselfError { 
  7.  return nil 
  8.  
  9. func main() { 
  10.  var err error 
  11.  err = someWork() 
  12.  fmt.Println(err == nil) 
  13.  
  14. // outputfalse 

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

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

  1. type error interface { 
  2.     Error() string 

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

主分支代码

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

在 Go 中,不要通过err == nil来做逻辑判断条件。这不光是由于使用它会产生潜在的 bug,这样的代码交于测试童鞋,他们可能也会喷你,你知道是为什么吗?

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

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

错误示例

  1. func bar() { 
  2.  var err error 
  3.  err = foo() 
  4.  if err == nil { 
  5.   // 程序正常的代码逻辑 
  6.  } else { 
  7.   switch err.(type) { 
  8.   case err1: 
  9.    // 做错误处理1 
  10.   case err2: 
  11.    // 做错误处理2 
  12.   default
  13.    // 做通用错误处理 
  14.   } 
  15.  } 

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

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

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

规范示例

  1. func main() { 
  2.  var err error 
  3.  err = foo() 
  4.  if err != nil { 
  5.   switch err.(type) { 
  6.   case err1: 
  7.    // 做错误处理1 
  8.   case err2: 
  9.    // 做错误处理2 
  10.   default
  11.    // 做通用错误处理 
  12.   } 
  13.  } 
  14.  // 程序正常的代码逻辑 

这样的代码规范,让我们在初次接手新项目,或者 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

 

责任编辑:武晓燕 来源: Golang技术分享
相关推荐

2022-04-11 11:38:44

Python代码游戏

2022-04-15 14:31:02

鸿蒙操作系统

2022-05-03 22:25:57

Python浏览器语言

2022-05-11 15:08:52

驱动开发系统移植

2022-05-17 16:56:33

开发工具前端

2022-04-19 11:23:26

release3.1子系统鸿蒙

2022-05-07 10:09:01

开发Java日志

2022-04-26 08:41:54

JDK动态代理方法

2022-04-07 15:28:16

HarmonyOS鸿蒙操作系统

2022-04-01 15:18:04

HarmonyHDF 驱动鸿蒙

2022-05-20 14:54:33

数据安全数字化转型企业

2022-05-06 16:31:27

人工智能自然语言生物特征识别

2022-04-26 08:10:33

MySQL存储InnoDB

2022-05-16 15:35:00

漏洞黑客

2022-05-02 16:27:01

JavaScriptHTMLPython

2022-03-31 07:52:01

Java多线程并发

2022-05-12 14:44:38

数据中心IT云计算

2022-03-18 07:44:59

插件VSCode代码

2022-04-13 09:57:24

Go语言C语言程序开发

2022-03-18 21:27:36

Python无代码

同话题下的热门内容

Python 字符串总结,建议收藏!这份Java日志格式规范,拿走不谢!Mybatis-Plus官方发布分库分表神器,一个依赖轻松搞定!后端思维篇:如何应用设计模式优化代码改变 Python 对象规则的黑魔法 Metaclass几种限流算法的Go语言实现JMeter关联之正则表达式提取器在 Go 中实现一个支持并发的 TCP 服务端

编辑推荐

使用Kotlin做开发一个月后的感想面试官问你什么是消息队列?把这篇甩给他!五大自动化测试的Python框架图文详解两种算法:深度优先遍历(DFS)和广度优先遍历(BFS)2018年最流行的十大编程语言,其中包括你用的语言吗?
我收藏的内容
点赞
收藏

51CTO技术栈公众号