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

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

1.高质量代码

1.1 高质量编程简介

1.1.1 什么是高质量？

编写的代码能够打到正确可靠、简介清晰的目标

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

1.1.2 编程原则

简单性

• 消除"多余的复杂性"，以简单清晰的逻辑编写代码
• 不理解的代码无法修复改进

可读性

• 代码是写给人看的，而不是机器
• 编写可维护代码的第一步是确保代码可读

生产力

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

1.2 编码规范

1.2.1 如何编写高质量的 Go 代码

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

1.2.1 编码规范 - 注释

注释应该做的

• 解释代码作用

  • 适合注释公共符号

• 解释代码如何做的

  • 适合注释实现过程

• 解释代码实现的原因

  • 适合解释代码的外部因素

  • 提供额外上下文

• 解释代码什么情况会出错

  • 适合解释代码的限制条件

• 公共符号始终要注释

  • 包中声明的每个公共的符号： 变量、常量、函数以及结构都需要添加注释

  • 任何既不明显也不简短的公共功能必须予以注释

  • 无论长度或复杂程度如何，对库中的任何函数都必须进行注释

  • 不需要注释实现接口的方法

1.2.2 编码规范 - 命名规范

variable(变量)

• 简洁胜于冗长

• 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写

• 变量距离其被使用的地方越远，则需要携带越多的上下文信息

  • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

function(函数)

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

package(包)

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

1.2.3 编码规范 - 控制流程

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

如果两个分支中都包含 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 // normal case
          }
          return err
      }
      return err
  }
  

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

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

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

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

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

1.2.4 编程规范 - 错误和异常处理

简单错误

• 简单的错误是指仅出现一次的错误，且在其他地方不需要捕获该错误
• 优先使用 errors.New 来创建匿名变量来直接表示简单错误
• 如果有格式化的需求，使用 fmt.Errof

错误的 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 的语句是后进先出

  • defer 语句会在函数返回前调用

  • 多个 defer 语句是后进先出

    func main() {
        if true {
            defer fmt.Printf("1")
        } else {
            defer fmt.Printf("2")
        }
        defer fmt.Printf("3")
    }
    // 最终输出：31
    

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

小结：

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

1.3 性能优化建议

简介

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

1.3.1 性能优化建议 - benchmark

如何使用

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

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

  go test -bench=. -benchmen

1.3.2 性能优化建议 - Slice(切片)

slice 预分配内存

1.3.3 性能优化建议 - Map

map 预分配内存

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

1.3.4 性能优化建议 - 字符串处理

使用 strings.Builder

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

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

为什么 stringbuilder 会比 bytebuffer 更快一些，可以看看实际的代码

1.3.5 性能优化建议 - 空结构体

使用空结构体省内存

• 空结构体 struct{} 实例不占据任何的内存空间

• 可作为各种场景下的占位符使用

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

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

• 对于这个场景，只需要用到 map 的键，而不需要值

• 即使是将 map 的值设置为 bool 类型，也会多占据1个字节空间

1.3.6 性能优化建议 - atomic 包

如何使用 atomic 包

使用 atomic 包

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

小结

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