这是我参与「第五届青训营 」伴学笔记创作活动的第 4 天
高质量编程
简介
- 编写的代码能够达到正确可靠、简洁清晰、无性能隐患的目标就能称之为高质量代码
- 实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的
- 高质量的编程需要注意以下原则：简单性、可读性、生产力
常见编码规范
代码格式
- 使用 gofmt 自动格式化代码，保证所有的 Go 代码与官方推荐格式保持一致
风格一致的代码更容易维护、需要更少的学习成本、团队合作成本。
命名规范
-
variable
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
-
function
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
- 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息
-
package
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如 schema、task 等
- 不要与标准库同名。例如不要使用 sync 或者 strings
好的命名能让人把关注点留在主流程上，理解程序的功能
error
error 尽可能提供简明的上下文信息，方便定位问题
-
fmt.Errorf
- 在 fmt.Errorf 中使用 %w 将错误 wrap 至其错误链中
-
panic
- 不建议在业务代码中使用 panic
- panic 用于真正异常的情况
- 当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic
-
recover
- recover 生效范围，在当前 goroutine 的被 defer 的函数中生效
- 如果需要更多的上下文信息，可以 recover 后在 log 中记录当前的调用栈。
slice 预分配内存
-
在尽可能的情况下，在使用 make() 初始化切片时提供容量信息，特别是在追加切片时
-
切片操作并不复制切片指向的元素，创建一个新的切片会复用原来切片的底层数组，因此切片操作是非常高效的
-
切片有三个属性，指针(ptr)、长度(len) 和容量(cap)。append 时有两种场景：
- 当 append 之后的长度小于等于 cap，将会直接利用原底层数组剩余的空间
- 当 append 后的长度大于 cap 时，则会分配一块更大的区域来容纳新的底层数组
因此，为了避免内存发生拷贝，如果能够知道最终的切片的大小，预先设置 cap 的值能够获得最好的性能
使用 strings.Builder
常见的字符串拼接方式 +，strings.Builder，bytes.Buffer。经过测试之后发现strings.Builder 最快，bytes.Buffer 较快，+ 最慢
字符串在 Go 语言中是不可变类型，占用内存大小是固定的，当使用 + 拼接 2 个字符串时，生成一个新的字符串，那么就需要开辟一段新的空间，新空间的大小是原来两个字符串的大小之和。strings.Builder，bytes.Buffer 的内存是以倍数申请的，所以更快。
bytes.Buffer 比strings.Builder 慢是因为bytes.Buffer字符串时重新申请了一块空间，存放生成的字符串变量，而 strings.Builder 直接将底层的 []byte 转换成了字符串类型返回，所以更快。
空结构体不占据内存空间，可作为占位符使用
pprof分析性能，可以利用火焰图，更加直观定位性能瓶颈
