Go语言基础——高质量编程及编码规范 ｜ 青训营笔记

LongBob
80 阅读5分钟

这是我参与「第五届青训营 」笔记创作活动的第4天

高质量编程与编码规范

1：评价标准

①各种边界条件是否考虑完备
②异常情况处理，稳定性保证
③易读易维护

2：原则

（1）简单性

消除“多余的复杂性”，以简单清晰的逻辑编写代码
不理解的代码无法修复改进

（2）可读性

代码是写给人看的，而不是机器
编写可维护代码的第一步是确保代码可读

（3）生产力

团队整体工作效率非常重要

3：如何编写高质量的Go代码

（1）代码格式

①推荐使用gofmt自动格式化代码

gofmt： Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格
goimports： 也是Go语言官方提供的工具，实际等于gofmt 加上依赖包管理，可以自动增删依赖的包引用、将依赖包按字母序排序并分类

（2）注释

①注释的要求

  • 注释应该解释代码作用：适合注释公共符号（变量、函数......）
image.png
  • 注释应该解释代码如何做的：适合注释实现过程
image.png
  • 注释应该解释代码实现的原因：适合解释代码的外部因素+提供额外上下文信息
image.png
  • 注释应该解释代码什么情况会出错：适合解释代码的限制条件
image.png

②公共符号始终要注释

包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
任何既不明显也不简短的公共功能必须予以注释
无论长度或复杂程度如何，对库中的任何函数都必须进行注释

image.png

例外：不需要注释实现接口的方法。具体不要像下面这样做

image.png

此外，如果临近的有关联的公共符号，前面的注释已经解释清楚各项信息了，后面的不需要重复相同信息

（3）命名规范

①变量命名

  • 简洁胜于冗长

  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写

    • 例如使用 ServeHTTP而不是ServeHttp
    • 使用XMLHTTPRequest或者xmlHTTPRequest

  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息

    • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

  • 例子：

    • i和index的作用域范围仅限于for循环内部时，index的额外冗长几乎没有增加对于程序的理解
    image.png
    • 将deadline替换成t降低了变量名的信息量，t常代指任意时间，deadline指截止时间，有特定的含义
    image.png

②函数命名

  • 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的

    • 例如http 包中创建服务的函数命名：
      func Serve(l net.Listener, handler Handler) error
      func ServeHTTP(l net.Listener, handler Handler) error
      前者好于后者，因为在调用包下该函数时，就是http.serve，已经有包名了，否则就是http.serveHTTP
    image.png image.png

  • 函数名尽量简短

  • 当名为foo 的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义

  • 当名为foo 的包某个函数返回类型T时(T并不是Foo)，可以在函数名中加入类型信息

③包命名

  • 只由小写字母组成。不包含大写字母和下划线等字符
  • 简短并包含一定的上下文信息。例如schema、task 等
  • 不要与标准库同名。例如不要使用sync或者strings

尽量满足：

  • 不使用常用变量名作为包名。例如使用bufio而不是buf
  • 使用单数而不是复数。例如使用encoding而不是encodings
  • 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比 format更加简短

（4）控制流程

①避免嵌套，保持正常流程清晰

例子：如果两个分支中都包含return语句，则可以去除冗余的else

image.png

②尽量保持正常代码路径为最小缩进

优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套

image.png image.png
  • 最常见的正常流程的路径被嵌套在两个if 条件内
  • 成功的退出条件是return nil，必须仔细匹配大括号来发现
  • 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误
  • 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套

（5）错误和异常处理

①简单错误

  • 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
  • 优先使用errors.New来创建匿名变量来直接表示简单错误
  • 如果有格式化的需求，使用fmt.Errorf
image.png

②错误的wrap和unwrap

  • 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
  • 在fmt.Errorf中使用：%w关键字来将一个错误关联至错误链中
image.png

注：Go1.13在errors中新增了三个新API和一个新的format关键字，分别是errors.ls、errors.As、 errors.Unwrap以及fmt.Errorf的%w。如果项目运行在小于Go1.13的版本中，导入golang.org/x/xerrors来使用

③错误判定

  • 判定一个错误是否为特定错误，使用errors.ls
  • 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
image.png
  • 在错误链上获取特定种类的错误，使用errors.As
image.png

④panic

  • 不建议在业务代码中使用panic
  • 调用函数不包含recover会造成程序崩溃
  • 若问题可以被屏蔽或解决，建议使用error代替 panic
  • 当程序启动阶段发生不可逆转的错误，继续运行没有意义时,可以在init 或 main函数中使用panic
image.png

⑤recover

  • recover只能在被 defer 的函数中使用
  • 嵌套无法生效
  • 只在当前goroutine生效
  • defer的语句是后进先出
image.png
  • 如果需要更多的上下文信息，可以recover后在 log中记录当前的调用栈
image.png
avatar
文章
阅读
粉丝