1 高质量编程
1.1 简介
1.1.1 高质量代码
高质量代码即正确可靠、简洁清晰的代码
1.1.2 编程原则
- 简单性
- 可读性
- 生产力
1.2 编码规范
1.2.1 代码格式
推荐gofmt自动格式化代码！
推荐goimports实现gofmt+依赖包管理！
1.2.2 注释
- 注释要解释代码作用、代码如何做的、代码实现的原因和代码什么情况会出错；
- 公共符号始终要注释，包括包中声明的所有公共符号、既不明显也不简短的公共功能、库中的所有函数。但是，不需要注释实现接口的方法；
1.2.3 命名规范
变量：
- 简洁胜于冗长；
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写。例如ServeHTTP而不是ServeHttp，xmlHTTPRequest（不需要导出时）或XMLHTTPRequest（需要导出时）；
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息。特别是全局变量需要更多的上下文信息使其在不同地方可以被轻松辨认其含义。
函数：
- 函数名不携带包名的上下文信息，因为包名和函数名是成对出现的。比如http包中创建服务的函数命名为Serve而不是ServeHTTP；
- 函数名尽量简短
- 当名为foo的包中某个函数返回类型Foo时，可以省略类型信息而不导致歧义；
- 当名为foo的包中某个函数返回类型T时（T不是Foo），可以在函数名中加入类型信息。
包：
- 只由小写字母组成，不包含大写字母和下划线等字符；
- 简短并包含一定的上下文信息，如schema、task；
- 不要与标准库同名，如sync、strings等；
- 尽量满足不使用常用变量名为包名，如使用bufio而不是buf；
- 尽量满足使用单数而不是复数，如使用encoding而不是encodings；
- 尽量满足谨慎缩写，如使用fmt在不破坏上下文的情况下比format更简短。
1.2.4 控制流程
- 避免嵌套，保持正常流程清晰。如两个分支中都有return语句，则可以去除冗余的else；
- 尽量保持正常代码路径为最小缩进。优先处理错误情况和特殊情况，尽早返回或继续循环来减少嵌套。如下面的例子：
1.2.5 错误和异常处理
简单错误：
- 简单的错误是指仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用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：
- recover只能在被defer的函数中使用
- 嵌套无法生效
- 只在当前goroutine生效
示例：
如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈，如：
1.3 性能优化建议
1.3.1 Benchmark
go test -bench=. -benchmem
1.3.2 Slice
在使用make()初始化切片时提供容量信息
如果原切片较大，代码在原切片基础上新建小切片或原底层数组在内存中有引用，得不到释放，此时可使用copy来替代re-slice，示例如下：
1.3.3 Map
在初始化时提供容量
1.3.4 字符串处理
使用strings.Builder实现字符串拼接，示例：
1.3.5 空结构体
使用空结构体节省内存，可作为各种场景下的占位符使用，示例：
实现集合时，会用到map，此时map的value类型设置为空结构体
1.3.6 atomic包
硬件实现原子操作，比加锁要好。
示例：
2 性能调优实战
2.1 简介
2.1.1 性能调优原则
- 要依靠数据而不是猜测
- 要定位最大瓶颈而不是细枝末节
- 不要过早优化、过度优化
2.2 性能分析工具pprof
2.2.1 功能简介
2.2.2 排查实战
CPU:
go tool pprof "http://localhost:6060/debug/pprof/profile?seconds=10"
命令：top，查看占用资源最多的函数
结果含义：
flat==cum： 该函数没有调用其它函数；
flat==0：该函数只有其它函数的调用。
命令：list，根据指定的正则表达式查找代码行
命令：web，调用关系可视化，需要安装graphviz
堆内存：
go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/heap"
goroutine协程：
go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/goroutine"
mutex锁：
go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/mutex"
block阻塞：
go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/block"
2.2.3 采样过程和原理
CPU:
采样对象是函数调用和它们占用的时间
Heap：
采样程序通过内存分配器在堆上分配和释放的内存，记录分配、释放的大小和数量
Goroutine&ThreadCreate：
记录所有用户发起且在运行中的goroutine
记录程序创建的所有系统线程的信息
Block&Mutex：
采样阻塞操作的次数好耗时，阻塞超过阈值才会记录
采样争抢锁的次数和耗时
2.3 性能调优案例
2.3.1 业务服务优化
- 建立服务性能评估手段
- 分析性能数据，定位性能瓶颈
- 重点优化项改造
- 优化效果验证
2.3.2 基础库优化
AB实验SDK的优化：
- 分析基础库核心逻辑和性能瓶颈
- 内部压测验证
- 推广业务服务落地验证
2.3.3 Go语言优化
编译器&运行时优化：
- 优化内存分配策略
- 优化代码编译流程，生成更高效的程序
- 内部压测验证
- 推广业务服务落地验证
优点：通用性强
