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

冲冲冲111
119 阅读5分钟

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

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

高质量编程与性能调优实战

高质量编程

简介

什么是高质量？

  1. 正确性：是否考虑各种边界条件，错误的调用是否能够处理
  2. 可靠性：异常情况或者错误的处理策略是否明确，依赖的服务出现异常是否能够处理
  3. 简洁：逻辑是否简单，后续调整功能或新增功能是否能够快速支持
  4. 清晰：其他人在阅读理解代码的时候是否能清楚明白，重构或者修改功能是否不会担心出现无法预料的问题

推荐使用 gofmt 自动格式化工具

goimports也是go语言官方提供的工具，实际等于 gofmt 加上依赖包的管理

编码规范

  1. 注释
    1. 注释代码作用、代码如何做的、代码实现的原因、代码什么情况下会出错
  2. 命名规范
    1. 变量名
      1. 简洁胜于冗长
      2. 缩略词全大写，当其位于变量开头且不需要导出时，使用全小写
      3. 变量距离其被使用的地方越远，则需要携带越多的上下文信息
    2. 函数名
      1. 函数名不携带包名的上下文信息
      2. 函数名尽量简短
    3. 包名
      1. 只由小写字母组成，不包含大写字母和下划线等符号
      2. 简短并包含一定的上下文先洗
      3. 不要和标准库同名
      4. 不使用常用变量名作为包名，使用单数，谨慎使用缩写
  3. 控制流程
    1. 避免嵌套，保持正常流程清晰
    2. 尽量保持正常代码路径为最小缩进
      1. 优先处理错误情况，特殊情况，尽早返回或继续循环来减少嵌套
  4. 错误和异常处理
    1. 简单错误
      1. 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
      2. 优先使用error.New 来创建匿名变量来直接表示简单错误
      3. 如果格式化的需要，使用fmt.Errorf
    2. 错误的 Wrap和Unwrap
    3. 错误判定
      1. 是否为特定错误，使用errors.ls
      2. 不同于使用 == 使用该方法可以判定错误链上的所有错误是否会有特定的错误
      3. 在错误链上获取特定种类的错误，使用errors.As
    4. panic用于真正异常的情况
    5. recover生效范围，在当前goroutine的被defer的函数中生效

性能优化建议

简介

  1. 性能优化的前提是满足正确可靠，简洁清晰等质量因素
  2. 性能优化是综合评估，有时候和时间效率、空间效率可能对立

Benchmark

  1. 性能表现需要实际数量衡量
  2. 基准性能测试公工具 benchmark
  3. 执行命令 go test -bench=. -benchmem
  4. 结果说明
    1. 第一项为测试函数名
    2. 第二项为一共执行的次数
    3. 第三项为每次执行的时间
    4. 第四项为每次执行申请多大的内存
    5. 第五项为每次执行申请几次的内存

Slice预分配内存

  1. 尽可能在使用mark()初始化切片时提供容量信息
  2. 切片本质是一个数组片段的描述、包括数组指针、片段的长度、片段的容量(不改变内存分配情况下的最大长度)
  3. 大内存未释放，使用copy代替re -slice

map预分配内存

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

使用strings.Builder

使用 + 拼接字符串性能较差

使用空结构体节省内存

空结构体不占据任何的内存空间，节省资源

atomic包

  1. 锁的实现是通过操作系统来实现的，属于系统调用
  2. atomic操作是通过硬件实现，效率比锁高
  3. 用来保护一段逻辑而不是一个变量
  4. 对于非数值操作，可以使用atomic.Value

性能调优实战

原则

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

工具pprof

简介

  1. 工具Tool
  2. 采样Sample
  3. 分析Profile
  4. 展示View

排查实战

  1. 浏览器查看指标
    1. 运行成功后浏览localhos:t6060/debug/pprof
  2. 分析 topN命令
    1. flat 当前函数本身的执行耗时
    2. flat% flat占cpu总时间的比例
    3. sum% 上面每一行的flat%总和
    4. cum 指当前函数本身加上其调用函数的总耗时
    5. cum% cum占cpu总时间的比例
      1. flat == cum 函数中没有调用其他函数
      2. flat == 0 函数中只有其他函数的调用
  3. 命令 list
    1. 根据指定的正则表达式查找代码行
  4. 命令web
    1. 调用关系可视化
  5. Heap - 堆内存
    1. 命令 go tool pprof -http=:8080
    2. https://localhost:6060/debug/pprof/heap
  6. goroutine协程
    1. 命令go tool pprof -hppt=:8080
    2. http://localhost:6060/debug/pprof/foroutine
  7. mutex锁
    1. 命令go tool pprof -hppt=:8080
    2. http://localhost:6060/debug/pprof/mutex
  8. block阻塞
    1. 命令go tool pprof -hppt=:8080
    2. http://localhost:6060/debug/pprof/block
avatar
文章
阅读
粉丝