这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
高质量编程与性能调优实战
- 课程代码：
[wolfogre/go-pprof-practice: go pprof practice. (github.com)](https://github.com/wolfogre/go-pprof-practice)
一、高质量编程
高质量编程简介
高质量代码
什么是高质量？
—— 编写的代码能够达到正确可靠、简介清晰的目标可称之为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理是否可靠，稳定性是否得到保证
- 是否易读易维护
编程原则
-
简单性：
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
-
可读性：
- 代码是写给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读
-
生产力：
- 团队整体工作效率非常重要
编码规范
代码格式
- 推荐使用
gofmt自动格式化代码 gofmt：Go 语言官方提供的工具，能自动格式化 Go 语言代码未官方统一风格，常见 IDE 都支持方便的配置goimports：实际等于gofmt加上依赖包管理，自动增删依赖的包引用，将依赖包按字母序排序并分类
-
注释
- 注释应该解释代码作用
- 注释应该解释代码如何做的
- 注释应该解释代码实现的原因
- 注释应该解释代码什么情况会出错
命名规范
变量命名
-
简洁胜于冗长
-
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用
ServerHTTP而不是ServerHttp - 使用
XMLHTTPRequest或者xmlHTTPRequest
- 例如使用
-
变量距离其被使用的地方越远，则需要携带更多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
函数命名
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的函数名尽量简短
- 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
- 当名为 foo 的包某个函数返回类型 T 时 (T并不是 Foo) ，可以在函数名中加入类型信息
包名命名
- 只有小写字母组成，不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息
- 不要与标准库同名
控制流程
- 避免嵌套，保持正常流程清晰
- 尽量保持正常代码路径为最小缩进
- 提升代码可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
错误和异常处理
简单错误
简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用
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 中记录当前的调用栈
性能优化建议
Benchmark
- 性能表现需要实际数据衡量
- Go 语言提供了支持基准性能测试的 benchmark 工具
go test -bench=. -benchmem
预分配内存
- 尽可能在使用
make()初始化 slice 和 map 时提供容量信息
字符串处理
- 使用
strings.Builder实现字符串拼接
空结构体
- 使用空结构体节省内存
使用 atomic 包
二、性能调优
性能调优简介
- 要依靠数据而不是猜测
- 要定位最大瓶颈而不是细枝末节
- 不要过早优化
- 不要过度优化
性能分析工具 pprof
pprof 是用于可视化和分析性能分析数据的工具，能够知道应用在什么地方耗费了多少 CPU、Memory
