高质量编程与性能调优实战 ｜ 青训营笔记

峰不二子的小迷弟
92 阅读10分钟

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

一、本堂课重点内容

  • 介绍编码规范，帮助大家写出高质量程序

  • 介绍 Go 语言的性能优化建议，分析对比不同方式对性能的影响和背后的原理

  • 讲解常用性能分析工具 pprof 的使用和工作原理，熟悉排查程序性能问题的基本流程

  • 分析性能调优实际案例，介绍实际性能调优时的工作内容

image.png

你将获得什么

  • 如何编写更简洁清晰的代码
  • 常用 Go 语言程序优化手段
  • 熟悉 Go 程序性能分析工具
  • 了解工程中性能优化的原则和流程

二、详细知识点介绍

1. 高质量编程

  • 高质量编程简介
  • 编码规范
  • 性能优化建议

1.1 简介

什么是高质量——编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码

  • 各种边界条件是否考虑完备
  • 异常情况处理，稳定性保证
  • 易读易维护

编程原则

实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的

简单性

消除“多余的复杂性”，以简单清晰的逻辑编写代码 不理解的代码无法修复改进

可读性

代码是给人看的，而不是机器 编写可维护代码的第一步是确保代码可读

生产力

团队整体工作效率非常重要

—— Go 语言开发者 Dave Cheney

1.2 编码规范

如何编写高质量的 Go 代码

  • 代码格式
  • 注释
  • 命名规范
  • 控制流程
  • 错误和异常处理

1.2.1 编码规范 - 代码格式

推荐使用 gofmt 自动格式化代码

gofmt

Go 语言官方提供的工具，能自动格式化 Go 语言代码为官方统一风格，常见 IDE 都支持方便的配置

goimports

也是 Go 语言官方提供的工具，实际等于 gofmt 加上依赖包管理，自动增删依赖的包引用、将依赖包按字母排序并分类

1.2.2 编码规范 - 注释

公共符号始终要注释

  • 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
  • 任何既不明显也不简短的公共功能必须予以注释
  • 无论长度或复杂程度如何，对库中的任何函数都必须进行注释

有一个例外，不需要注释实现接口的方法。具体不要像下面这样做

// Read implements the io.Reader interface
func (r *FileReader) Read(buf []byte) (int, error)

简介

  • 注释应该解释代码作用（解释公共符号）
  • 注释应该解释代码如何做的（解释实现过程）
  • 注释应该解释代码实现的原因（解释代码的外部因素，提供额外上下文）
  • 注释应该解释代码什么情况会出错（解释代码的限制条件）

Good code has lots of comments, bad code requires lots of comments

—— Dave Thomas and Andrew Hunt

1.2.3 编码规范 - 命名规范

variable

  • 简洁胜于冗长
  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写，例如使用 ServeHTTP 而不是 ServeHttp
  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
  • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

function

函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的

函数名尽量简短

当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义

当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息

package

  • 只由小写字母组成。不包含大写字母和下划线等字符
  • 简短并包含一定的上下文信息。例如 schema、task 等
  • 不要与标准库同名。例如不要使用 sync 或者 strings

以下规则尽量满足，以标准库包名为例

  • 不使用常用变量名作为包名。例如使用 bufio 而不是 buf
  • 使用单数而不是复数。例如使用 encoding 而不是 encodings
  • 谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短

Good naming is like a good joke. If you have to explain it, it's not funny

—— Dave Cheney

1.2.4 编码规范 - 控制流程

避免嵌套，保持正常流程清晰

尽量保持正常代码路径为最小缩进

  • 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
  • 最常见的正常流程的路径被嵌套在两个 if 条件内
  • 成功的退出条件是 return nil，必须仔细匹配大括号来发现
  • 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误
  • 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套

小结

  • 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
  • 正常流程代码沿着屏幕向下移动
  • 提升代码可维护性和可读性
  • 故障问题大多出现在复杂的条件语句和循环语句中

1.2.5 编码规范 - 错误和异常处理

简单错误

  • 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
  • 优先使用 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 中记录当前的调用栈

小结

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

1.3 性能优化建议

简介

  • 性能优化的前提是满足正确可靠、简洁清晰等质量因素
  • 性能优化是综合评估，有时候时间效率和空间效率可能对立
  • 针对 Go 语言特性，介绍 Go 相关的性能优化建议

如何使用

  • 性能表现需要实际数据衡量
  • Go 语言提供了支持基准性能测试的 benchmark 工具

go test -bench=. -benchmem

1.3.1 性能优化建议 - Benchmark

