Go高质量编程 | 青训营笔记

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

Go高质量编程

编码规范

1. 代码格式

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

可以使用 gofmt 和 goimports 工具自动格式化代码

goimports = gofmt + 依赖包管理

2. 注释

注释应该做的：

• 解释代码作用(适合注释公共符号)
• 解释代码如何做的(适合注释实现过程)
• 解释代码实现的原因(适合解释代码的外部因素，提供额外上下文)
• 解释代码什么情况会出错(适合解释代码的限制条件)
• 公共符号始终要注释（不需要注释实现接口的方法）

3. 命名规范

变量

• 简洁胜于冗长

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

  • 例如使用 ServerHTTP 而不是 ServerHttp
  • 使用 XMLHTTPRequest 或是 xmlHTTPRequest 而不是 XmlHttpRequest

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

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

举例：for循环

// Bad
for index := 0; index < len(s); index++ {
    // do sth.
}
​
// Good
for i := 0; i < len(s); i++ {
    // do sth.
}

i 和 index 作用域范围仅限于 for 循环内，index 的额外冗长几乎没有增加对于程序的理解，所以用更短的 i

// Good
func (c *Client) send(req *Request, deadline time.Time)
​
// Bad
func (c *Client) send(req *Request, t time.Time)

• 将 deadline 换成 t 降低了变量名的信息量
• deadline 指截止时间，有特定的含义
• t 常代指任意时间。

函数

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

举例：http 包中创建服务的函数如何命名更好？

package http
​
// Good
func Serve(I net.Listener, handler Handler) error
​
// Bad
func ServeHTTP(I net.Listener, handler Handler) error

包

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

以下规则尽量满足

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

4. 控制流程

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

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

5.错误和异常处理

• 对于简单错误（仅出现一次，在其他地方不需要捕获），优先使用 errors.New 创建匿名变量来直接表示，有格式化需求，可以使用 fmt.Errorf

• 错误的 Wrap 和 Unwrap

  Wrap 实际上是提供了一个 error 嵌套另一个 error 的能力，从而生成了一个 error 的跟踪链

  在 fmt.Errorf 中使用 %w 将一个错误关联至错误链

• 错误判定

  使用 errors.Is 判定一个错误是否为特定错误，比起使用 == 的好处是可以判断错误链上的所有错误是否含有特定错误

  使用 errors.As 获取错误链上特定种类的错误

• panic

  不建议业务代码中使用 panic

  调用函数不包含 revocer 会造成程序崩溃

  若函数可以被屏蔽或解决，建议使用 error

  当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 中使用 panic

• recover

  recover 只能在被 defer 的函数中使用

  嵌套无法生效

  只在 goroutine 生效

  defer 的语句是后进先出

如果需要更多的上下文信息，可以 recover 后在 log 中记录当前的调用栈

性能优化

1. Benchmark

go test -bench=. -benchmem

2. slice、map 预分配内存

尽可能在使用 make() 初始化切片时指定容量信息

在已有切片基础上创建切片，不会创建新的底层数组，可使用 copy 替代 re-slice

3. 字符串拼接使用 strings.Builder

直接使用 + 拼接最慢，使用 strings.Builder 与 bytes.Buffer 相近， strings.Builder 最快

字符串在Go语言中是不可变类型，占用内存大小是固定的

使用 + 每次都会重新分配内存

而另外两个底层都是 []byte

内存扩容策略，不需要每次拼接都重新分配内存

4. 使用空结构体节省内存

struct{} 实例不占据任何内存空间，可作为各种场景下的占位符使用

例如实现 Set，可以考虑将 map 的值设为空结构体

5. atomic包

使用 atomic 代替锁，效率更高

sync.Mutex 应该用来保护一段逻辑，不仅仅用于保护一个变量

非数值操作，可以使用 atomic.Value ，能承载一个 interface{}