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

可是我不会啊
123 阅读5分钟

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

前言

今天对高质量编程和性能调优实战进行了学习。个人看来，高质量编程与性能优化，更着重经验。这次笔记，主要还是帮助后面自己对这部分内容认识更深了来回顾的。

一、本堂课重点内容：

  • 常见编码规范
  • 性能优化建议
  • 性能分析工具pprof
  • 性能调优案例

二、详细知识点介绍：

什么是高质量

  • 编写的代码能够达到正确可靠、简洁清晰、无性能隐患的目标就能称之为高质量代码
  • 实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的
  • 高质量的编程需要注意：简单性、可读性、生产力

编程原则

简单性：

  • 消除"多余的复杂性"，以简单清晰的逻辑编写代码。
  • 不理解的代码无法修复改进。 可读性：
  • 代码是写给人看的，而不是机器。
  • 编写可维护代码的第一步是确保代码可读。 生产力
  • 团队整体工作效率非常重要

如何编写高质量代码

编码格式

推荐使用gofmt自动格式化代码：Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格。
gofmt很方便配置，Goland也内置了相关功能，直接开启即可在保存文件的时候自动格式化。

goimports(实际等于gofmt加上依赖包管理)

注释

注释应该做的：
注释应该解释代码的作用

  • 比如描述对外提供的函数的功能和用途

image.png 注释应该解释代码如何做的

image.png 上方的注释解释了这段代码是给新url加上最近的refer信息

注释应该解释代码实现的原因

image.png
其中有一行的shouldRedirect = false语句，如果没有注释就无法解释清楚为什么设置false

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

  • 例如函数的注释中可以说明是否存在性能隐患，输入的限制条件，可能存在的错误情况，让使用者无需了解实现细节。 image.png

代码是最好的注释
注释应该提供代码未表达出的上下文信息

命名规范

变量

  • 简介胜于冗长
  • 简略词全大写，但当其位于变量开头不需要导出时，使用全小写。
  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
    • 全局变量在其名字中需要更多的上下文信息，使得在不同的地方可以轻易辨认出其含义。
//Bad
for index := 0;index < len(s); index++ {
        // do something
}
//Good
for i := 0;i < len(s); i ++ {
        // do something
}

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

函数

  • 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的。
  • 函数名尽量简短
  • 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义。
  • 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名加入类型信息。 包
  • 只由小写字母组成。不包含大写字母和下划线等字符
  • 简短并包含一定的上下文信息。例如schema、task等
  • 不要与标准库同名。例如不要使用 sync 或者strings

总结：

  • 核心目标是降低阅读理解代码的成本
  • 重点考虑上下文信息，设计简洁清晰的名称
控制流程

尽量保持正常代码路径为最小缩进

  • 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
  • 最常见的正常流程的路径被嵌套在两个 if 条件内
  • 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误
  • 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套

总结：

  • 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支。
  • 正常流程代码沿着屏幕向下移动
  • 提升代码可维护性和可读性
  • 故障问题大多出现在复杂的条件语句和循环语句中
错误和异常处理

简单错误

  • 优先使用error.New来创建匿名变量来直接表示简单错误
  • 如果有格式化要求，使用fmt.Errorf
func defaultCheckRedirect(req *Request,via []*Request) error {
    if len(via) >= 10{
            return errors.New("stopped after 10 redirects")
            }
            return nil
 }


该示例定义了简单错误描述失败的原因

recover

  • 只能在被defer 的函数中使用
  • 嵌套无法生效
  • 只在当前 goroutine 生效
  • defer 的语句是后进先出
  • 如果需要更多的上下文信息，可以 recover 后在log中记录当前调用栈。 总结：
  • error 尽可能提供简明的上下文信息链，方便定位问题
  • panic 用于真正异常的情况
  • recover 生效范围，在当前 goroutine 的被defer的函数中生效

性能优化建议

  • 性能优化的前提是满足正确可靠、简洁清晰等质量因素
  • 性能优化是综合评估，有时候时间效率和空间效率可能对立
  1. Benchmark
    • 性能表现需要实际数据衡量
  2. Slice
    • 在已有切片基础上创建切片，不会创建新的底层数组。
    • 原切片较大，代码在原切片基础上新建小切片
    • 原底层数组在内存中有引用，得不到释放
    • 可使用copy 替代 re-slice
  3. Map
    • map 预分配内存
      • 不断向map中添加元素的操作会触发map的扩容
      • 提前分配好空间可以减少内存的拷贝和 Rehash 的消耗
      • 建议根据实际需求提前预估好需要的空间
  4. 字符串处理
    • 使用string.Builder
    • 使用 + 拼接性能最差，strings.Builder，byte,Buffer 相近 ，strings.Buffer 更快
      • 字符串在Go语言中是不可变类型，占用内存大小是固定的
      • 使用 + 每次都会重新分配内存
      • strings.Builder,byte.Buffer底层都是[]byte数组
      • 内存扩容策略，不需要每次拼接重新分配内存
  5. 空结构体
    使用空结构体节省内存
    • 实现 Set，可以考虑用 map 来代替
      • Go 语言标准库没有提供 Set 的实现，通常使用 map 来代替。对于集合场景，只需要用到 map 的键而不需要值
  6. atomic包
    原理
    • 锁的实现是通过操作系统来实现，属于系统调用
    • atomic 操作通过硬件实现，效率比锁高
    • sync.Mutex 应该用来保护一段逻辑，不仅仅用于保护一个变量
    • 对于非数值操作，可以使用atomic.Value,能承载一个interface{}

总结：

  • 避免常见的性能陷阱可以保证大部分程序的性能
  • 普通应用代码，不要一味的追求程序的性能
  • 在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能

2.5 性能调优实战

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

用于可视化和分析性能分析数据的工具
功能：

pproffunction.png

三、实践练习例子：

实践项目:github.com/wolfogre/go… 通过该项目的实践练习，能更好的去理解并掌握 pprof 工具的使用

四、课后个人总结：

本次课程介绍了编码规范和Go语言的性能优化建议和常用的性能分析工具pprof。我认为本次学习的内容其实偏向理解的比较多，属于需要积累的。而且，今天学习到的内容对于一个标准的程序员是很重要的，是写出优秀的代码的关键。需要再花时间，去记忆去理解。也明白了大致性能优化的一个流程，帮助很大。

五、引用参考：

【后端专场 学习资料一】第五届字节跳动青训营 - 掘金 (juejin.cn)
Go 高质量编程、编码规范｜ 青训营笔记 - 掘金 (juejin.cn)

avatar
文章
阅读
粉丝