这是我参与「第五届青训营」伴学笔记创作活动的第 3 天
高质量编程
高质量：
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
编程原则：
- 简单性
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法改进
- 可读性
- 代码是给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读
- 生产力
- 团队整体工作效率非常重要
编码规范
代码格式
-
gofmt
自动格式化代码：Go 官方工具，能自动格式化 Go 语言代码为官方统一风格 -
goimports
Go 官方工具，实际等于 gofmt 加上依赖包管理，自动增删依赖的包引用，将依赖包按字母顺序排序并分类
注释
- 注释应该解释代码作用
- 适合注释公共符号
- 注释应该解释代码如何做的
- 适合注释实现过程
- 注释应该解释代码实现的原因
- 适合解释代码的外部因素
- 提供额外上下文
- 注释应该解释代码什么情况会出错
- 适合解释代码的限制条件
- 公共符号始终要注释
- 包中声明的每个公共符号：变量、常量、函数、结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
- 不需要注释实现接口的方法，因为不能提供额外信息
命名规范
variable
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
function
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当函数返回类型和包名一致的时候，可以省略类型信息而不导致歧义
- 如返回类型不一致，可以在函数名中加入类型信息
package
- 只由小写字字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如 schema、task 等
- 不要与标准库同名。例如不要使用 sync 或者 strings
- 不使用常用变量名作为包名。例如使用 bufio 而不是 buf
- 使用单数而不是双数。例如使用 encoding 而不是 encodings
- 谨慎使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短
控制流程
- 避免嵌套，保持正常流程清晰
- 尽量保持正常代码路径为最小缩进
- 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
小结：
- 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
- 正常代码流程沿着屏幕向下移动
- 提升代码可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
错误和异常处理
简单错误
- 简单错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用 errors.New 来创建匿名变量来直接表示简单错误
- 如果有格式化的需求，使用 fmt.Errorf
错误的 Wrap 和 Unwrap
- 错误的 Wrap 实际上时提供了一个 error 嵌套另一个 error 的能力，从而生成一个 error 的跟踪链
- 在 fmt.Errorf 中使用：%w关键字来将一个错误关联至错误链中
错误判定
- 判定一个错误是否为特定错误，使用 errors.ls
- 不同于使用==，使用该方法可以判定错误链上的所有错误是否包含有特定的错误
- 在错误链上获取特定种类的错误，使用 errors.As
panic
- 不建议在业务代码中使用 panic
- 调用函数不包含 recover 会造成程序崩溃
- 若问题可以被屏蔽或解决，建议使用 error 代替 panic
- 当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic
