Go语言高质量编程与性能调优实战笔记 | 青训营笔记

咀才
125 阅读8分钟

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

概要：

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

一、高质量编程

1.1 高质量编程简介

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

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

编程原则

  • 简单性：消除”多余的复杂性“，编码逻辑简单清晰。（不理解的代码无法改进）
  • 可读性：编写可维护的代码的第一步是确保代码可读性（易于给人阅读）。
  • 生产力：团队整体工作效率非常重要。

1.2 编码规范

代码格式

推荐使用 gofmt 自动格式化代码，可自动格式化 Go 语言代码为官方统一风格。 goimports 亦可，相当于 gofmt 加上依赖包管理。

注释

  1. 解释代码作用
    • 适合注释公共符号
      • 公共符号：
        • 包中声明的每个公共符号：变量、常量、函数以及结构都需要添加注释。
        • 任何既不明显也不简短的公共功能必须予以注释。
        • 无论长度或复杂程度如何，对库中任何函数都必须进行注释。
        • 例外，不需要注释实现接口的方法。
  2. 解释代码如何做的
    • 适合注释实现过程
  3. 解释代码实现原因
    • 适合解释代码的外部因素
    • 提供额外上下文
  4. 解释代码什么情况会出错
    • 适合解释代码的限制条件

小结： 代码是最好的注释。注释应该提供代码为表达出的上下文内容。

命名规范

  • variable
    • 简洁
    • 缩略词全大写，但当位于变量开头且不需要导出时，使用全小写
    • 变量距离其被使用的地方越远，则需要携带越多的上下文信息，利于轻易辨认其含义
  • function
    • 函数名不携带包名的上下文信息（因为它们总是成队出现）
    • 函数名尽量简短
    • 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
    • 当名为 foo 的包某个函数返回类型 T 时（不为 Foo ）， 可以在函数名中加入类型信息
  • package
    • 只由小写字母组成。不包含大写字母和下划线等字符
    • 简短并包含一定的上下文。例如 schema、 task 等
    • 不要与标准库同名。例如不要使用 sync 或 strings
    • 以下规则尽量满足：
      • 不使用常用变量名作为包名。例如使用 bufio 而不是 buf
      • 使用单数而不是复数。例如使用 encoding 而不是 encodings
      • 谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短

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

控制流程

  • 避免嵌套，保持正常流程清晰
// Bad
if foo {
    return x;
} else {
    return nil;
}

// Good
if foo {
    return x
}
return nil;

若两个分支都有 return ，则删除冗余的 else 。

  • 尽量保持正常代码路径为最小缩进 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
   //Bad
   func OneFunc() error {
       err := doSomething()
       if err == nil {
           err := doAnotherThing()
           if err == nil {
               return nil  // normal case
           }
           return err
       }
       return err
   }

最常见的正常流程被嵌套在两个 if 条件内；

成功的退出条件是 return nil， 必须仔细匹配大括号来发现；

函数最后一行返回一个错误，需要追溯到匹配的左括号才能了解何时会出发错误；

如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套。

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

小结：

  • 线性原理，处理逻辑走直线，避免复杂嵌套分支；

  • 正常流程代码沿着屏幕向下移动；

  • 提高代码可维护性和可读性；

  • 故障问题大多出现在复杂的条件语句和循环语句中。

