高质量编程 | 青训营笔记

Leift
84 阅读9分钟

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

本节课程主要分为两部分，分别为：

  1. 高质量编程，主要包括：

    高质量编程简介、编码规范、性能优化建议

  2. 性能调优实战，主要包括：

    性能调优简介，性能分析工具pprof实战以及性能调优案例

1 高质量编程

编写的代码能够达到正确可靠、简洁清晰的目标可以称之为高质量代码。主要包括各种边界条件是否考虑完备，能够进行异常情况处理，保证稳定性，以及要能够易读易维护。

编程原则包括三点：

  • 简单性：要消除“多余的重复性”，以简单清晰的逻辑编写代码，因为不理解的代码无法修复改进。

  • 可读性：代码是写给人看的，而不是机器，编写可维护代码的第一步是确保代码可读。

  • 生产力：团队的整体工作效率十分的重要。

1.1编写规范

编写高质量Go代码，主要有以下几部分：

- 代码格式
- 注释
- 命名规范
- 控制流程
- 错误和异常处理

  • 代码格式： 推荐使用gofmt自动格式化代码 Gofmt是Go语言官方提供的工具，能够自动格式化Go语言代码为官方统一风格，常见的IDE都支持方便的配置。

    Goimports也是Go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包引用，将依赖包按照字母序排序并分类。

  • 注释： 注释应该完成： 注释应该解释代码的作用 注释应该解释代码如何做的 注释应该解释代码实现的原因 注释应该解释代码什么情况下会出错

    注释的规范

    公共符号始终要注释： 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释。 任何既不明显也不简短的公共功能必须予以注释。 无论长度或者复杂程度如何，对库中的任何函数都必须进行注释。 对于接口不需要进行注释。 代码应该是最好的注释 注释应该提供代码未表达出的上下文信息

命名规范

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

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

  • Package 规范： 只有小写字母组成。不包含大写字母和下划线等字符 简短并包含一定的上下文信息。例如schema、task等 不要与标准库同名。 尽量满足下述条件： 不使用常用变量名作为包名 是用单数而不是复数 谨慎的使用缩写 命名规范的核心目的为降低代码阅读理解的成本 重点是要考虑上下文信息，设计简洁清晰的名称

  • 控制流程

    在控制流程中需要避免嵌套，要保证正常流程清晰。 对于比较复杂的分支流程，要尽量保持正常代码路径为最小缩进，优先处理错误情况以及特殊情况，通过尽早返回或者继续循环的方式来减少嵌套。

    控制流程的代码规范主要要保证：线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支，正常流程代码沿屏幕向下移动，要提高代码的可维护性以及可读性，故障问题大多出现在复杂的条件语句和循环语句中。

  • 错误与异常处理： 简单错误指仅出现一次的错误，并且在其他地方不需要捕获该错误。 优先使用errors.New来创建匿名变量来直接表示简单错误，如果有格式化需求，则使用fmt.Errorf 错误的Wrap和Unwrap 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链 在fmt.Errorf中使用%w关键字来将一个错误关联至错误链中 判断是否为某种错误，用error.Is 在错误链上获取特定种类的错误，使用errors.As

  • Panic 不建议在业务代码中使用panic，如果问题可以被屏蔽或者解决，建议使用error而不是panic

    如果在启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic

  • Recover Recover只能在被defer的函数中使用 Recover嵌套无法生效 Recover只能在当前的协程中生效 要注意defer语句是后进先出

小结

Error应尽可能提供简明的上下文信息链，方便定位问题 Panic用于真正异常的情况 Recover生效范围在当前goroutine的被defer的函数中

2 性能优化建议

性能优化的前提是满足正确可靠、简介清晰等质量因素 性能优化是综合评估，有时候时间效率和空间效率可能是对立的 针对go语言特性，介绍go相关的性能优化建议

利用benchmark进行基准性能测试 优化建议：

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

切片本质是一个数组片段的描述，包括：数组指针、片段长度以及片段容量。

切片操作并不复制切片指向的元素，创建一个新的切片会复用原来的切片的底层数组,Re-slice存在一个陷阱，大内存得不到释放，解决方法:建议使用copy代替re-slice

Map预分配内存，对map添加元素会使map不断进行扩容，造成性能影响

字符串处理，使用stringbuilder进行字符串拼接，速度快，使用stringbuffer进行字符串拼接，速度也相对较快，但是较builder速度慢。

空结构体，使用空结构体来节省内存，使用空struct示例不占据任何内存空间，使用空结构体可以节省资源，而空结构体本身又具有很强的语义。

使用Atomic包提高时间性能

性能优化建议：

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

2.2性能调优实战内容

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

性能分析工具pprof 主要包括四种功能：分析、工具、采样、展示

来看一个pprof实践项目

项目中提前埋入了一些炸弹代码，产生可观测的性能问题 查询cpu占用结果：

  • flat：当前函数本身执行耗时
  • flat%：flat占cpu总执行时间百分比
  • sum%：上面每一行flat%之和
  • cum：对当前函数加上其调用函数的总耗时
  • cum%：cum占cpu总时间的比例

查询内存占用结果： go tool pprof -http=:8080 http://localhost:6060/debug/pprof/heap观察哪部分方法内存占用最大。

查看协程结果： http://localhost:6060/debug/pprof/goroutine观察协程问题

查看锁操作的问题 http://localhost:6060/debug/pprof/mutex观察锁的问题

Pprof采样的过程与原理

CPU

  • 采样对象：函数调用和它们占用的时间
  • 采样率：100次/秒，为一个固定值
  • 采样时间：从手动启动到手动结束

堆内存

  • 采样程序通过内存分配器在堆上分配和释放内存，记录分配/释放的大小和数量
  • 采样率：每分配512KB记录一次，可在运行开头修改，1为每次分配均记录
  • 采样时间：从程序运行开始到采样时
  • 采样指标包括：alloc_space,alloc_objects,inuse_space,inuse_objects
  • 计算方式：inuse=alloc-free

协程

记录所有用户发起且在运行的协程 runtime.main的调用栈信息

2.3 优化案例

业务服务概念：

  • 服务：能单独部署，承载一定功能的程序

  • 依赖：Service A 的功能实现依赖ServiceB的响应结果，称为Service A依赖Service B 调用链路：能支持一个接口请求的相关服务集合及其相互之间的依赖关系

  • 基础库：公共的工具包、中间件

业务服务优化的流程：

  1. 建立服务性能评估手段
  2. 分析性能数据，定位性能瓶颈
  3. 重点优化项改造
  4. 优化效果验证

性能调优要依赖数据而不是猜测; 要能够熟练使用pprof工具排查性能问题并了解基本原理; 性能调优要保证正确性，能够定位主要瓶颈。

3 总结

在本节课中我主要学习了Golang语言的高质量编程以及性能调优相关知识，包括高质量编程介绍、编码规范、性能优化建议以及性能优化实战中性能分析工具pprof介绍和具体调优案例介绍。在本节课中我对编程有了更加深刻的认识，不同于以往简单使用benchmark对性能进行测试，我在学习完本课后对于项目里的性能测试以及性能优化有了更加深刻的理解，课后我会进一步理解pprof工具，自己进行一些测试，同时预习下节课相关知识。

avatar
文章
阅读
粉丝