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

用户7259818143821
60 阅读5分钟

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

高质量编程

原则

  • 简单性
    • 消除“多余的复杂性”，以简单清晰的逻辑编写代码
  • 可读性
    • 可读性很重要，因为代码是写给人看的，而不是机器
    • 编写可维护代码的第一步是确保代码可读
  • 生产力

编码规范

代码格式

  • 使用gofmt自动格式化代码
  • 可以考虑goimports，会对依赖包进行管理，自动增删依赖的包引用，按字母序排序分类

注释

  • 注释应该做的
    • 注释应该解释代码作用
    • 注释应该解释代码如何做的
    • 注释应该解释代码实现的原因
      • 适合解释代码的外部因素提供
      • 额外上下文
    • 注释应该解释代码什么情况会出错
      • 适合解释代码的限制条件

image.png

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

image.png

  • 有一个例外，不需要注释实现接口的方法。

命名规范

变量命名

  • 简洁胜于冗长
  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写s
    • 例如使用ServeHTTP而不是ServeHttp
    • 使用XMLHTTPRequest或者xmlHTTPRequest
  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
    • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

函数命名

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

包命名

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

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

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

编码规范

  • 避免嵌套，保持正常流程清晰
  • 尽量保持正常代码路径为最小缩进
    • 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套

错误和异常处理

  • 简单错误
    • 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
    • 优先使用errors.New来创建匿名变量来直接表示简单错误
    • 如果有格式化的需求，使用fmt.Errorf
  • Wrap
    • ·错误的Wrap 实际上是提供了一个error嵌套另一个error的能力，从而生成一个 error 的跟踪链
    • 在fmt.Errorf中使用:%w关键字来将一个错误关联至错误链中
  • 错误判定
    • 判定一个错误是否为特定错误，使用errors.ls
    • 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
    • 在错误链上获取特定种类的错误，使用errors.As
  • panic
    • 不建议在业务代码中使用panic
    • 调用函数不包含recover会造成程序崩溃·若问题可以被屏蔽或解决，建议使用error代替panic * 当程序启动阶段发生不可逆转的错误时，可以在init或 main函数中使用panic
  • recover
    • recover只任被defer的函数中使用
    • 嵌套无法生效
    • 只在当前goroutine生效
    • defer的语句是后进先出

image.png

性能优化

Benchmark

  • 命令 image.png

image.png

建议

slice

  • 尽可能在使用make()初始化切片时提供容量信息
  • 大内存未释放
    • 在已有切片基础上创建切片，不会创建新的底层数组
    • 场景原切片较大，代码在原切片基础上新建小切片·原底层数组在内存中有引用，得不到释放
    • 可使用copy替代re-slice

image.png

map

  • 预分配内存make()初始化

字符串

  • 需要进行拼接时，使用strings.Builder

image.png

空结构体

  • 空结构体不占用任何内存

image.png

atomic包

image.png

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

原则

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

pprof性能分析工具

  • 运行程序后，打开http://localhost:6060/debug/pprof/
  • 使用go tool pprof +采样链接来启动采样。

image.png

image.png

信息

  • allocs:内存分配情况
  • blocks:阻塞操作情况
  • cmdline:程序启动命令
  • goroutine:当前所有
  • goroutine的堆栈信息
  • heap:堆上内存使用情况(同alloc)
  • mutex:锁竞争操作情况
  • profile: CPU占用情况|
  • threadcreate:当前所有创建的系统线程的堆栈信息
  • trace:程序运行跟踪信息

CPU

  • topN查看占用资源最多的函数

image.png image.png image.png

  • list查看代码行

image.png

  • web查看调用关系（可视化）

image.png

堆内存

go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/heap" image.png image.png

goroutine

  • goroutine泄露也会导致内存泄露
  • go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/goroutine" image.png

image.png

mutex

go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/mutex"

block

go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/block"

业务服务优化

image.png

定位瓶颈，保证准确性

  • 使用库不规范
  • 高并发场景优化不足
  • 优化效果验证
avatar
文章
阅读
粉丝