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

逝不等琴生
72 阅读5分钟

前言

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

今日学习内容：

  • 高质量编程
    • 高质量编程简介
    • 编码规范
    • 性能优化建议
  • 性能调优实战
    • 性能调优简介
    • 性能分析工具 pprof 实战
    • 性能调优案例

正文

高质量编程

高质量编程简介

编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码

  • 各种边界条件是否考虑完备
  • 异常情况处理，稳定性保证
  • 易读易维护
  1. 高质量代码的编程原则
  • 简单性
    • 消除“多余的复杂性”，以简单清晰的逻辑编写代码
    • 不理解的代码无法修复改进
  • 可读性
    • 代码是写给人看的，而不是机器
    • 编写可维护代码的第一步是确保代码可读
  • 生产力
    • 团队整体工作效率非常重要

编程规范

如何编写高质量的 Go 代码

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

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

  • goimports

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

  1. 注释

注释应该做到：

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

这种注释适合说明公共符号，比如对外提供的函数注释，需要描述清楚它的功能和用途。只有在函数的功能简单而明显时才能省略这些注释。另外注释要避免啰嗦，不要对显而易见的内容进行说明。

  • 注释应该解释代码如何做的

这种注释是对代码中复杂的，并不明显的逻辑进行说明，适合注释实现过程。

// Add the Referer header from the most recent                       
// request URL to the new one, if it's not https->http:              
if ref := refererForURL(reqs[len(reqs)-1].URL, req.URL); ref != "" { 
   req.Header.Set("Referer", ref)                                       
}
  • 注释应该解释代码实现的原因

注释可以解释代码的外部因素，这些因素脱离上下文后通常很难理解。

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

注释应该提醒使用者一些潜在的限制条件或者会无法处理的情况。例如函数的注释中可以说明是否存在性能隐患，输入的限制条件，可能存在哪些错误情况，让使用者无需了解实现细节。

  1. 命名规范
  • 核心目标是降低阅读理解代码的成本
  • 重点考虑上下文信息，设计简洁清晰的变量名
  • 简洁胜于冗长
  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
    • 使用 ServeHTTP 而不是 ServeHttp
    • 使用 XMLHTTPRequest 或者 xmlHTTPRequest
  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
  • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
  • 变量命名

如下图，i 和 index 的作用域仅限于 for 循环内部时，index 的额外冗长几乎没有增加对于程序的理解 image.png

如下图，将 deadline 替换成 t 降低了变量名的信息量，t 常指代任意时间，而 deadline 指代截止时间，有特定的含义 image.png

  • 函数命名

image.png

  • 包命名
  • 只由小写字母组成。不包含大写字母和下划线等字符
  • 简短并包含一定的上下文信息，例如 schema，task 等
  • 不要与标准库同名，例如不要使用 sync 或者 strings
  • 不使用常用变量名作为包名。例如使用 bufio 而不是 buf
  • 使用单数而不是复数。例如使用 encoding 而不是 encodings
  • 谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短
  1. 控制流程
  • 避免嵌套

如果两个分支语句都包含 return 语句，则可以去除掉冗余的 else 语句，else 一般是正常流程。

image.png 的d

  • 尽量保持正常代码路径为最小缩进
  • 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
  • 线性原理，处理逻辑尽量走直线 ，避免复杂的嵌套分支
  • 正常流程代码沿着屏幕向下移动
  • 故障代码大多出现在复杂的条件语句和循环语句中

image.png

  1. 错误和异常处理
  • error 尽可能提供简明的上下文信息链，方便定位问题
  • panic 用于真正异常的情况
  • recover 生效范围，在当前 goroutine 的被 defer 的函数中生效
  • 简单的错误
  • 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
  • 优先使用 errors.New 来创建匿名变量来直接表示简单错误
  • 如果有格式化的需求，使用 fmt.Errorf

image.png

  • 错误的 Wrap 和 Unwrap
  • 错误的 Wrap 实际上是提供了一个 error 嵌套另一个 error 的能力，从而生成一个 error 的跟踪链
  • 在 fmt.Errorf 中使用: %w 关键字来将一个错误关联至错误链中
  • 判定一个错误是否为特定错误，使用 errors.Is
  • 不同于使用 == ，使用 errors.Is 可以判定错误链上的所有错误是否含有特定的错误。
  • 在错误链上获取特定种类的错误，使用 errors.As
  • 当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic。但是不建议在业务代码中使用 panic，因为 panic 发生后，会向上传播至调用栈顶，如果当前 goroutine 中所有 deferred 函数都不包含 recover 就会造成整个程序崩溃，若问题可以被屏蔽或解决，建议使用 error 代替 panic。
  • recover 只能在 defer 的函数中使用，并且只在当前 goroutine 生效，defer 的语句是后进先出。

性能优化建议

性能调优实战

avatar
文章
阅读
粉丝