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

丁牛牛
76 阅读7分钟

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

课堂笔记(高质量编程与性能调优实战)

本节课重点内容: 学会如何编写简洁清晰的代码、常用Go语言程序优化手段、熟悉Go程序性能分析工具、了解工程中性能优化的原则和流程

1. 高质量编程

什么是高质量？

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

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

编程原则

  • 简单性

消除“多余的复杂性”，以简单清晰的逻辑编写代码

不理解的代码无法进行修复改进

  • 可读性

代码是写给人看的，而不是机器

编写可维护代码的第一步是确保代码可读

  • 生产力

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

编码规范

代码格式

gofmt是Go语言官方提供的工具，可以自动化Go语言代码为官方统一风格

goimports也是Go语言官方提供的工具，可以自动增删依赖的包引用、将依赖包按字母序排序并分类

注释

  • 注释应该解释代码作用
  • 注释应该解释代码如何做的
  • 注释应该解释代码实现的原因
  • 注释应该解释代码什么情况会出错

命名规范

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

以下规则尽量满足(以标准库包名为例)：

  • 不适用常用变量作为包名
  • 使用单数而不是复数
  • 谨慎地使用缩写

控制流程

  • 避免嵌套，保持正常流程清晰
  • 尽量保持正常代码路径为最小缩进，优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
  • 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
  • 正常流程代码沿着屏幕向下移动
  • 提升代码可维护性和可读性
  • 故障问题大多出现在复杂的条件语句和循环语句中

错误和异常处理

  • 简单错误

简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误

优先使用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生效

defer的语句是后进先出

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

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

性能优化建议

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

Banchmark

Go语言提供了支持基准性能测试的benchmark工具

  1. 在测试文件中编写benchmark函数
  2. 通过命令go test -bench=, -benchmem运行

捕获.PNG

Slice

  • slice预分配内存，尽可能在使用make()初始化切片时提供容量信息，预分配只有一次内存分配，否则会多次自动扩容
  • 切片本质是一个数组片段的描述，包括：数组指针、片段长度、片段容量(不改变内存分配情况下最大长度)
  • 切片操作并不复制切片指向的元素
  • 创建一个新的切片会复用原来切片的底层数组

append时有两种情况：

当append之后的长度小于等于cap，将会直接利用原底层数组剩余的空间

当append后的长度大于cap时。则会分配一块更大的区域来容纳新的底层数组

  • 大内存未释放

在已有切片基础上创建切片，不会创建新的底层数组

原切片较大，代码在原切片基础上新建小切片，在原切片基础上切片，虽然只使用了很小一段，但底层数组再内存中仍然占据大量空间，得不到释放

原底层数组在内存中有引用，得不到释放

  • 可使用copy替代re-slice

Map

  • map预分配内存

不断向map中添加元素的操作会触发map的扩容

提前分配好空间可以减少内存拷贝和Rehash的消耗

建议根据实际需求提前预估好需要的空间

字符串处理

  • 使用strings.Builder

捕获.PNG

  • 使用strings.Builder

image.png

  • 使用+拼接性能最差，strings.Builder、bytes.Buffer相近，strings.Buffer更快

字符串在Go语言中是不可变类型，占用内存大小是固定的

使用+每次都会重新分配内存

strings.Builder、bytes.Buffer底层都是[]byte数组

内存扩容策略，不需要每次拼接重新分配内存

buytes.Buffer转为字符串时重新申请了一块空间

strings.Builder直接将底层的[]byte转换成了字符串类型返回

  • 字符串拼接预分配

image.png

空结构体

使用空结构体节省内存

  • 空结构体struct{}实例不占据任何内存空间
  • 可作为各种场景下的占位符使用

image.png

  • 实现Set，可以考虑用map来代替

atomic包

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

image.png

2. 性能调优实战

性能分析工具pprof

pprof功能简介

image.png

pprof排查实战
  1. 在主函数包中导入net/http/pprof
  2. 在游览器打开http://localhost:6060/debug/pprof

image.png allocs：内存分配情况、blocks：阻塞操作情况、cmdline：程序启动命令、goroutine：当前所有goroutine的堆栈信息、heap：堆上内存使用情况(同aalloc)、mutex：锁竞争操作情况、profile：CPU占用情况、threadcreate：当前所有创建的系统线程的堆栈信息、trace：程序运行跟踪信息

  1. go tool pprof "http://localhost:6060/debug/pprof/profile?seconds=10"

seconds=10：采样10秒(网页打开默认采样60秒)

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

image.png

Cum - Flat得到的是函数中调用其它函数所消耗的资源

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

  1. 命令list：根据指定的正则表达式查找代码行

  2. 命令web：调用关系可视化

  3. go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/heap"

heap可更改为其它参数

avatar
文章
阅读
粉丝