这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
一、高质量编程
1. 高质量编程的目的
为了让编写的代码正确可靠、简洁清晰，更容易理解和维护。
2. 怎样才算高质量
- 正确性：是否考虑各种边界条件，错误的调用是否能够处理
- 可靠性：异常情况或者错误的处理略是否明确，依赖的服务出现异常是否能够处理
- 简洁：逻辑是否简单，后续调整功能或新增功能是否能够快速支持
- 清晰：其他人在阅读理解代码的时候是否能清楚明白，重构或者修改功能是否不会担心出现无法预料的问题
3. 编码规范
1. 代码格式
（1）gofmt
用 Go 语言官方提供的工具，能自动格式化 Go 语言代码为官方统一风格，可用常见的 IDE 进行配置。
（2）goimports
也是 Go 语言官方提供的工具，实际等于 gofmt 加上依赖包管理，可以自动增删依赖的包引用、将依赖包按字母序排序并分类。
2. 注释
-
注释应该解释代码作用
- 包中声明的每个公共的符号变量、常量、函数以及结构都需要添加注释；
- 任何既不明显也不简短的公共功能必须予以注释；
- 无论长度或复杂程度如何，对库中的任何函数都必须进行注释；
- 有一个例外，不需要注释实现接口的方法 。
-
注释应该解释代码如何做的
注释函数或者方法的时间过程
-
注释应该解释代码实现的原因
解释代码的外部因素，包括通过此部分所连接的上下文，给出说明
-
注释应该解释代码什么情况会出错
解释代码的限制条件
3. 命名规范
命名规范的核心目标是降低阅读理解代码的成本。
下面介绍一节常见的命名规范：
-
变量名
- 简洁胜于冗长，前提是简化后不影响语义的解读
-
函数
-
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用 ServeHTTP 而不是 ServeHttp
- 使用 XMLHTTPRequest 或者 xm 旧 TTPRequest
-
变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
-
-
函数名和包名不携带相同的上下文信息
-
包名
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如 schema 、 task 等
- 不要与标准库同名。例如不要使用 sync 或者 strings
- 不使用常用变量名作为包名。例如使用 bufio 而不是 buf
- 使用单数而不是复数。例如使用 encoding 而不是 encodings
- 谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短
4. 控制流程
- 避免嵌套，保持正常流程清晰
- 如果两个分支中都包含 return 语句，则可以去除冗余的 else
- 尽量保持正常代码路径为最小缩进
5. 错误和异常处理
-
简单错误处理
仅出现一次的错误，优先使用 errors.New 来创建匿名变量来直接表示该错误，有格式化需求时使用 fmt.Errorf。
-
错误的 Wrap 和 Unwrap
错误的包装提供了一个 error 嵌套另一个 error 的能力，生成一个 error 的跟踪链，同时结合谌误的判定方法来确认调用链中是有关注的错误出现。这个能力的好处是每一层调用方可以补充自己对应的上下文，方便跟踪排查问题，确定问题的根本原因在哪里。在 fmt.Errorf 中使用：%w 关踺字来将一个错误 wrap 至其错误链中。
-
错误判定
- 判定一个错误是否为特定错误，使用 errorsAs
- 不同于使用 ==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
-
panic
- 不建议在业务代码中使用 panic
- 调用函数不包含 recover 会造成程序崩溃
- 若问题可以被屏蔽或解决，建议使用 error 代替 panic
- 当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic
-
reocover
-
recover 只能在被 defer 的函数中使用
-
嵌套无法生效
-
只在当前 goroutine 生效
-
defer 的语句是后进先出
-
如果需要更多的上下文信息，可以 recover 后在 log 中记录当前的调用栈
-
6. 性能优化建议
1. benchmark 工具
Go 语言提供了支持基准性能测试的 benchmark 工具，用数据衡量实际的性能表现。
终端运行 go test -bench=. -benchmem
结果说明：
2. slice 预分配内存
- 尽可能在使用 make() 初始化切片时提供容量信息，在追加数据时避免多次的扩容操作
- 在原切片比较大的基础上，创建小切片，用 copy 替代 re-slice
3. map 预分配内存
和 slice 一样
4. 字符串处理
使用 + 拼接性能最差 ， strings.Builder, bytes.Buffer 相近 ， strings.Buffer 更快
原因：
- 字符串在 Go 语言中是不可变类型，占用内存大小是固定的
- 使用 + 每次都会重新分配内存
- strings.Builder，bytes.Buffer 底层都是 [ ]byte 数组
- 内存扩容策略，不需要每次拼接重新分配内存
5. 使用空结构体节省内存
-
空结构体不占据内存空间，可作为占位符使用
-
比如实现简单的 Set
- Go 语言标准库没有提供 Set 的实现，通常使用 map 来代替。对于集合场景，只需要用到 map 的键而不需要值
6. 使用 atomic 包
原理：
- 锁的实现是通过操作系统来实现，属于系统调用，atomic 操作是通过硬件实现的，效率比锁高很多
- sync.Mutex 应该用来保护一段逻辑，不仅仅用于保护一个变量
- 对于非数值系列，可以使用 atomic.Value，atomic.Value 能承载一个 interface{}
介绍了高质量编程的目的以及编程过程中的一些规范，强调了语言机制，逻辑机制和错误处理过程中避免出现的一些情况，最后给出一些实际使用过程中性能优化的建议。
在项目编写代码的过程中，做到规范和性能优化，能够极大减少后期的维护成本，增加维护的效率，增加实际项目运行过程中的体验。
