go高质量编程 | 青训营笔记

用户2021225122106
87 阅读8分钟

这是我参与「第五届青训营」伴学笔记创作活动的第4天。今天复习了go的高质量编程相关内容，并将一些值得注意的点记录了下来。

什么是高质量

  • 编写的代码能够达到正确可靠、简洁清晰、无性能隐患的目标就能称之为高质量代码
  • 实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的
  • 高质量的编程需要注意以下原则：简单性、可读性、生产力
  • 边界条件考虑完备、异常情况处理保证稳定性、代码易读易维护

编程原则

  • 简单性：以简单清晰的逻辑编写代码
  • 可读性：代码是写给人看的，而不是机器。编写可维护代码的第一步是确保代码可读
  • 生产力：团队整体工作效率非常重要

编码规范 - 如何编写高质量的go代码

代码格式

  • gofmt:自动化代码格式从而统一风格
  • goimports:自动增删依赖包的引用、将依赖包按字母排序并分类

注释

  • 注释应该做的
    • 解释代码作用
      • 适合注释公共符号
    • 解释代码如何做的
      • 通过注释来实现过程
    • 解释代码实现的原因
      • 提供额外上下文，适合解释代码的外部因素
    • 解释代码什么情况下会出错
      • 适合解释代码的限制条件
  • 公共符号始终要注释
    • 包中声明的每个公共符号：变量、常量、函数以及结构都需要添加注释
    • 任何既不明显也不简短的公共功能必须予以注释
    • 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
    • 不需要给实现接口的方法注释。

命名规范

变量

  • 简洁
    • 仅作用于for内部时, i 比 index更好
  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
    • ×：ServeHttp √:ServeHTTP
    • √: XMLHTTPRequest or xmlHTTPRequest
  • 变量距离其被使用的地方越远，组需要携带更多的上下文信息
    • 全局变量在其名字中需要更多的上下文信息

函数

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

包

  • 包名只由小写字母组成，不含大写字母和下划线等字符
  • 简短并包含一定的上下文信息
  • 不要与标准库同名
  • 尽量不使用常用变量名作为包名
  • 尽量使用单数而不是复数
  • 谨慎使用缩写

控制流程

  • 避免嵌套，保证正常流程清晰，例如如果两个分支都含return，去除else
  • 尽量保持正常代码路径为最小缩进
    • 优先处理错误/特殊情况，尽早返回或继续循环来减少嵌套，新增校验时比较方便
  • 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支。故障问题大多出现在复杂的条件语句和循环语句中。

错误和异常处理

简单错误

  • 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
  • 优先使用 erros.New(wrong_msg) 来创建匿名变量直接表示
  • 如果有格式化的需求，使用 fmt.Errorf 
        func defaultCheckRedirect(req *Request, via []*Request) error {
        if len(via) >= 10 {
            return errors.New("stopped after 10 redirects")
        }
        return nil
    }

错误的包装和解包

  • 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
  • 在fmt.Errorf中使用%w关键字来将一个错误关联至错误链中 
        fmt.Errorf("%w", err)
  • 判定一个错误是否为特定错误，使用errors.Is，不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
  • 在错误链上获取特定种类的错误，使用errors.As
  • 不建议在业务代码中使用panic，如果调用函数不包含recover会造成程序崩溃。当程序启动阶段发生不可逆转的错误时，可以使用panic来终止
  • recover只能在被defer的函数中使用，嵌套无法生效，同时只在当前goroutine生效

性能优化建议

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

Benchmark

    go test -bench=. -benchmem
  • 测试函数名-GOMAXPROCS值 * 执行次数(b.N) * 每次执行时间 * 每次执行申请多大内存 * 每次执行申请几次内存

Slice

  • 尽可能在使用make()初始化切片时提供容量信息
  • 切片本质是一个数组片段的描述，切片操作并不复制切片指向的元素，创建一个新的切片会复用原来切片的底层数组
  • 使用copy代替re-slice，防止原来切片较大而未释放的问题