错误和异常处理

  • 简单错误
    • 简单错误指仅出现一次的错误，且在其他地方不需要捕获该错误
    • 优先使用 errors.New 来创建匿名变量来直接表示简单错误
    • 如果有格式化的需求，使用 fmt.Errorf
  • 错误的 Wrap 和 Unwrap
    • 错误的 Wrap 实际上是提供了一个 error 嵌套另一个 error 的能力，从而生成一个 eror 的跟踪链
    • 在 fmt.Errorf 中使用: %w 关键字来将一个错误关联至错误链中
   list, _, err := c.GetBytes(cache.Subkey(a.actionID, "srcfiles"))
   if err != nil {
       return fmt.Errorf("reading srcfiles list: %w", err)
   }
  • 错误判定
    • 判定一个错误是否为特定错误， 使用 errors.Is
    • 不同于使用 == ，使用该方法可以判定错误链上的所有错误是否含有特定的错误
    • 在错误链上获取特定种类的错误，使用 errors.As
    • panic
      • 不建议在业务代码中使用 panic ，调用函数不包括 recover 会造成程序崩溃
      • 若问题可以被屏蔽或解决，建议使用 error 替代 panic
      • 当程序启动阶段发生不可逆装的错误时，可以在 init 或 main 函数中使用 panic
    • recover
      • recover 只能在被 defer 的函数中使用
      • 嵌套无法生效
      • 只在当前 goroutine 生效
      • defer 的语句是后进先出
      • 如果需要更多的上下文信息，可以 recover 后在 log 中记录当前的调用栈 小结：
    • error 尽可能提供简明的上下文信息链，方便定位问题
    • panic 用于真正异常的情况
    • recover 生效范围，在当前 goroutine 的被 defer 的函数中生效

1.3 性能优化建议

Benchmark

性能测试工具

Slice

  • 预分配内存可以提高性能
    • 切片本指是一个数组片段的描述
      • 包含： 数组指针，长度，容量（不改变内存分配的情况下的最大程度）
    • 切片操作并不复制切片只想元素
    • 创建一个新的切片会复用原来切片的底层数组
      • 可能会导致大内存未释放
      • 在已有切片基础上创建切片，不会创建新的底层数组，原切片较大，代码在原切片基础上新建小切片，原底层数组在内存中有引用，得不到释放。
      • 可用 copy 代替 re-slice
      func GetLastBySlice(origin []int) []int {
    return origin[len(origin)-2:]
}

func GetLastBySlice(origin []int) []int {
    result := make([]int, 2)
    copy(result, origin[len(origin)-2:])
    return result
}

Map

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

字符串处理

  • 使用 + 拼接性能最差， strings.Builder, bytes.Buffer 相近， 前者更快
  • 分析：
    • 字符串在 Go 中是不可变类型，占用内存大小是固定的
    • 使用 + 每次都会重新分配内存
    • strings.Builder, bytes.Buffer 底层都是 []byte 数组
      • 内存扩容策略，以倍数申请，不需要每次拼接重新分配内存
    • bytes.Buffer 转化为字符串时重新申请了一块空间
    • strings.Builder 直接将底层的 []byte 数组转换成了字符串类型返回
    // To build strings more efficiently, see the strings.Builder type
func (b *Buffer) String() string {
    if b == nil {
        // Special case, useful in debugging.
        return "<nil>"
    }
    return string(b.buf[b.off:])
}

    // String returns the accumulated string
func (b *Builder) String() string {
    return *(*string)(unsafe.Pointer(&b.buf))
}

使用空结构体节省内存

  • 空结构体 struct{} 实例不占据任何内存空间
  • 可作为各种场景下的占位符使用
    • 节省资源
    • 空结构体本身具备很强的语义，即在此不需任何值，仅作为占位符
  • 实现 Set， 可考虑用 map 来代替
    • 只用 map 的键，而不需要值
    • 即使将 map 的值设置为 bool 类型，也会多占据1个字节空间

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

image.png

二、性能调优实战

2.1 性能调优简介

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

2.2 性能分析工具 pprof 实战

  • pprof 用于可视化和分析性能分析数据的工具

image.png

2.3 性能调优案例

  • 业务服务优化
    • 基本概念
      • 服务：能单独部署，承载一定功能的程序
    • 流程
      • 建立服务性能评估手段
      • 分析性能数据，定位性能瓶颈
      • 重点优化项改造
      • 优化效果验证
    • 服务性能评估手段
      • 服务性能评估方式
        • 单独 benchmark 无法满足复杂逻辑分析
        • 不同负载情况下性能表现差异
      • 请求流量构造
        • 不同请求参数覆盖逻辑不同
        • 线上真实流量情况
      • 压测范围
        • 单机器压测
        • 集群压测
      • 性能数据采集
        • 单机性能数据
        • 集群性能数据
  • 基础库优化
  • Go 语言优化
avatar
文章
阅读
粉丝