结果说明

WECYQX%2H8A6S)~_U{N3LRR.png

1.3.2 性能优化建议 - Slice

slice 预分配内存

尽可能在使用 make() 初始化切片时提供容量信息

  • 切片本质是一个数组片段的描述
  • 包括数组指针片段的长度片段的容量（不改变内存分配情况下的最大长度）
  • 切片操作并不复制切片指向的元素
  • 创建一个新的切片会复用原来切片的底层数组

另一个陷阱：大内存未释放

  • 在已有切片基础上创建切片，不会创建新的底层数组
  • 原切片较大，代码在原切片基础上新建小切片
  • 原底层数组在内存中有引用，得不到释放
  • 可使用 copy 代替 re-slice

1.3.3 性能优化建议 - Map

map 预分配内存

IY_6R9(WCX~V1E5%N64765R.png

分析

  • 不断向 map 中添加元素的操作会触发 map 的扩容
  • 提前分配好空间可以减少内存拷贝和 Rehash 的消耗
  • 建议根据实际需求提前预估计好需要的空间

1.3.4 性能优化建议 - 字符串处理

使用 strings.Builder

常见的字符串拼接方式

KF%MFQ3WU(RQ~2ML1VB3S.png

  • 使用 + 拼接性能最差，strings.Builder，bytes.Buffer 相近，strings.Buffer 更快
  • 字符串在 Go 语言中是不可变类型，占用内存大小是固定的
  • 使用 + 每次都会重新分配内存
  • strings.Builder，bytes.Buffer 底层都是 []byte 数组
  • 内存扩容策略，不需要每次拼接重新分配内存
  • bytes.Buffer 转化为字符串时重新申请了一块空间
  • strings.Builder 直接将底层的 []byte 转换了字符串类型返回

1.3.5 性能优化建议 - 空结构体

使用空结构体节省内存

  • 空结构体 struct{} 实例不占据任何的内存空间
  • 可作为各种场景下的占位符使用
  • 节省空间
  • 空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符
  • 实现 set，可以考虑用 map 来代替
  • 对于这个场景，只需要用到 map 的键，而不需要值
  • 即使是将 map 的值设置为 bool 类型，也会多占据 1 个字节空间

如何使用 atomic 包

CA9JD4G3EE9LRM%3.png

  • 锁的实现是通过操作系统来实现，属于系统调用
  • atomic 操作是通过硬件实现，效率比锁高
  • sync.Mutex 应该用来保护一段逻辑，不仅仅用于保护一个变量
  • 对于非数值操作，可以使用 atomic.Value，能承载一个 interface{}

小结

  • 避免常见的性能陷阱可以保证大部分程序的性能
  • 普通应用代码，不要一味地追求程序的性能
  • 越高级的性能优化手段越容易出现问题
  • 在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能

2. 性能调优实战

  • 性能调优简介
  • 性能分析工具 pprof 实战
  • 性能调优案例

2.1 简介

性能调优原则

  • 要依靠数据不是猜测
  • 要定位最大瓶颈而不是细枝末节
  • 不要过早优化
  • 不要过度优化

2.2 性能分析工具 pprof

说明

  • 希望知道应用在什么地方耗费了多少 CPU、Memory
  • pprof 是用于可视化和分析性能分析数据的工具
  • pprof 功能简介
  • pprof 排查实战
  • pprof 的采样过程和原理

2.2.1 性能分析工具 pprof - 功能简介

VZ}KU9KUJJ92P)9~I{6$@V.png

2.2.2 性能分析工具 pprof - 排查实战

搭建 pprof 实践项目

浏览器查看指标

CPU

  • 命令：topN
  • 查看占用资源最多的函数

flat 当前函数本身的执行耗时 flat% flat 占 CPU 总时间的比例 sum% 上面每一行的 flat% 总和 cum 指当前函数本身加上其调用函数的总耗时 cum% cum 占 CPU 总时间的比例

  • Flat == Cum，函数中没有调用其他函数
  • Flat == 0，函数中只有其他函数的调用

命令：list

根据指定的正则表达式查找代码行

Heap - 堆内存

  • alloc_objects：程序累计申请的对象数
  • alloc_space：程序累计申请的内存大小
  • inuse_objects：程序当前持有的对象数
  • inuse_space：程序当前占用的内存大小

goroutinue - 协程

mutex - 锁

block - 阻塞

线程创建 - ThreadCreate

三、实践练习例子

四、课后个人总结

差太远了

五、引用参考

无

avatar
文章
阅读
粉丝