map

  • 使用make预分配内存
  • 提前分配好空间可以减少内存拷贝和rehash消耗

字符串处理

  • 拼接字符串时，使用 + 拼接性能最差，strings.Bulider和bytes.Buffer相近，但是strings.Builder更快。原因是bytes.Buffer转化为字符串时重新申请了一块空间，而strings.Builder直接将底层的[]byte转换成了字符串类型返回。
  • 字符串在go中时不可变类型，占用内存大小固定，使用+每次都会重新分配内存。而其他两者底层都是[]byte数组，具备内存扩容策略，不需要每次拼接都重新分配内存

使用空结构体来节省内存

  • 空结构体struct{}实例不占据任何的内存空间
  • 可作为各种场景下的占位符使用：例如，可以通过map实现set

atomic包

  • 维护原子变量，进行原子操作，避免频繁加锁解锁
  • atomic操作通过硬件实现，效率比较高，而锁的实现是通过操作系统来实现，属于系统调用
  • sync.Mutex应该用来保护一段逻辑，而不仅仅用于保护一个变量

小结

  • 避免常见的性能陷阱可以保证大部分程序的性能
  • 普通的应用代码不应该一味的追求程序的性能
  • 越高级的性能优化手段越容易出现问题
  • 在满足正确可靠、简洁清晰的质量要求的前提下提高程序的性能

性能调优实战

性能调优原则

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

性能分析工具pprof

pprof功能简介

  • 工具、采样、展示、分析
  • 使用top查看占用资源最多的函数 image.png
    • flat:当前函数本身的执行耗时
    • flat%：flat占CPU总时间的比例
    • sum%：每一行flat的总和
    • cum：当前函数本身加上其调用函数的总耗时
    • cum%：cum占CPU总时间的比例
    • flat == cum : 函数中没有调用其他函数
    • flat == 0 ： 函数中只有其他函数的调用
  • 使用list获取有问题的代码行 image.png
  • 使用web命令来生成调用关系图
  • 查看heap堆内存
    go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/heap"

image.png

  • 指标说明
    • alloc_objects : 程序累计申请的对象数
    • alloc_space : 程序累计申请的内存大小
    • inuse_objects : 程序当前持有的对象呢数
    • inuse_space : 程序当前占用的内存大小
  • 查看协程问题
    go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/goroutine"
  • 火焰图
    • 由上到下表示调用顺序
    • 每一块代表一个函数，越长代表占用CPU的时间更长
    • 火焰图是动态的，支持点击块进行分析
  • 查看锁问题
    go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/mutex"
  • 查看阻塞问题
    go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/block"

性能分析工具pprof

采样过程和原理

  • cpu
    • 采样对象：函数调用和它们占用的时间
    • 采样率：100次/秒
    • 采样时间：从手动启动到手动结束
    • 执行过程
      • 进程启动定时器后，OS每10ms向进程发送一次SIGPROF信号，进程每次收到此信号会记录调用堆栈。每100ms读取已经记录的调用栈并写入输出流
  • 堆内存
    • 采样程序通过内存分配器在堆上分配和释放的内存，记录分配/释放的大小和数量
    • 采样率：每分配512k记录一次，可在运行开头修改
    • 采样时间：从程序运行开始到采样时
    • 采样指标：alloc_space,alloc_objects,inuse_space,inuse_objects
  • goroutine & ThreadCreate
    • gouroutine : 记录所有用户发起且在运行中的gouroutine（入口非runtime开头的）
    • ThreadCreate : 记录程序创建的所有系统线程的信息
  • Block & Mutex
    • Block：采样阻塞操作的次数和耗时，采样率：只有阻塞耗时超过阈值才会被记录
    • 锁竞争：采样争抢锁的次数和耗时，采样率：只记录固定比例的锁操作
avatar
文章
阅读
粉丝