这是我参与「第五届青训营 」笔记创作活动的第5天
高质量编程
高质量：达到正确可靠、简洁清晰
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
编程原则：
- 简单性
- 可读性
- 生产力
如何编写高质量代码： 公共符号始终要注释，但不需要注释实现接口的方法
代码格式：
- 使用gofmt自动格式化代码
注释：
- 应该解释代码作用
- 应该解释代码如何做的
- 应该解释代码实现的原因
- 应该解释代码什么情况会出错
变量命名规范：
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 变量距离其被使用的地方越远，则需要携带更多的上下文信息
函数命名规范：
- 函数名不携带包名的上下文信息
- 尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型不是Foo时，可以在函数名中加入类型信息
package命名规范：
- 小写字母组成，不包含大写字母和下划线
- 简短并包含一定的上下文信息
- 不要与标准库同名
- 不适用常用变量名作为包名
- 尽量使用单数而不是复数
- 谨慎地使用缩写
控制流程：
- 如果两个分支都包含return语句，则可以去除冗余的else
- 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
简单错误：
- 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用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:
- 只能在被defer的函数中使用
- 嵌套无法生效
- 只能在当前goroutine
- defer语句后进先出
- 如果需要更多的上下文信息，可以recover后再log中记录当前的调用栈
性能调优实战
性能优化是综合评价，有时候时间效率和空间效率可能对立
Benchmark
go test -bench=. -benchmem
性能优化建议
slice:
- 预分配内存：尽可能在使用make()初始化切片时提供容量信息
- 在已有切片上创建切片，不会创建新的底层数据（原切片较大，代码在原切片基础上新建小切片；原底层数组在内存中有引用，得不到释放），使用copy代替re-slice
map:
- 预分配内存
字符串处理：
- 使用strings.Builder 拼接字符串
使用空结构体节省内存：
- 空结构体struct{}实例不占据任何内存空间
- 可作为占位符使用
atomic包：
- atomic操作通过硬件实现，效率比锁高
性能优化分析工具
原则：
- 依据数据而不是猜测
- 要定位最大瓶颈而不是细枝末节
- 不要过早优化
- 不要过度优化
