Go 高质量编程

什么是高质量编程？

各种边界条件考虑完备，能够保证稳定性及时进行异常处理，同时能够达到正确可靠，简洁清晰的目标，易读易维护的代码可称之为高质量代码

不同项目的实际应用场景千变万化，各种语言的特性与语法也各不相同，但是高质量编程需要遵循的原则是相同的，即简单性，可读性，生产力

简单性顾名思义，不要多此一举，尽量用最简单清晰的逻辑来编写代码，能 1+1 = 2 的就不要 1 + 2 - 1 = 2 ，若是代码过于复杂，则会给未来的修复与改进带来极大的困难

可读性同样很容易理解，代码本质上是给人看的，机器读进去的都是 0 和 1 ，但你不可能指望人看懂一大串 01 吧，如果一段代码连让人读懂都做不到，那更别谈后续的维护了

生产力的话，绝大部分项目都不是一个人能够完成的，只有按照规范编写的代码才能提高团队的工作效率，个人风格太强烈的代码并不适用于团队开发

编码规范

格式

可以使用 gofmt 自动格式化代码，gofmt 是 Go 语言官方提供的工具，能够自动格式化 Go 语言代码为官方统一风格，常见的 IDE 都支持方便的配置

当然你也可以使用 goimports 它同样也是 Go 语言官方提供的工具，实际上等于 gofmt 加上依赖包管理，自动增删依赖包引用，将依赖包按字母序排序并分类等功能

注释

注释是代码中不可或缺的一部分，那么它都应该做什么？

  • 注释应该解释代码作用
    • 适合注释公共符号
      • 包中声明的每个公共的符号：变量，常量，函数以及结构都需要添加注释
      • 任何既不明显也不简短的公共功能必须予以注释
      • 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
      • 但有一个例外，不需要注释接口的实现方法
  • 注释应该解释代码如何做的
    • 适合注释实现过程
  • 注释应该解释代码实现的原因
    • 适合解释代码的外部因素
    • 提供额外的上下文
  • 注释应该解释代码什么情况下会出错
    • 适合解释代码的限制条件

流程控制

  • 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
  • 正常流程代码沿着屏幕向下移动
  • 故障问题大多出现在复杂的条件语句和循环语句中

避免语句嵌套，保证正常流程清晰

// Bad
if foo {
    return x
} else {
    return nil
}
 
// Good
if foo {
    return x
}
return nil

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

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

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

错误处理

简单错误

  • 简单的错误是指仅出现一次的错误，且在其他地方不需要捕获该错误
  • 优先使用 error.New 来创建匿名变量直接表示简单错误
  • 如果有格式化的需求，使用 fmt.Errorf，使用 %w 关键字可以将一个错误关联至错误链

错误判定

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

panic

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

recover

  • recover 只能在被 defer 的函数中使用
  • 嵌套无法生效
  • 只在当前 goroutine 生效
  • 如果需要更多的上下文信息，可以 recover 后在 log 中记录当前的调用栈

命名规范

  • 核心目标是降低阅读理解代码的成本
  • 重点考虑上下文信息，设计简洁清晰的名称

变量

  • 简洁胜于冗长
  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
    • 例如使用 ServeHTTP 而不是 ServeHttp
    • 使用 XMLHTTPRequest 或者 xmlHTTPRequest
  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
    • 全局变量在其名字中需要更多的上下文信息，使得在不同的地方可以轻易辨认出其含义
  • 善用具有特殊含义的单词作为变量，如 deadline 等
// Good
func (c *Client) send(req *Request, deadline time.Time)
 
// Bad
func (c *Client) send(req *Request, t time.Time)

函数

  • 函数名不携带包名的上下文信息，因为包名和函数总是成对出现的
  • 函数名应尽量简短
  • 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
  • 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息
package http

// Good
func Serve(I net.Listener, handler Handler) error

// Bad
func ServeHTTP(I net.Listener, handler Handler) error

包

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

以下规则尽量满足，以标准库包名为例

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

性能优化

  • 使用支持基准性能测试的 benchmark 工具
  • 使用切片 slice 时，尽可能的在使用 make() 初始化切片时提供容量信息
  • 使用映射 map 时，提前分配好空间可以减少内存拷贝和 Rehash 的消耗、
  • 使用 strings.Builder 拼接字符串，相比使用 + 拼接重新分配内存，采用内存扩容策略，不需要每次拼接重新分配内存
  • 使用空结构体来节省内存
  • 使用 atomic 包来代替锁的功能，效率较高，对于非数值操作，可以使用 atomic.Value ,能承载一个 interface{}

非自律型摸鱼AI