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

用户5484045548199
44 阅读5分钟

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

高质量编程

注释

  1. 注释应该解释代码作用 ： 适当注释公共说明符
  2. 注释应该解释代码如何做的 ： 适当注释实现过程
  3. 注释应该解释代码实现的原因：适当注释代码外部因素，提供外上下文
  4. 注释应该解释代码什么情况会出错：适当解释代码的限制条件

公共符号始终要注释：

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

命名规范

  1. variable
  • 简洁胜于冗长
  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写：
    • 例如使用 ServeHTTP 而不是 ServeHttp
    • 使用 XMLHTTPRequest 或者 xmIHTTPRequest变量距离其被使用的地方越远，则需要携带越多的上下文信息
  • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
  1. function
  • 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
  • 函数名尽量简短
  • 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
  • 当名为 foo 的包某个函数返回类型 T 时 (T 并不是 Foo) ，可以在函数名中加入类型信息
  1. package
  • 只由小写字母组成。不包含大写字母和下划线等字符
  • 简短并包含一定的上下文信息。例如 schema、task 等
  • 不要与标准库同名。例如不要使用 sync 或者 strings

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

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

控制流程

  1. 避免嵌套，保持正常流程清晰
  2. 尽量保持正常代码路径为最小缩进：优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
  • 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
  • 正常流程代码沿着屏幕向下移动
  • 提升代码可维护性和可读性故
  • 障问题大多出现在复杂的条件语句和循环语句中

错误和异常处理

  1. 简单错误

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

  2. 错误的 Wrap 和 Unwrap

    Go1.13在errors 中新增了三个新API和一个新的format关键字，分别是errors.Is、errors.As、errors.Unwrap 以及 fmt.Errorf 的%w。

    • 错误的 Wrap 实际上是提供了一个 error 嵌套另一个error 的能力，从而生成一个 error 的跟踪链，同时结合错误的判定方法来确认调用链中是否有关注的错误出现。这个能力的好处是每一层调用方可以补充自己对应的上下文，方便跟踪排查问题，确定问题的根本原因在哪里
    • 在 fmt.Errorf 中使用: %w 关键字来将一个错误关联至错误链中
    • 错误判定：判定一个错误是否为特定错误，使用 errors.Is：不同于使用 ==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
    • 在错误链上获取特定种类的错误，使用errors.As

  3. panic

    在Go中，比错误更严重的就是panic，它的出现表示程序无法正常工作了

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

  4. recover

    • recover 只能在被 defer 的函数中使用
    • 嵌套无法生效
    • 只在当前 goroutine 生效
    • defer 的语句是后进先出

性能优化指南

  1. benchmark

go test -bench=. -benchmem

  1. slice 预分配内存：尽可能使用 make() 初始化切片时提供容量信息

    • 切片本质是一个数组片段的描述

      • 包括数组指针
      • 片段的长度
      • 片段的容量(不改变内存分配情况下的最大长度）

    • 切片操作并不复制切片指向的元素

    • 创建一个新的切片会复用原来切片的底层数组

    • 另一个陷阱:大内存未释放

      • 在已有切片基础上创建切片，不会创建新的底层数组
      • 场景：
        • 原切片较大，代码在原切片基础上新建小切片
        • 原底层数组在内存中有引用，得不到释放可使用 copy 替代 re-slice
func GetLastBySlice(origin []int) []int{
    return origin[len(origin)-2:]
}
//而是
func GetLastByCopy(origin []int) []int{
    result := make([]int,2)
    copy(result, origin[len(origin)-2:])
    return result
}

  1. map 预分配内存

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

  2. 字符串优化：使用 strings.Builder拼接字符串

    • 使用 + 拼接性能最差，strings.Builder，bytes.Buffer 相近，strings.Bulider 更快
    • 原因
      • 字符串在 Go 语言中是不可变类型，占用内存大小是固定的
      • 使用 + 每次都会重新分配内存
      • strings.Builder，bytes.Buffer 底层都是 []byte数组
      • 内存扩容策略，不需要每次拼接重新分配内存
func StrBuilder(n int, str string) string {
	var builder strings.Builder
	for i := 0; i < n; i++ {
		builder.WriteString(str)
	}
	return builder.String()
}

  1. 使用空结构体节省内存

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

  2. 如何使用atomic包

    在工作中迟早会遇到多线程编程的场景，比如实现一个多线程共用的计数器，如何保证计数准确，线程安全，有不同的方式

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

性能调优 pprof

pprof项目

avatar
文章
阅读
粉丝