Go编码规范 | 青训营笔记

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

从一个Javaer的角度来学习Go

代码格式

推荐使用gofmt(统一为官方风格)，goimports(依赖管理)

注释

注释应该做的

• 注释应该解释代码作用

  • 适合注释公共符号

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

  • 适合注释实现过程

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

  • 适合解释代码的外部因素
  • 提供额外上下文

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

  • 适合解释代码的限制条件

公共符号始终要注释

小结：

• 代码是最好的注释
• 注释应该提供代码未表达出的上下文信息

命名规范

variable

• 简洁胜于冗长
• 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
• 变量距离其被使用的地方越远，则需要携带越多的上下文信息

function

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

package

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

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

• 不使用常用变量名作为包名
• 使用单数而不是复数
• 谨慎地使用缩写

小结：

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

控制流程

• 避免嵌套，保持正常流程清晰
• 尽量保持正常代码路径为最小缩进(优先处理错误情况/特殊情况)，尽早返回或继续循环来减少嵌套

小结：

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

错误和异常处理

简单错误

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

错误的Wrap和Unwrap

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

错误判定

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

panic

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

recover

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

小结：

• error尽可能提供的简明的上下文信息链，方便定位问题
• panic用于真正异常的情况
• recover生效范围，在当期goroutine的被defer的函数中生效