高质量编程和性能调优实战

1. 如何编写简洁清晰的代码
2. 常用 go 语言程序优化手段
3. go 程序性能分析工具
4. 工作中性能优化的原则和流程

编程规范

代码格式：

可以使用官方工具 go fmt 自动格式化，或者使用 go imports 工具，该工具就是 gofmt+依赖包自动管理，能够自动增删依赖包引用，以及依赖包的排序分类

注释：

注释应该解释：代码作用、如何工作、为什么这样实现、什么情况会出错

**是什么、为什么、会怎样、怎么做 **==》 代码作用、为什么这样实现、什么情况出错、如何工作

包中声明的每个公共的符号、变量、常量、函数以及结构都需要添加注释

任何既不明显也不简短的公共功能必须予以注释

无论长度或复杂程度如何对库中的任何函数都必须进行注释

命名规范

变量命名：

函数命名：

• 尽量简洁
• 若包名含有上下文信息，则函数中不需要再带

如：http.serve(…)，包名已经表示 http 了，就不用将函数命名为 serveHTTP()

包命名：

控制流程

• 避免嵌套，保持正常流程的清晰
• 线性原则，处理逻辑尽量走直线，避免深层嵌套

如

错误和异常处理规范

简单的错误：

复杂错误：

如：

对于错误的判定：

如：

如：

panic 使用规范

recover 使用规范：

• 只能在被 defer 的函数中使用

recover 在嵌套中无法生效、且只有在当前 goroutine 生效，defer 语句执行顺序是后进先出，要注意一下执行顺序

• 如果需要更多上下文信息，可以 recover 后在 log 中记录当前的调用栈

性能优化建议

性能如何评估

go 语言官方提供的基准性能测试工具 Benchmark 可以用来衡量程序的性能

go test -bench=. -benchmem

用于 benchmark 性能测试的函数命名以 Benchmark 开头

如：

性能优化建议

slice：

1. slice 预分配内存，尽可能在使用 make 初始化 slice 时提供容量信息
   特别是在循环中，能大大减少内存分配次数，增加程序性能
2. 由于 slice 在已有切片上创建新切片时，仍然使用的原来的底层数组，并不会创建新的底层数组
   因此当原底层数组占用非常大的内存时，而新建小切片相较之下很小时，会导致小切片引用大数组，使得内存得不到释放
   可以使用 copy()来代替在原底层数组上创建小切片

切片的本质是一个数组片段的描述，包括底层数组的指针、长度和容量

如：

测试：

map：类似的，预先分配好内存

使用 strings.Builder 处理字符串

使用“+”直接拼接性能最差，使用 **strings.Builder**最快

strings.Builder > bytes.Buffer > +

原因：

空结构体

如在实现 set 时，set 只需要使用 map 的键，因此可以将结构体作为 map 的值

使用 atomic 包而不是 sync.Mutex 进行线程操作

性能调优

原则：

1. 数据说话，而不是我觉得
2. 优化最大瓶颈，忽略细枝末节
3. 不过早、过度优化

性能分析工具 pprof

用于 go 语言的性能分析工具，主要功能：

• 性能分析：pprof 可以收集程序运行时的性能数据，包括 CPU 使用情况、内存分配、阻塞情况等。
• 多种数据收集方式：支持实时数据收集（通过程序运行时开启）和静态数据收集（通过生成性能报告文件）。
• 可视化：生成的性能报告可以以图形方式可视化，帮助开发者更直观地理解程序性能。可以生成调用图、火焰图等。
• 多种输出格式：支持多种输出格式，如文本、PDF、SVG 等，方便用户分析和共享。

通过 https://github.com/wolfogre/go-pprof-practice 项目可以快速熟悉 pprof 工具

项目使用文档：[https://farmerchillax.github.io/2023/07/04/Go%E6%80%A7%E8%83%BD%E5%88%86%E6%9E%90%E5%B7%A5%E5%85%B7/](https://farmerchillax.github.io/2023/07/04/Go%E6%80%A7%E8%83%BD%E5%88%86%E6%9E%90%E5%B7%A5%E5%85%B7/)

内存管理及优化

自动内存管理(Auto memory management)

自动内存管理：由程序语言的运行时系统（runtime）管理回收动态内存

• 避免手动内存管理，专注业务逻辑
• 保证内存使用的正确性和安全性，避免 double free、 use-after-free 等内存漏洞

自动内存管理负责：

• 为新对象分配空间
• 找到并维护存活着的对象
• 自动回收死亡对象的内存

相关概念

GC：Grabage collction，垃圾回收

更新:2024-11-12 17:18:11
原文: https://www.yuque.com/c10wn/svr7uf/wrkci8t2m0qk5u1l