——编写的代码能够达到可靠、简洁清晰的目标可称之为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
- 简单性
- 可读性
- 生产力
编写高质量的Go代码需要注意：
- 代码格式
- 注释
- 命名规范
- 控制流程
- 错误和异常处理
- 代码格式
——使用gofmt自动化格式化代码
- 注释
-
- 注释应该解释代码作用
- 注释应该解释代码如何做的
- 注释应该解释代码实现的原因
- 注释应该解释代码什么情况会出错
- 公共符号始终要注释
- 命名规范
-
- variable：
-
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
- function
-
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
- 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息
- package
-
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如 schema、task 等
- 不要与标准库同名。例如不要使用 sync 或者 strings
以下规则尽量满足，以标准库包名为例
- 不使用常用变量名作为包名。例如使用 bufio 而不是 buf
- 使用单数而不是复数。例如使用 encoding 而不是 encodings
- 谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短
- 小结：
-
- 核心目标是降低阅读理解代码的成本
- 重点考虑上下文信息，设计简洁清晰的名称
-
控制流程
-
- 避免嵌套，保持正常流程清晰
- 尽量保持正常代码路径为最小缩进
-
- 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
- 最常见的正常流程的路径被嵌套在两个 if 条件内
- 成功的退出条件是 return nil，必须仔细匹配大括号来发现
- 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误
- 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套
- 小结
-
- 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
- 正常流程代码沿着屏幕向下移动
- 提升代码可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
-
错误和异常处理
-
- 简单错误
-
- 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用 errors.New 来创建匿名变量来直接表示简单错误
- 如果有格式化的需求，使用 fmt.Errorf
- 错误的Wrap和Unwrap
-
- 错误的 Wrap 实际上是提供了一个 error 嵌套另一个 error 的能力，从而生成一个 error 的跟踪链
- 在 fmt.Errorf 中使用: %w 关键字来将一个错误关联至错误链中
-
错误判定
-
- 判定一个错误是否为特定错误，使用 errors.Is
- 不同于使用 ==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
-
panic
-
- 不建议在业务代码中使用 panic
- 调用函数不包含 recover 会造成程序崩溃
- 若问题可以被屏蔽或解决，建议使用 error 代替 panic
- 当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic
-
recover
-
- recover 只能在被 defer 的函数中使用
- 嵌套无法生效
- 只在当前 goroutine 生效
- defer 的语句是后进先出
- 如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈
-
小结
-
- error 尽可能提供简明的上下文信息链，方便定位问题
- panic 用于真正异常的情况
- recover 生效范围，在当前 goroutine 的被 defer 的函数中生效
