Go语言高质量编程与性能调优实战|青训营笔记

achivmd
181 阅读6分钟

这是我参与「第三届青训营 -后端场」笔记创作活动的的第4篇笔记

1.内容概要思维导图

image.png

2. 高质量编程

2.1 什么是高质量编程？

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

2.2常见代码规范

2.2.1 代码格式

  • 使用 gofmt 自动格式化代码，保证所有的 Go 代码与官方推荐格式保持一致
  • 提升可读性，风格一致的代码更容易维护、需要更少的学习成本、团队合作成本，同时可以降低 Review 成本

2.2.2 注释

  • 注释应该解释代码的作用

    适合用于注释公共符号

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

    适合用于注释方法

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

    用于解释代码的外部因素

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

  • 公共符号始终要注释

    包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释 总结：

  • 代码是最好的注释

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

2.2.3命名规范

对 变量（variable） 的要求

  • 简洁胜于冗长
  • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
  • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
  • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义 对 函数（function） 的要求
  • 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
  • 函数名尽量简短
  • 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
  • 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息 对 包（package） 的要求
  • 只由小写字母组成。不包含大写字母和下划线等字符
  • 简短并包含一定的上下文信息。例如 schema、task 等
  • 不要与标准库同名。例如不要使用 sync 或者 strings 总结：
  • 关于命名的大多数规范核心在于考虑上下文
  • 人们在阅读理解代码的时候也可以看成是计算机运行程序，好的命名能让人把关注点留在主流程上，清晰地理解程序的功能，避免频繁切换到分支细节，增加理解成本

2.2.4 控制流程

  • 避免嵌套，保持正常流程清晰
  • 如果两个分支中都包含 return 语句，则可以去除冗余的 else

  • 尽量保持正常代码路径为最小缩进，优先处理错误情况/特殊情况，并尽早返回或继续循环来减少嵌套，增加可读性

总结:

  • 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
  • 提高代码的可读性

2.2.5 错误和异常处理

  • 简单错误处理

    • 优先使用 errors.New 来创建匿名变量来直接表示该错误。有格式化需求时使用 fmt.Errorf
    • github.com/golang/go/b…

  • 错误的 Wrap 和 Unwrap

    • 在 fmt.Errorf 中使用 %w 关键字来将一个错误 wrap 至其错误链中
    • github.com/golang/go/b…

    • Go1.13 在 errors 中新增了三个新 API 和一个新的 format 关键字，分别是 errors.Is、errors.As 、errors.Unwrap 以及 fmt.Errorf 的 %w。如果项目运行在小于 Go1.13 的版本中，导入 golang.org/x/xerrors 来使用。以下语法均已 Go1.13 作为标准。

  • panic

    • 不建议在业务代码中使用 panic
    • 如果当前 goroutine 中所有 deferred 函数都不包含 recover 就会造成整个程序崩溃
    • 当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic
    • github.com/Shopify/sar…

  • recover

总结:

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

3. 性能优化建议

  • 在满足正确性、可靠性、健壮性、可读性等质量因素的前提下，设法提高程序的效率
  • slice 预分配内存

    • 在尽可能的情况下，在使用 make() 初始化切片时提供容量信息，特别是在追加切片时

    • 原理

      • ueokande.github.io/go-slice-tr…

      • 切片本质是一个数组片段的描述，包括了数组的指针，这个片段的长度和容量(不改变内存分配情况下的最大长度)

      • 切片操作并不复制切片指向的元素，创建一个新的切片会复用原来切片的底层数组，因此切片操作是非常高效的

      • 切片有三个属性，指针(ptr)、长度(len) 和容量(cap)。append 时有两种场景：

        • 当 append 之后的长度小于等于 cap，将会直接利用原底层数组剩余的空间
        • 当 append 后的长度大于 cap 时，则会分配一块更大的区域来容纳新的底层数组

      • 因此，为了避免内存发生拷贝，如果能够知道最终的切片的大小，预先设置 cap 的值能够获得最好的性能

      • 另一个陷阱：大内存得不到释放

      • 在已有切片的基础上进行切片，不会创建新的底层数组。因为原来的底层数组没有发生变化，内存会一直占用，直到没有变量引用该数组

      • 因此很可能出现这么一种情况，原切片由大量的元素构成，但是我们在原切片的基础上切片，虽然只使用了很小一段，但底层数组在内存中仍然占据了大量空间，得不到释放

      • 推荐的做法，使用 copy 替代 re-slice

avatar
文章
阅读
粉丝