这是我参与「第五届青训营 」笔记创作活动的第3天。

前言

• 编码规范
• Go 语言的性能优化建议
• 性能分析工具 pprof 的使用和工作原理

高质量编程

编码规范

代码格式

• 使用 gofmt 自动格式化代码，保证所有的 Go 代码与官方推荐格式保持一致

注释

• 注释应该解释代码作用
• 注释应该解释代码如何做的
• 注释应该解释代码实现的原因
• 注释应该解释代码什么情况会出错
• 公共符号始终要注释
• 包中声明的每个公共的符号：
  • 变量、常量、函数以及结构都需要添加注释
  • github.com/golang/go/b…
  • github.com/golang/go/b…

命名规范

• variable
  • 简洁胜于冗长
  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
  • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
• function
  • 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
  • 函数名尽量简短
  • 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
  • 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息
• package
  • 只由小写字母组成。不包含大写字母和下划线等字符
  • 简短并包含一定的上下文信息。例如 schema、task 等
  • 不要与标准库同名。例如不要使用 sync 或者 strings

错误和异常处理

• 简单错误处理
  • 优先使用 errors.New 来创建匿名变量来直接表示该错误。有格式化需求时使用 fmt.Errorf
• 错误的 Wrap 和 Unwrap
  • 在 fmt.Errorf 中使用 %w 关键字来将一个错误 wrap 至其错误链中

Go1.13 在 errors 中新增了三个新 API 和一个新的 format 关键字，分别是 errors.Is、errors.As 、errors.Unwrap 以及 fmt.Errorf 的 %w。如果项目运行在小于 Go1.13 的版本中，导入 golang.org/x/xerrors 来使用。以下语法均已 Go1.13 作为标准。

• 错误判定
  • 使用 errors.Is 可以判定错误链上的所有错误是否含有特定的错误。
  • 在错误链上获取特定种类的错误，使用 errors.As
• panic
  • 不建议在业务代码中使用 panic
  • 如果当前 goroutine 中所有 deferred 函数都不包含 recover 就会造成整个程序崩溃
  • 当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic
• recover
  • recover 只能在被 defer 的函数中使用，嵌套无法生效，只在当前 goroutine 生效
  • 如果需要更多的上下文信息，可以 recover 后在 log 中记录当前的调用栈。

小结

• panic 用于真正异常的情况
• error 尽可能提供简明的上下文信息，方便定位问题
• recover 生效范围，在当前 goroutine 的被 defer 的函数中生效

性能调优实战

pprof 功能说明

• pprof 是用于可视化和分析性能分析数据的工具
• 可以知道应用在什么地方耗费了多少 CPU、memory 等运行指标

图片转载自青训营官方账号

性能调优案例

基本概念

• 服务：能单独部署，承载一定功能的程序
• 依赖：Service A 的功能实现依赖 Service B 的响应结果，称为 Service A 依赖 Service B
• 调用链路：能支持一个接口请求的相关服务集合及其相互之间的依赖关系
• 基础库：公共的工具包、中间件

业务优化

• 流程
  • 建立服务性能评估手段
  • 分析性能数据，定位性能瓶颈
  • 重点优化项改造
  • 优化效果验证
• 建立压测评估链路
  • 服务性能评估
  • 构造请求流量
  • 压测范围
  • 性能数据采集
• 分析性能火焰图，定位性能瓶颈
  • pprof 火焰图
• 重点优化项分析
  • 规范组件库使用
  • 高并发场景优化
  • 增加代码检查规则避免增量劣化出现
  • 优化正确性验证
• 上线验证评估
  • 逐步放量，避免出现问题
• 进一步优化，服务整体链路分析
  • 规范上游服务调用接口，明确场景需求
  • 分析业务流程，通过业务流程优化提升服务性能

基础库优化

• 适应范围更广，覆盖更多服务
• AB 实验 SDK 的优化
  • 分析基础库核心逻辑和性能瓶颈
  • 完善改造方案，按需获取，序列化协议优化
  • 内部压测验证
  • 推广业务服务落地验证

参考资料&鸣谢

• 字节跳动青训营
• 掘金平台
• 青训营官方账号 juejin.cn/post/718822…