Go高质量编程与性能优化建议| 青训营笔记

67 阅读6分钟

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

本节课学习内容

高质量编程和性能调优

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

高质量编程

简介

何为高质量?

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

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

编程原则

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

  • 简单性:消除”多余的复杂性”,以简单清晰的逻辑编写代码。不理解的代码无法修复改进
  • 可读性:代码是写给人看的,而不是机器编写可维护代码的第一步是确保代码可读
  • 生产力:团队整体工作效率非常重要

编码规范

代码格式

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

注释

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

命名规范

  • 简洁胜于冗长
  • 缩略词全大写,但当其位于变量开头且不需要导出时,使用全小写
  • 变量距离其被使用的地方越远你,则需要携带越多的上下文信息

核心目标是降低阅读理解代码的成本,重点考虑上下文信息,设计简洁清晰的名称

控制流程

  • 避免嵌套,保持正常流程清晰
  • 尽量保持正常代码路径为最小缩进
  • 提升代码可维护性和可读性
  • 故障大都出现于复杂的条件语句和循环语句

错误和异常处理

简单错误

优先使用errors.New来创建匿名变量来表示简单错误

如果有格式化的需求,使用fmt.Errorf

错误的Wrap和Unwrap

  • 错误的Wrap 实际上是提供了一个error嵌套另一个error 的能力,从而生成一个error的跟踪链
  • 在fmt.Errorf 中使用: %w 关键字来将一个错误关联至错误链中

错误判定

  • 判定一个错误是否为特定错误,使用errors.Is,不同于使用==,该方法可以错误链上的所有错误是否含有特定的错误
  • 在错误脸上获取特定种类的错误,使用errors.As

panic

不建议在业务代码中使用panic。因为panic发生后,会向上传播至调用栈顶,如果当前goroutine中所有defered函数都不包含recover就会造成整个程序崩溃。若问题可以被屏蔽或解决,建议使用error代替panic。特殊地,当程序启动阶段发生不可逆转的错误时,可以在init或main函数中使用panic。因为在这种情况下,服务启动起来也不会有意义比如示例是启动消息队列监听器的逻辑,在创建消费组失败的时候会Panicf,实际打印日志,然后抛出panic

recover

有painc,自然就会提到recover,因为我们并不能控制所有的代码,避免不了引入其他库,如果是引入库的bug导致panic,影响到我自身的逻辑就会使用recover。

  • recover只能在被defer的函数中使用嵌套无法生效
  • 只在当前goroutine生效
  • defer的语句是后进先出
  • 如果需要更多的上下文信息,可以recover后在 log 中记录当前的调用栈

小结

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

性能优化建议

Benchmark

Go自带了性能评估工具——Benchmark。以计算斐波拉契数列的函数为例,分两个文件,,fib.go编写函数代码,fb_test.go编写benchmark的逻辑,通过命令go test -bench=. -benchmem运行benchmark可以得到测试结果-benchmem表示也统计内存信息

image.png

Slice

第一条建议是预分配,尽可能在使用make()初始化切片时提供容量信息,特别是在追加切片时对比看下两种情况的性能表现,左边是没有提供初始化容量信息,右边是设置了容量大小。结果中可以看出执行时间相差很多,右边大约为左边的三分之一。

image.png

第二个建议是使用copy代替re-slice。在slice的使用中,很可能出现这么一种情况,原切片由大量的元素构成,但是我们在原切片的基础上切片,虽然只使用了很小一段,但底层数组在内存中仍然占据了大量空间,得不到释放。

image.png

结果差异常明显, lastBySlice耗费了100.14MB内存,也就是说,申请的100个1MB大小的内存没有被回收。因为切片虽然只使用了最后2个元素,但是因为与原来1M的切片引用了相同的底层数组,底层数组得不到释放,因此最终100MB的内存始终得不到释放。而lastByCopy 仅消耗了3.14MB的内存。这是因为,通过copy,指向了一个新的底层数组,当origin不再被引用后,内存会被垃圾回收

Map

Map内存预分配

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

字符串处理

使用Strings.builder,使用+拼接性能最差,strings.Builder,bytes.Buffer相近,strings.Buffer更快

  • 字符串在Go语言中是不可变类型,占用内存大小是固定的
  • 使用+每次都会重新分配内存
  • strings.Builder,bytes.Buffer底层都是[]byte 数组
  • 内存扩容策略,不需要每次拼接重新分配内存

空结构体

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

  • 节省资源
  • 空结构体本身具备很强的语义,即这里不需要任何值,仅作为占位符

atomic包

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

总结

这节课主要学习了高质量编程,对编码规范和代码格式以及一些错误的处理有了更深入的认识,对于提升代码效率有很大的帮助。同时这节也总结了性能优化的一部分知识,为后续性能调优的实战和项目做了铺垫。