这是我参与「第五届青训营 」伴学笔记创作活动的第 5 天

一、本节课重点内容

1. 高质量编程简介

2. 编码规范

3. 性能优化建议

二、详细知识点介绍

1. 高质量编程简介

什么是高质量？

• 各种边界条件是否考虑完备
• 异常情况处理，稳定性保证
• 易读易维护

编程原则

• 简单性：消除“多余的复杂性”，以简单清晰的逻辑编写代码
• 可读性：编写可维护代码的第一步是保证代码可读
• 生产力：团队工作效率非常重要

2. 编码规范

如何编写高质量的Go代码

• 代码格式
• 注释
• 命名规范
• 控制流程
• 错误和异常处理

代码格式

• 推荐使用gofmt自动格式化代码，gofmt是Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格
• goimports也是Go语言官方提供的工具，会对依赖包进行管理，自动增删依赖的包引用并按字母排序分类

注释

• 注释应该解释代码的作用：适合注释公共符号
• 注释应该解释代码如何做的：适合注释实现过程
• 注释应该解释代码实现的原因：适合解释代码的外部因素，提供额外上下文
• 注释应该解释代码什么情况会出错：适合解释代码的限制条件

命名规范

• 简洁胜于冗长
• 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
• 变量距离其被使用的地方越远，则需要携带越多的上下文信息

控制流程

• 线性原理，处理逻辑尽量走直线避免嵌套，保持正常流程清晰
• 尽量保持正常代码路径为最小缩进
• 优先处理错误情况、特殊情况，尽早返回或继续循环来减少嵌套
• 正常流程代码沿着屏幕向下移动
• 故障问题大多出现在复杂的条件语句和循环语句中

错误和异常处理

简单错误

• 简单错误是指仅出现一次的错误，且在其他地方不需要捕获该错误
• 优先使用errors.New来创建匿名变量来直接表示简单错误
• 如果有格式的需求，使用fmt.Errorf

错误的Wrap和Unwrap

• 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
• 在fmt.Errorf中使用:%w关键字来将一个错误关联至错误链中

错误判定

• 判定一个错误是否为特定错误，可以使用errors.Is
• 在错误链上获取特定种类的错误，使用errors.As

panic

• 不建议在业务代码中使用panic，因为panic发送后，会向上传播至调用栈顶，如果当前goroutine中所有deferred函数都不包含recover会造成程序崩溃
• 若问题可以被屏蔽或解决，建议使用error代替panic
• 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic

recover

• recover只能在被defer的函数中使用
• 嵌套无法生效
• 只能在当前goroutine生效
• defer语句是后进先出
• 如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈

3. 性能优化建议

• 性能优化的前提是满足正确可靠、简洁清晰等质量因素
• 性能优化是综合评估，有时候时间效率和空间效率可能对立

Benchmark

性能表现需要用实际数据衡量 可通过go test -bench=. -benchmem命令运行benchmark得到测试结果

Slice

• 切片本质是一个数组片段的描述，包括数组指针、片段的长度、片段的容量(不改变内存分配情况下的最大长度)
• 切片操作并不复制切片指向的元素
• slice预分配内存，尽可能在使用make()初始化切片时提供容量信息
• 在已有切片基础上创建一个切片会复用原来切片的底层数组，不会创建新的底层数组
• 可使用copy代替re-slice

空结构体

• 空结构体stryct{}实例不占据任何的内存空间
• 可作为各种场景下的占位符使用，节省资源

atomic包

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

三、课后个人总结

在实际中，要避免常见的性能陷阱，就可以保证大部分程序的性能。对于普通的应用代码，不要一味地追求程序性能。越高级的性能优化手段越容易出现问题。在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能。