这是我参与「第三届青训营 -后端场」笔记创作活动的的第2篇笔记。
高质量编程
简介
编写的代码能够达到正确可靠、简洁清晰的目标可以称之为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
编程原则
实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的。
简单性
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进 可读性
- 代码是写给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读 生产力
- 团队整体工作效率非常重要
编码规范
如何编写高质量的Go代码？
- 代码格式
- 注释
- 命名规范
- 控制流程
- 错误和异常处理
编码规范-代码格式
推荐使用gofmt自动格式化代码
gofmt
Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格，常见IDE都支持方便的配置。
goimports
也是Go语言官方挺的工具，实际等于gofmt加上依赖包管理，自动增删依赖包引用，将依赖包按字母序排序并分类。
编码规范-注释
- 注释应该解释代码作用（比如对外提供的函数注释描述它的功能和用途）
- 注释应该解释代码如何做的（注释实现过程）
- 注释应该解释代码实现的原因（解释代码的外部因素、提供额外上下文）
- 注释应该解释代码什么情况会出错（解释代码的限制条件）
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.ls
- 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
- 在错误链上获取特定种类的错误，使用errors.As
panic
- 不建议在业务代码中使用panic
- 调用函数不包含recover会造成程序崩溃
- 若问题可以被屏蔽或解决，建议使用error代替panic
- 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic recover
- recover只能再被defer的函数中使用
- 嵌套无法生效
- 嵌套只在当前goroutine生效
- defer的语句是后进先出
- 如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈
结论
- error尽可能提供简明的上下文信息链，方便定位问题
- panic用于真正异常的情况
- recover生效范围，在当前goroutine的被defer的函数中生效
性能优化建议
- 性能优化的前提是满足正确可靠、简洁清晰得过质量因素
- 性能优化是综合评估，有时候时间效率和空间效率可能队里
- 针对Go语言特性，介绍Go相关的性能优化建议
性能调优
性能调优原则：要依赖数据不是猜测；要定位最大瓶颈而不是细枝末节；不要过早优化；不要过度优化。
