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

JiuYou2020
66 阅读7分钟

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

1. 本堂课重点内容

本堂课重点介绍的是:

  1. 高质量编程
  2. 性能调优

2. 详细知识点介绍

2.1 高质量编程简介

什么是高质量编程?

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

编程原则

  1. 简单性
    • 消除“多余的复杂性”，以简单清晰的逻辑编写代码
      • 在实际工程项目中，复杂的程序逻辑会让人害怕重构和优化，因为无法明确预知调整造成的影响范围 难以理解的逻辑，排查问题时也难以定位，不知道如何修复
  2. 可读性
    • 可读性很重要，因为代码是写给人看的，而不是机器
      • 在项目不断迭代的过程中，大部分工作是对已有功能的完善或扩展，很少会完全下线某个功能，对应的功能代码实际会生存很长时间。已上线的代码在其生命周期内会被不同的人阅读几十上百次
      • 听课时老师经常说的在课堂上不遵守纪律影响全班同学的时间，难以理解的代码会占用后续每一个程序员的时间
  3. 生产力
    • 编程在当前更多是团队合作，因此团队整体的工作效率是非常重要的一方面
      • 为了降低新成员上手项目代码的成本，Go语言甚至通过工具强制统一所有代码格式
      • 编码在整个项目开发链路中的一个节点，遵循规范，避免常见缺陷的代码能够降低后续联调、测试、验证、上线等各个节点的出现问题的概率，就算出现问题也能快速排查定位

2.2 编码规范

2.2.1 代码格式

  1. gofmt

G0语言官方提供的工具，能自动格式化G0语言代码为官方统一风格 常见IDE都支持方便的配置

  1. goimports

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

2.2.2 注释

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

2.2.3 命名规范

  • 简洁胜于冗长

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

    • 例如使用ServeHTTP而不是ServeHttp
    • 使用XMLHTTPRequest或者mIHTTPRequest

  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息

    • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

  • 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的

  • 函数名尽量简短

  • 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义

  • 当名为fo0的包某个函数返回类型T时(T并不是Foo),可以在函数名中加入类型信息

  • 只由小写字母组成。不包含大写字母和下划线等字符

  • 简短并包含一定的上下文信息。例如schema、task等

  • 不要与标准库同名。例如不要使用Sync或者strings

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

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

2.2.4 控制流程

  • 避免嵌套,保持正常流程清晰
  • 尽量保持正常代码路径为最小缩进
    • 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
  • 正常流程代码沿着屏幕向下移动
  • 提升代码可维护性和可读性
  • 故障问题大多出现在复杂的条件语句和循环语句中

2.2.5 错误和异常处理

  • 简单错误

    • 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
    • 优先使用errors.New来创建匿名变量来直接表示简单错误
    • 如果有格式化的需求，使用fmt.Errorf

  • 错误的Wrap和Unwrap

    • 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
    • 在fmt.Errorf中使用：%w关键字来将一个错误关联至错误链中

Go1.13在errors中新增了三个新AP和一个新的format关建字，分别是errors.ls errors.As,errors.Unwrap以及fmt.Errorf的%w。如果项目运行在小于Go1.13的版本中，导入golang.org/x/xerrors来使用

  • 错误判定

    • 判定一个错误是否为特定错误，使用errors.Is
    • 不同于使用==，使用该方法可以半判定错误链士的所有错误是否含有特定的错误
    • 在错误链上获取特定种类的错误,使用errors.As

  • panic

    • 议在业务代码中使用panic
    • 调用函数不包含recover会造成程序崩溃
    • 若问题可以被屏蔽或解决，建议使用error代替panic
    • 当程序启动阶段发生不可逆转的错误时
    • 可以在init或main函数中使用panic

  • recover

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

2.3 性能优化建议

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

可以使用Go语言提供的支持基准性能测试的benchmark工具

  1. 可以为map,slice预分配内存来优化性能
  2. 可以使用strings.Builder或者bytes.Buffer来拼接字符串,并理解为什么strings.Builder要比bytes.Buffer快一些
  3. 可以使用空结构体节省内存
  4. 在对某个类型的数据进行处理时,可以考虑用atomic包来代替加锁(如果有并发安全的需求)

2.4 性能调优

2.4.1 性能调优原则

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

2.4.2 性能分析工具pprof

  1. 在启动了使用pprof的项目时,可以去localhost:6060/debug/pprof/查看指标
  2. 可以使用go tool pprof "http://localhost:6060/debug/pprof/profile?seconds=10"查看cpu资源的占用情况
  3. 可以使用web命令调用关系可视化
  4. 可以使用go tool pprof -http=localhsot:8080 "http://localhost:6060/debug/pprof/heap"来查看堆内存占用情况,类似的,可以将/heap修改为goroutine,mutex,block来查看协程情况,锁情况以及阻塞情况

3. 性能调优案例

可以将老师的讲述概况为以下三点:

  1. 业务服务优化
  2. 基础库优化
  3. Go语言优化

4. 课后总结

经过本节课的学习,我们应该掌握的是:

  1. 如何编写一段简洁清晰的代码
  2. 在编写代码时要符合编码规范
  3. 初步掌握性能调优的基本知识
  4. 学会使用性能分析工具pprof
avatar
文章
阅读
粉丝