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

01高质量编程

1.1简介

什么是高质量——编写的代码能够达到正确可靠，简洁清晰的目标可以称之为高质量代码

各种边界条件是否考虑完备
异常情况处理稳定性保证
易读易维护高质量编程需要注意：简单性，可读性，生产力

1.2编码规范

1.2.1代码格式

gofmt可以自动格式化代码，使代码格式保持一致
goland：cmd+option+l可以自动调整代码格式

作用：提高可读性，风格一致的代码更容易维护，更少的学习、团队合作、Review成本

1.2.2注释

注释应该解释代码作用，代码如何做的，代码实现的原因，出错的情况
公共符号始终要注释，但不需要注释实现接口的方法代码是最好的注释，注释应该提供代码未表达出的上下文信息，注释是为了提供额外的代码信息

1.2.3命名规范

可以缩写，但是谨慎，不要太小众

变量
- 简洁
- 缩略词全部大写，不需要导出全小写
- 不要省略重要上下文信息，特别是上下文对象
函数
- 不携带报名的上下文信息，函数名尽量简短（eg http.Serve~~HTTP~~())
包
- 只有小写字母，不要和标准库同名，不使用常用变量名，使用单数

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

1.2.4控制流程

线性原理，处理逻辑尽量走直线，嵌套尽量少
尽量保证正常代码的路径为最小缩进，特殊情况提前返回
提升代码可维护性和可读性
故障问题大多出现在复杂的条件语句和循环语句中

1.2.5错误和异常处理

error，尽可能提供简明的上下文信息，方便定位问题
- 简单错误，优先使用errors.New()，有格式化需求时使用fmt.Errof()
- 错误的Wrap和Unwrap，使用 %w 关键字来将一个错误 wrap 至其错误链中
- 错误处理，errors.Is,特殊的错误类型判断
- 错误判定，errors.As,获取特定种类的错误
panic，用于真正异常的情况
recover，只能在defer中被使用，嵌套无法生效，只在当前goroutine生效

defer语句，会正常执行，函数返回前调用，执行顺序是后进先出

1.3性能优化建议

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

1.3.1 性能优化建议-Benchmark

go test -bench=. -benchmem

1.3.2 Slice预分配内存

扩容会导致性能降低

解决方法：定义足够大的长度因为创建一个新的切片会复用原来切片的底层数组，所以新建一个切片的时候会使用到原先定义的大容量切片，导致原数组在内存中有应用未释放
解决方法：使用copy操作代替re-slice

1.3.3 map预分配内存

不断向 map 中添加元素的操作会触发 map 的扩容

解决方法：根据实际需求提前预估好需要的空间，提前分配好空间可以减少内存拷贝和 Rehash 的消耗 == 速度优化 == 空间优化

1.3.4 使用strings.Builder

常见的字符串拼接方式
- +
- strings.Builder
- bytes.Buffer
- strings.Buffer
strings.Builder 最快，bytes.Buffer 较快，+ 最慢
原理
- 字符串在 Go 语言中是不可变类型，占用内存大小是固定的，当使用 + 拼接 2 个字符串时，生成一个新的字符串，那么就需要开辟一段新的空间，新空间的大小是原来两个字符串的大小之和
- strings.Builder，bytes.Buffer 的内存是以倍数申请的
- strings.Builder 和 bytes.Buffer 底层都是 []byte 数组，bytes.Buffer 转化为字符串时重新申请了一块空间，存放生成的字符串变量，而 strings.Builder 直接将底层的 []byte 转换成了字符串类型返回

1.3.5 空结构体

空结构体不占用内存使用的空间，可以作为在各种场景下的占位符使用，能够节省空间

1.3.6 atomic包

锁的实现是通过操作系统来实现，属于系统调用，atomic 操作是通过硬件实现的，效率比锁高很多
锁应该用来保护一段逻辑，atomic可以用来保护一个变量
对于非数值系列，可以使用 atomic.Value，atomic.Value 能承载一个 interface{}

总结

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

参考资料

青训营学习资料：juejin.cn/post/709372…

高质量编程 | 青训营笔记