这是我参与「第五届青训营 」伴学笔记创作活动的第3天，在过去几天，我学习了go语言的高质量编程与性能调优。

编码规范

代码格式

• 使用 gofmt 自动格式化代码，保证所有的 Go 代码与官方推荐格式保持一致

• 提升可读性，风格一致的代码更容易维护、需要更少的学习成本、团队合作成本，同时可以降低 Review 成本

注释

• 注释应该解释代码作用

• 注释应该解释代码如何做的

• 注释应该解释代码实现的原因

• 注释应该解释代码什么情况会出错

• 公共符号始终要注释

  • 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释

命名规范

• variable
  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
  • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

• function
  • 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现
  • 函数名尽量简短
  • 当名为foo的包中的某个函数返回类型Foo时，可以省略类型信息而不导致歧义
  • 当名为foo的包中的某个函数返回类型T时，可在函数名中加入类型信息
• package
  • 只由小写字母组成。不包含大写字母和下划线等字符
  • 简短并包含一定的上下文信息。例如schema、task等
  • 不要与标准库同名。例如不要使用sync或者strings

控制流程

• 避免嵌套，保持正常流程清晰
• 如果两个分支中都包含 return 语句，则可以去除冗余的 else
• 尽量保持正常代码路径为最小缩进，优先处理错误情况/特殊情况，并尽早返回或继续循环来减少嵌套，增加可读性

错误和异常处理

• 简单错误处理

  • 简单的错误指只出现一次，且不用被捕获的错误
  • 优先使用 errors.New 来创建匿名变量来直接表示该错误。有格式化需求时使用 fmt.Errorf

• 错误的 Wrap 和 Unwrap

  • 错误的Wrap提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
  • 在 fmt.Errorf 中使用 %w 关键字来将一个错误 wrap 至其错误链中

  err = ****
  fmt.Errorf("reading srcfiles list: %w", err)
  

• 错误判定

  • 使用 errors.Is 可以判定错误链上的所有错误是否含有特定的错误。
  • 在错误链上获取特定种类的错误，使用 errors.As

• panic

  • 不建议在业务代码中使用 panic
  • 如果当前 goroutine 中所有 deferred 函数都不包含 recover 就会造成整个程序崩溃
  • 当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic

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

性能优化建议

slice 预分配内存

• 在尽可能的情况下，在使用 make() 初始化切片时提供容量信息，特别是在追加切片时
• map 预分配内存
• 使用 strings.Builder
• 使用空结构体节省内存
• 使用 atomic 包