高质量编程

什么是高质量

高质量就是指编写的代码能够达到正确可靠、简洁清晰的目标

• 各种边界条件是否考虑完备
• 异常情况处理，保证稳定性
• 易读易维护

编程原则

不论学习哪种编程语言，都要遵循编程原则，高质量编程遵循的原则都是相通的。

简单性

• 消除“多余的复杂性”，以简单清晰的逻辑编写代码
• 不理解的代码无法修复改进

可读性

• 代码是给人看的，而不是给机器看
• 编写代码可维护代码的第一步就是确保代码的可读性

生产力

• 团队整体工作效率非常重要

编码规范

• 代码格式
• 注释
• 命名规范
• 控制流程
• 错误和异常处理

代码格式

Go语言官方提供了一个工具——gofmt，该工具可以自动格式化 Go 语言代码为官方统一风格，并且常见的IDE都支持方便的配置。

官方还提供了另一个工具——goimports，相当于gofmt加上依赖包管理，自动增删依赖的包应用、将依赖包按字母顺序排序并分类。

注释

Good code has lots of comments，bad code required lots of comments

好的代码有很多注释，坏的代码需要很多的注释

——Dave Thomas and Andrew Hunt

注释应该做到：

• 解释代码作用
• 解释代码如何做的
• 解释代码实现的原因
• 解释代码什么情况会出错

注释不仅可以辅助他人阅读，更重要的是方便我们以后查看。毕竟一个逻辑清晰、代码优秀的脚本，自己看着也很有成就感。注释能够更好的帮助程序员了解脚本，哪怕是自己写的脚本，一段时间后去看也会有些看不懂，这时候注释就起了很大的作用。

命名规范

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

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

控制流程

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

错误和异常处理

简单错误

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

错误的 Wrap 和 Unwrap

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

错误判定

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

error 尽可能提供简明的上下文信息链，方便定位问题

panic 用于真正异常的情况

recover 生效范围，在当前 goroutine 的被 defer 的函数中生效