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

美女爱睡觉
168 阅读8分钟

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

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

高质量编程

简介

1.什么是高质量？

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

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

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

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

编码规范

1.注释

公共符号始终要注释

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

注释应该做的

  • 注释应该解释代码作用
  • 注释应该解释代码如何做的
  • 注释应该解释代码实现的原因
    -- 适合解释代码的外部因素
    -- 提供额外上下文
  • 注释应该解释代码什么情况会出错
    -- 适合解释代码的限制条件

小结

  • 代码是最好的注释
  • 注释应该提供代码未表达出的上下文信息
2.代码格式
  • gofmt（Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格）
  • goimports（也是Go语言官方提供的工具，实际上等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母序排序并分类）
3.命名规范

variable

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

举例：i和index的作用域范围仅限于for循环内部时index的额外冗长几乎没有增加对于程序的理解

// Bad
for index := 0; index < len(s); index++ {
    // do something
}

// Good
for i := 0; i < len(s); i++ {
    // do something
}

funtion

  • 函数名不携带包名上下文信息，因为包名和函数名总是成对出现的
  • 函数名尽量简短
  • 当包为foo的包的某个函数返回类型Foo时，可以省略类型信息而不导致歧义
  • 当包为foo的包的某个函数返回类型T时（T并不是Foo），可以在函数名中加入类型信息

package

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

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

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

小结

  • 核心目标是降低阅读理解代码的成本
  • 重点考虑上下文信息，设计简洁清晰的名称
4.控制流程

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

  • 如果两个分支中都包含return语句，则可以去除冗余的else
// Bad
if foo {
    return x
} else {
    return nil
}

// Good
if foo {
    return x
}
return nil

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

  • 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
// Bad
func OneFunc() error {
   err := doSomething()
   if err == nil {
      err := doAnotherThing()
      if err == nil {
         return nil
      }
      return err
   }
   return err
}

// Good
func OneFunc() error {
   if err := doSomething(); err != nil{
      return err
   }
   if err := doAnotherThing(); err != nil{
      return err
   }
   return nil
}

小结

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

简单错误

  • 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
  • 有限使用errors.New来创建匿名变量来直接表示简单错误
  • 如果有格式化的需求，使用fmt.Errorf
return errors.New("stopped after 10 redirects")

错误的Wrap和Unwrap

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

错误判断

  • 判断一个错误是否为特定错误，使用errors.Is
  • 不同于使用==，使用该方法可以判定错误链上的错误是否包含有特定的错误
if errors.Is(err, fs.ErrNotExist) {
    ...
}
  • 在错误链上获取特定种类的错误，使用errors.As
var pathError *fs.PathError
if errors.As(err, &pathError) {
    fmt.Println("Failed at path:", pathError.Path)
} else {
    fmt.Println(err)
}

panic

  • 不建议在业务代码中使用panic
  • 如果当前goroutine中所有deferred函数都不包含recover就会造成整个程序崩溃
  • 若问题可以被屏蔽或解决，建议使用error代替panic
  • 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic

recover

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

小结

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

性能优化建议

简介

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

Benchmark

如何使用

  • 性能表现需要实际数据衡量
  • Go语言提供了支持基准性能测试的benchmark工具
// from fib.go
func Fib(n int) int {
   if n < 2 {
      return n
   }
   return Fib(n-1) + Fib(n-2)
}

// from fib_test.go
func BenchmarkFib10(b *testing.B) {
   for n := 0; n < b.N; n++ {
      Fib(10)
   }
}

结果说明 image.png

slice 预分配内存

  • 在尽可能的情况下，在使用make()初始化切片时提供容量信息，特别是在追加切片时

image.png

原理

  • 切片本质是一个数组片段的描述
    -- 包括了数组的指针
    -- 片段的长度
    -- 片段的容量(不改变内存分配情况下的最大长度)
  • 切片操作并不复制切片指向的元素
  • 创建一个新的切片会复用原来切片的底层数组，因此切片操作是非常高效的
切片有三个属性，指针(ptr)、长度(len) 和容量(cap)。
append 时有两种场景：
    1. 当 append 之后的长度小于等于 cap，将会直接利用原底层数组剩余的空间
    2. 当 append 后的长度大于 cap 时，则会分配一块更大的区域来容纳新的底层数组
因此，为了避免内存发生拷贝，如果能够知道最终的切片的大小，预先设置 cap 的值能够获得最好的性能

image.png

另一个陷阱：大内存得不到释放

  • 在已有切片的基础上进行切片，不会创建新的底层数组。因为原来的底层数组没有发生变化，内存会一直占用，直到没有变量引用该数组
  • 因此很可能出现这么一种情况，原切片由大量的元素构成，但是我们在原切片的基础上切片，虽然只使用了很小一段，但底层数组在内存中仍然占据了大量空间，得不到释放
  • 推荐的做法，使用copy替代re-slice

image.png

Map 预分配内存

原理

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

image.png

字符串处理

常见的字符串拼接方式

  • + image.png
  • strings.Builder image.png
  • bytes.Buffer image.png

性能对比

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

原理

  • 字符串在Go语言中是不可变类型，占用内存大小是固定的，当使用+拼接 2 个字符串时，生成一个新的字符串，那么就需要开辟一段新的空间，新空间的大小是原来两个字符串的大小之和
  • strings.Builder，bytes.Buffer的内存是以倍数申请的
  • strings.Builder和bytes.Buffer底层都是[]byte数组，bytes.Buffer转化为字符串时重新申请了一块空间，存放生成的字符串变量，而strings.Builder直接将底层的[]byte转换成了字符串类型返回

进一步优化 - 预分配内存 image.png

使用空结构体节省内存

  • 空结构体struct{}实例不占据任何的内存空间
  • 可作为各场景下的占位符使用
    -- 节省资源
    -- 空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符

举例

  • 实现set使用map来代替
  • 对于这个场景，只需要用到map的键，而不需要值
  • 即使是将map的值设置为bool类型，也会多占据 1 个字节空间 image.png

使用 atomic 包

如何使用 atomic 包 image.png

原理

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

小结

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

性能优化分析工具

性能调优原则

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

性能分析工具 pprof

功能说明

  • pprof 是用于可视化和分析性能分析数据的工具
  • 可以知道应用在什么地方耗费了多少 CPU、memory 等运行指标

image.png

avatar
文章
阅读
粉丝