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

用户5495380108803
139 阅读6分钟

高质量编程

简介:

高质量代码：编写的代码能够达到正确可靠、简介清晰的目标

包括：

  • 各种边界条件是否考虑完备
  • 异常情况处理，稳定性保证
  • 易读易维护

编程原则：

1、简单性

  • 消除多余的复杂性，以简单清晰的逻辑编写代码
  • 不理解的代码无法修复改进

2、可读性

  • 代码让人能读懂
  • 编写可维护代码的第一步是确保代码可读

3、生产力

  • 团队整体工作效率非常重要

编程规范：

  • 代码格式

    推荐使用 gofmt 自动格式化代码

  • 注释

    注释应该做的：

    • 注释应该解释代码作用

    • 注释应该解释代码如何做的及其实现的原因

    • 注释应该解释代码什么情况会出错

    公共符号始终要注释

    包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释

  • 命名规范

    变量：

    • 简洁胜于冗长

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

      • 例如 使用 ServeHTTP而不是ServeHttp
      • 使用 XMLHTTPRequest 或者 xmlHTTPRequest
      • 变量距离其被使用的地方越远，则需要携带越多的上下文信息

    函数：

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

    包：

    • 只由小写字母组成。
    • 简短并包含一定的上下文信息。例如 schema、task等
    • 不要与标准库同名。

  • 控制流程

    • 避免嵌套，保持正常流程清晰
    • 尽量保持正常代码路径为最小缩进

  • 错误和异常处理

    简单错误

    • 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
    • 优先使用 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

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

性能优化建议

针对 Go语言特性，介绍 Go 相关的性能优化建议。

Benchmark

Go 语言提供了支持基准性能测试的 benchmark工具。

go test -bench=. -benchmem

Slice预分配内存

  • 尽可能在使用 make()初始化切片时提供容量信息
  • 切片本质是一个数组片段的描述（包括：数组指针、片段的长度、片段的容量）。切片操作并不复制切片指向的元素。创建一个新的切片会复用原来切片的底层数组

Map预分配内存

分析

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

使用string.Builder

常见的字符串拼接方式

  • 使用 + 拼接性能最差，strings.Builder, bytes.Buffer 相近，strings.Buffer 更快。
  • 使用 + 每次都会重新分配内存。strings.Builder, bytes.Buffer 底层都是 []byte数组，采用内存扩容策略，不需要每次拼接重新分配内存。

空结构体

使用空结构体节省内存

  • 空结构体 strict{} 实例不占据任何的内存空间

  • 可作为各种场景下的占位符使用

    • 节省资源
    • 空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符

atomic包

使用 atomic包

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

性能调优实战

性能调优原则

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

性能分析工具 pprof

pprof是用于可视化和分析性能分析数据的工具

CPU命令：

1、topN：查看占用资源最多的函数

2、list：根据指定的正则表达式查找代码行

3、web：调用关系可视化

Heap-堆内存

1、Top视图

2、Source试图

goroutine-协程

mutex-锁

block-阻塞

...

性能调优案例

1、业务服务优化流程

  • 建立服务性能评估手段

    • 服务性能评估方式：单独benchmark 无法满足复杂逻辑分析；不同负载情况下性能表现差异
    • 请求流量构造：不同请求参数覆盖逻辑不同；线上真实流量情况
    • 压测范围：单机器压测、集群压测
    • 性能数据采集：单机性能数据、集群性能数据

  • 分析性能数据，定位性能瓶颈

    • 使用库不规范
    • 高并发场景优化不足

  • 重点优化项改造

    • 正确性是基础
    • 相应数据diff：线上请求数据录制回放、新旧逻辑接口数据diff

  • 优化效果验证

    • 重复压测验证
    • 上线评估优化效果：关注服务监控、逐步放量、收集性能数据

  • 进一步优化，服务整体链路分析

    • 规范上游服务调用接口，明确场景需求
    • 分析链路，通过业务流程优化提升服务性能

2、基础库优化

  • AB 实验 SDK 的优化

    • 分析基础库核心逻辑和性能瓶颈
    • 内部压测验证
    • 推广业务服务落地验证

3、Go语言优化

  • 编译器&运行时优化

    • 优化内存分配策略
    • 优化代码编译流程，生成更高效的程序
    • 内部压测验证
    • 推广业务服务落地验证
avatar
文章
阅读
粉丝