这是我参与「第五届青训营 」伴学笔记创作活动的第3天。
一、本堂课重点内容：
- 如何编写更简洁清晰的代码
- 常用Go语言程序优化手段
- 熟悉Go程序性能分析工具
- 了解工程中性能优化的原则和流程
二、详细知识点介绍：
- 高质量编程
1.1 简介
- 编写代码能够达到正确可靠，简洁清晰的目标
- 边界条件完备、异常情况处理、易读易维护...
- 通用原则
- 简单性：简单清晰的程序逻辑
- 可读性：代码是写给别人看的，编写可维护的代码
- 生产力：团队整体工作效率
1.2 编码规范
- 如何编写高质量的Go代码
1.2.1 代码格式
- 使用gofmt自动格式化代码
- goimports 自动增删依赖包
1.2.2 注释
- 公共符号始终要注释
- 包中声明的每个公共的符号、变量、常量、函数以及结构都需要加注释
- 任何不明显也不简短的公共功能也必须注释
- 库中的任何函数都必须注释
- 不需要注释实现接口的方法
- 注释要提供代码未表达出的上下文信息
1.2.3 命名规范
- variable
- 简洁
- 缩略词全大写，位于开头且不需要导出时，全小写(ServeHTTP、xmlHTTPRequest)
- 变量距离其被使用的地方越远，包含越多的上下文信息
- function
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现
- 函数名尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时，可以加入类型信息
- package
- 只由小写字母组成
- 简短并包含上下文信息
- 不与标准库同名
- （以下规则尽量满足）不使用常用变量名作为包名
- 使用单数而不是复数
- 谨慎地使用缩写
1.2.4 控制流程
- 避免嵌套
- 尽量保持正常代码路径为最小缩进
- 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
1.2.5 错误和异常处理
-
简单错误
- 简单错误是仅出现一次的错误，在其他地方不需要捕获
- 优先使用errors.New来创建匿名变量来直接表示简单错误
- 如果有格式化的需求，使用fmt.Errorf
-
复杂错误
- 错误的Wrap是提供了一个error嵌套另一个error的能力，生成一个error的跟踪链
- 在fmt.Errorf中使用%w关键字来将一个错误关联至错误链中
-
错误判定
- 判断一个错误是否为特定错误，使用error.Is
- 不同于使用==，使用该方法可以判定错误链上所有错误是否含有特定的错误
- 在错误链上获取特定种类的错误，使用error.As
-
错误和异常处理
- panic
- 不建议在业务代码中使用panic
- 调用函数不包含recover会造成程序崩溃
- 若问题可以被屏蔽或解决，直接使用error
- 当程序启动阶段发生不可逆转的错误 时，可以在init或者main函数中使用panic
- recover
- 只能在被defer的函数中使用
- 嵌套无法生效
- 只在当前goroutine生效
- defer语句是后进先出
- 如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈
- panic
1.3 性能优化建议
1.3.1 Benchmark
- 性能表现需要实际数据衡量
- Go语言提供了支持基准性能测试的benchmark工具
1.3.2 Slice
- slice预分配内存
- 尽可能在使用make()初始化切片时提供容量信息
- 切片操作不复制切片指向的元素
- 一个新的切片会服用原来切片的底层数组
- 陷阱：大内存未释放
- 大数组创建小切片，大数组内存未释放
- 可使用copy替代re-slice
1.3.3 Map
- map预分配内存
- 减少内存拷贝和rehash的消耗
- 预估需要的空间
1.3.4 字符串处理
- 使用string.Builder
- 使用+拼接性能最差，string.Buffer、string.Builder相近
- +会重新分配内存
- string.Buffer、string.Builder底层都是[]byte数组
1.3.5 空结构体
- 不占据任何内存空间
- 可作为各种场景下的占位符使用
1.3.6 atomic包
- atomic操作是通过硬件实现，效率比较高
- sync.Mutex应该用来保护一段逻辑，不仅仅用于保护一个变量
三、课后个人总结：
本次课程主要介绍了如何编写更简洁清晰的代码，从常用Go语言程序优化手段、Go程序性能分析工具、以及实际程中性能优化的原则和流程等角度出发。学习到很多高质量编程及性能优化的小技巧。
