高质量编程与性能调优实战 ｜ 青训营笔记

放羊孩
80 阅读6分钟

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

01 高质量编程

1.1简介

什么是高质量

  • 编写的代码能够达到正确可靠、简洁清晰、无性能隐患的目标就能称之为高质量代码
  • 实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的
  • 高质量的编程需要注意以下原则：简单性、可读性、生产力

1.2 编码规范

1.2.1 代码格式

推荐使用gofmt自动格式化代码，保证所有的 Go 代码与官方推荐格式保持一致

提升可读性，风格一致的代码更容易维护、需要更少的学习成本、团队合作成本，同时可以降低 Review 成本

1.2.2 注释

  • 注释应该解释代码作用
  • 注释应该解释代码如何做的
  • 注释应该解释代码实现的原因
  • 注释应该解释代码什么情况会出错
  • 公共符号始终要注释

代码是最好的注释

注释应该提供代码未表达出的上下文信息

1.2.3 命名规范

  • variable

    • 简洁胜于冗长

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

      • 例如使用ServeHTTP而不是ServeHttp
      • 使用XMLHTTPRequest或者xmlHTTPRequest

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

      • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
  • 作用范围仅限于循环内部，用i而不是index，index的额外冗长不会增加理解
  • deadline替换成t降低了变量名的信息量

  • function

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

  • package

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

1.2.4 控制流程

  • 避免嵌套，保持正常流程清晰
  • 如果两个分支中都包含 return 语句，则可以去除冗余的 else
  • 尽量保持正常代码路径为最小缩进，优先处理错误情况/特殊情况，并尽早返回或继续循环来减少嵌套，增加可读性

1.2.5 错误和异常处理

  • 简单错误

    • 优先使用 errors.New 来创建匿名变量来直接表示该错误。有格式化需求时使用 fmt.Errorf

  • 错误的 Wrap 和 Unwrap

    • 在 fmt.Errorf 中使用 %w 关键字来将一个错误 wrap 至其错误链中

  • 错误判定

    • 使用 errors.Is 可以判定错误链上的所有错误是否含有特定的错误。

      • 不同于使用 ==，使用该方法可以判定错误链上的所有错误是否含有特定的错误。

    • 在错误链上获取特定种类的错误，使用 errors.As

  • panic

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

  • recover

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

panic 用于真正异常的情况

error 尽可能提供简明的上下文信息，方便定位问题

recover 生效范围，在当前 goroutine 的被 defer 的函数中生效

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

defer语句是后进先出

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

1.3 性能优化建议

Benchmark

通过命令运行benchmark可以得到测试结果

go test -bench=. -benchmen

image-20220511223100135

slice

slice预分配内存

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

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

map预分配内存

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

使用string.Builder

strings.Builder 最快，bytes.Buffer 较快，+ 最慢

使用空结构体节省内存

  • 空结构体不占据内存空间，可作为占位符使用

  • 比如实现简单的 Set

    • Go 语言标准库没有提供 Set 的实现，通常使用 map 来代替。对于集合场景，只需要用到 map 的键而不需要值

使用 atomic 包

  • 锁的实现是通过操作系统来实现，属于系统调用，atomic 操作是通过硬件实现的，效率比锁高很多
  • sync.Mutex 应该用来保护一段逻辑，不仅仅用于保护一个变量
  • 对于非数值系列，可以使用 atomic.Value，atomic.Value 能承载一个 interface{}
  • 避免常见的性能陷阱可以保证大部分程序的性能
  • 针对普通应用代码，不要一味地追求程序的性能，应当在满足正确可靠、简洁清晰等质量要求的前提下提高程序性能

02 性能调优实战

image-20220512120507911

pprof 实践

  • 使用top命令，可以看到占用cpu资源较多的调用

    image-20220512132652284

*参考资料:【Go 语言原理与实践学习资料（上）】第三届字节跳动青训营-后端专场 - 掘金 (juejin.cn)

avatar
文章
阅读
粉丝