这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
高质量编程
高质量编程
- 各种边界条件考虑完备
- 异常情况处理
- 稳定性保证
编码规范
代码格式
推荐使用 gofmt 自动格式化代码，goimports 是go语言官方提供的工具，实际上相当于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母序排序并分类
注释
- 注释应该注释代码作用：适合注释公共符号
- 注释应该解释代码如何做的：适合注释实现过程
- 注释应该解释代码实现的原因：适合解释代码的外部因素，提供额外上下文
- 注释应该解释代码什么情况会出错：适合解释代码的限制条件
命名规范
变量
-
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用ServeHTTP而不是ServeHttp
- 使用XMLHTTPRequest或者xmlHTTPRequest
-
变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
function
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时（T并不是Foo），可以在函数名中加入类型信息
package
- 只由小写字母组成，不含大写字母和下划线等字符
- 简短并包含一定的上下文信息
- 不和标准库同名
错误和异常处理
简单错误
优先使用errors.New来创建匿名变量来直接表示简单错误，如果有格式化需求，使用fmt.Errorf
错误的Wrap和Unwrap
错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成了一个error的跟踪链
在fmt.Errorf中使用：% w 关键字来将一个错误关联至错误链中
性能优化
slice预分配内存
尽可能在使用make()初始化切片时提供容量信息
在已有切片的基础上创建切片，不会创建新的底层数组。原切片较大，代码在原切片基础上新建小切片；原底层数组在内存中有引用，得不到释放。可以使用copy替代re-slice
map预分配内存
- 不断向mao中添加元素的操作会触发map的扩容
- 提前分配好空间可以减少内存拷贝和rehash的消耗
字符串处理
使用 strings.Builder
- 字符串在go语言中是不可变类型，占用内存大小是固定的
- 使用+每次都会重新分配内存
- strings.Builder, bytes.Buffer 底层都是[] byte数组
- 内存扩容策略，不需要每次拼接重新分配内存
- bytes.Buffer 转化为字符串时重新申请了一块空间
- strings.Builder 直接将底层的 []byte 转换成了字符串类型返回
空结构体
- 空结构体 struct {} 实例不占据任何的内存空间
- 实现 Set，可以考虑用 map 来代替
atomic包
- 锁的实现是通过操作系统来实现，属于系统调用
- atomic操作是通过硬件实现，效率比较高
- sync.Mutex 应该用来保护一段逻辑，不仅仅用于保护一个变量（用atomic）
- 对于非数值操作，可以使用 atomic.Value，能承载一个 interface{}
性能调优实战
性能分析工具 pprof
topN
- flat 当前函数本身的执行耗时
- flat% flat占CPU总时间的比例
- sum% 上面每一行的flat%总和
- cum 指当前函数本身加上其调用函数的总耗时
- cum% cum占CPU总时间的比例
Flat == Cum，函数中没有调用其他函数
Flat == 0，函数中只有其他函数的调用
