这是我参与「第五届青训营 」笔记创作活动的第3天
Go 高质量编程
什么是高质量
1. 各种边界条件是否考虑完备
2. 异常情况处理，稳定性保证
3. 易读易维护，简洁清晰
编程原则
1. 简单性
- 消除"多余的复杂性"，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
2. 可读性
- 代码是写给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读
3. 生产力
- 团队整体工作效率非常重要
编码规范
-
代码格式
可以使用gofmt和goimport等工具进行自动化格式代码，常见IDE都支持方便的配置。 -
注释
公共符号始终要注释。 注释应该做的： 解释代码作用：适合注释公共符号，如公共常量、变量、函数等 解释代码如何做的：适合注释实现过程 解释代码实现原因：适合解释代码的外部因素或提供额外上下文 解释代码什么情况会出错：适合解释代码的限制条件 代码是最好的注释。 注释应该提供代码未能表达出的上下文信息。 -
命名规范
变量 - 简洁胜于冗长 - 缩略词全部大写，但是位于开头且不需要导出外部使用时，使用全小写 - 变量距离其使用的地方越远，需要携带越多的上下文信息 函数 - 函数名不携带包的上下文信息 - 函数名尽量简短 包 - 只用小写字母组成。不包含大写字母和下划线等字符 - 简短并包含一定的上下文信息 - 不要与标准库同名。如sync或strings等 核心目的是降低阅读理解代码的成本。 重点考虑上下文信息，设计简洁清晰的名称。 -
控制流程
1. 避免嵌套，保持正常流程清晰 2. 尽量保持正常代码路径为最小缩进：优先处理错误 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支 正常流程代码沿着屏幕向下移动 提升代码可维护性和可读性 故障问题大多出现在复杂的条件语句和循环语句中 -
错误和异常处理
简单错误 - 定义：仅出现一次的错误，且在其它地方不需要捕获该错误 - 优先使用`errors.New`来创建匿名变量来直接表示简单错误: errors.New(错误信息) - 如果有格式化的需求，使用`fmt.Errorf` 错误的包装(Wrap)和解包(Unwrap) - 错误的Wrap提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链 - 在`fmt.Errorf`中使用: `%w`关键字来讲一个错误关联到错误链中：fmt.Errorf(错误信息, 错误变量) 错误判定 - 判定一个错误是否为特定错误，使用`errors.Is` - 不同于使用 `==`,使用该方法可以判定错误链上的所有错误是否含有特定的错误。 - 在错误链上获取特定种类的错误，使用`errors.AS` panic - 不建议在业务代码中使用panic - 调用函数不包括recover会造成程序崩溃 - 若问题可以被屏蔽或解决，建议使用error代替panic - 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic recover - 只能在defer的函数中使用 - 嵌套无法生效 - 只能在当期协程中生效 - defer的语句是后进先出的 - 如果需要更多的上下文信息，可以在recover后再在log中记录当前的调用栈 error尽可能提供简明的上下文信息链。 panic用于真正异常的情况 recover 仅在当前协程的defer的函数中生效
性能调优
使用Benchmark工具进行基准性能测试: go test -bench=. -benchmen
优化建议
- slice 预先分配内存，尽可能在make（）初始化切片时提供容量信息，减少扩容次数。
- 对大slice取一部分创建新slice时，使用make创建新切片，用copy进行拷贝，避免直接创建，导致大切片无法释放。
- map 同 slice 一样尽可能预先分配内存。
- 对频繁拼接字符串时，建议使用`string.Builder`进行拼接。因为同很多其它语言一样，字符串是不可变类型，拼接时会重新分配内存，导致性能低下。
- 因为空结构体`struct{}`实例不占用内存空间，所以作为占位使用可以节省资源，同时具有较强语义，即不需要任何值，仅作为占位符。可用于使用map来实现set功能。
- 使用atomic包替代锁，用于提高锁的效率。
避免常见的性能陷阱可以保证大部分程序的性能
普通应用代码，不要一味地追求程序的性能
越高级的性能优化手段越容易出现问题
在满足正确可靠、简洁清晰的质量要求的前提下取提高程序性能
个人总结
本次课程中接触到了一些Go语言的编程规范和性能调优的初步知识，为后续的学习和使用Go语言提供了基础。
引用
- 字节内部课: 高质量编程与性能调优实战
