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

115 阅读3分钟

这是我参与「第三届青训营 -后端场」笔记创作活动的的第3篇笔记。

高质量编程

高质量编程简介

简单性、可读性、生产力

编码规范

如何编写高质量的Go代码

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

代码格式

推荐使用gofmt自动格式化代码 goimport等于gofmt+依赖包管理(自动增删依赖包引用,将依赖包按字母序排序并分类)

注释

解释代码作用、如何做的、代码实现的原因、什么情况会出错。

公共符号是重要注释

命名规范

variable:简洁、缩略词全大写(但当其位于变量开头并且不需要导出时,全小写)、变量距离使用处越远,需要携带越多的上下文信息

function:函数名不携带包名的上下文信息、简短、foo返回值类型是Foo,可省略,否则加入。

package:只由小写字母组成(不包含大写字母和下划线)、简短并包含一定上下文信息、不要与标准库同名。

控制流程

避免嵌套、尽量保持正常代码路径为最小缩进(优先处理错误情况、特殊情况,尽早返回或继续循环来减少嵌套)

错误和异常处理

简单错误(仅出现一次的错误,且在其他地方不需要捕获该错误):

  • 优先使用errors.New来创建匿名变量来直接表示简单错误
  • 如果有格式化的需求,使用fmt.Errorf 错误的Wrap和Unwrap
  • 错误的Wrap提供了一个error嵌套另一个error的能力,从而生成一个error的跟踪链
  • 在fmt.Errorf中使用:%w关键字来将一个错误关联至错误链中 错误判定
  • 判定一个错误是否为特定错误,使用errors.Is
  • 不同于使用==,使用该方法可以判定错误链上的所有错误是否含有特定的错误
  • 在错误链上获取特定种类的错误,使用errors.As 错误和异常处理
  • panic:不建议使用(当程序启动阶段发生不可逆转的错误时,可以在init或main函数中使用panic)
  • recover:recover只能在被defer的函数中使用,嵌套无法生效,只在当前goroutine生效,defer的语句是后进先出

性能优化建议

性能优化的前提是满足正确可靠、简介清晰等质量因素

性能优化是综合评估,有时候时间效率和空间效率可能对立

针对Go语言特性,介绍Go相关的性能优化建议

Benchmark

性能表现需要实际数据衡量

Go语言提供了支持基础准性能测试的benchmark工具go test -bench=. -benchmem

Slice

slice预分配内存

  • 尽可能在使用make()初始化切片时提供容量信息
  • 可使用copy代替re-slice

Map

map预分配内存

字符串处理

使用strings.Builder

空结构体

使用空结构体节省内存 可以考虑用map代替set,只需要使用map的键

atomic包

锁是通过操作系统实现,属于系统调用

atomic操作是通过硬件实现,效率比锁高

sync.Mutex应该用来保护一段逻辑,不仅仅用于保护一个变量

性能调优实战

性能调优原则

要依靠数据而不是猜测

要定位最大瓶颈而不是细枝末节

不要过早优化

不要过度优化

性能分析工具pprof

pprof是用于可视化和分析性能分析数据的工具,可以知道应用在什么地方耗费了多少CPU、Memory

gtihub.com/wolfgre/go-… (项目提前埋入一些炸弹,产生可观测的性能问题)

性能调优案例