后端day3-高质量编程与性能调优 ｜ 青训营笔记

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

一、本堂课重点内容

本节课程主要分为四个方面：

1. Go 语言编码规范
2. Go 语言性能优化建议
3. 性能分析工具 pprof 的使用
4. 性能调优实际案例

这篇文章主要介绍前两个方面，即编码规范和性能调优。

二、详细知识点介绍

1. 高质量编程

• 高质量代码：正确可靠、简洁清晰、无性能隐患。

  • 边界条件考虑完备。
  • 异常情况处理、稳定性保证。
  • 易读、易维护。

• 编程原则

  • 简单性：以简单清晰的逻辑编写代码。
  • 可读性：方便他人阅读。
  • 生产力：提高团队的整体工作效率。

2. 编码规范

• 代码格式

  • 使用gofmt自动格式化代码。

  • 使用goimports，即gofmt加上依赖包管理。

• 注释

  • 包中声明的每个公共符号（变量、常量、结构、函数）都需要添加注释，用来解释代码的作用。

  • 注释应该解释代码如何做的、为什么要这么做，即对代码中相对复杂的逻辑进行解释。

  • 注释应该解释代码什么情况会出错，即调用代码的限制条件。

• 命名规范

  • 简洁胜于冗长。

  • 缩略词全大写（eg. HTTP），但当其位于变量开头并且不需要暴露时，可以使用全小写（eg. xmlHTTPRequest）。

  • 变量距离其被使用的地方越远（尤其是全局变量），则需要携带越多的上下文信息。

  • 函数名不需要携带包名的信息，因为包名和函数名总是成对出现的。

  • 包名只由小写字母组成，不包含大写字母和下划线，尽量使用单数，不使用常用变量名作为包名。

• 控制流程

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

    • eg. 如果两个分支中都包含return语句，就可以去除冗余的else。

  • 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套。

  • 线性原理，处理逻辑尽量走直线，避免复杂的逻辑分支。

• 错误和异常处理

  • 简单错误

    • 优先使用errors.New来创建匿名变量来直接表示简单错误。
    • 如果有格式化的需求，使用fmt.Errorf。

  • 错误的wrap和unwrap

    • 错误的wrap即提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链。
    • 在fmt.Errorf中使用%w来将一个错误关联至错误链中。

  • 错误判定

    • 判定一个错误是否为特定错误，使用errors.Is，这种方法可以判定错误链上是否含有特定的错误。
    • 在错误链上获取特定种类的错误，使用errors.As。

  • panic

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

  • recover

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

3. 性能优化

• Benchmark

  • 性能表现需要实际数据衡量，Go语言提供了支持基准性能测试的benchmark工具。

  • 命令：go test -bench=. -benchmem

  • 结果说明

    

• slice

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

  • 陷阱：大内存未释放

    • 在已有切片基础上创建切片，不会创建新的底层数组，原底层数组在内存中有引用，得不到释放。
    • 解决方案：用copy替代直接使用:进行的切片。

• map

  • 预分配内存：尽可能在使用make()初始化map时提供容量信息。

• 字符串拼接

  • 使用+性能最差，strings.Builder、bytes.Buffer性能相近，strings.Builder更快。

  • 原因：使用+每次都会重新分配内存。

  • 更进一步可以预分配内存，使用.Grow函数。

• 空结构体

  • 空结构体struct{}实例不占据任何内存空间，可作为各种场景下的占位符使用。

  • 可以使用空结构体节省内存，用map+空结构体的方式实现set。

• atomic包：效率比直接加锁高。