这是我参与「第五届青训营」伴学笔记的第3天
高质量编程
简介
- 边界条件是否完备
- 异常情况处理---->稳定性保证
- 易读易维护
编程原则：
- 简单性：以简单清晰的逻辑编写代码
- 可读性
- 生产力
编码规范
代码格式
推荐使用gofmt自动格式化代码
注释
注释应该做的：
- 解释代码作用
- 解释代码如何做的--->适合注释实现过程
- 解释代码实现的原因--->提供额外上下文
- 解释代码什么情况会出错--->解释限制条件
公共符号始终要注释：
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要注释
- 任何既不明显也不简短的公共功能必须注释
- 库中的任何函数都必须注释
命名规范
变量命名
- 简洁胜于冗长
- 缩略词全大写，但其位于变量开头且不需要导出时，使用全小写
- 变量距离其被使用的地方越远，则需要携带的上下文信息更多
函数命名
- 函数名不携带包名的上下文信息
- 函数名尽量简短
- 当某个函数返回类型和包名一样，可以省略类型信息而不导致歧义；若不一样，要带上类型信息
包命名
- 只有小写字母组成
- 简短并包含一定的上下文信息
- 不要与标准库同名
控制流程
- 避免嵌套和冗余，保持正常流程清晰
- 尽量保持正常代码路径为最小缩进：优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
错误和异常处理
- 简单错误：指仅出现一次的错误，且在其他地方不需要捕获该错误；优先使用errors.New来创建匿名变量来直接表示简单错误；格式化需求用fmt.Errorf
- 错误的Wrap和Unwrap：错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链；在fmt.error中使用%w来将该错误关联到错误链中
- 错误判定：判定一个错误是否为特定错误，使用errors.ls；在错误链中获取特定种类的错误，使用errors.As
- panic：不建议在业务代码中使用panic，当程序启动阶段发生不可逆时，可以在init或main函数中添加panic
- recover：只能在被defer的函数中使用，嵌套无法生效，旨在当前goroutine生效，defer是后进先出
性能调优实战
简介
- 性能优化的前提是满足正确可靠、简洁清晰等质量因素
- 性能优化是综合评估，时间效率和空间综合考量
- 针对go语言特性，介绍go相关的性能优化建议
性能优化建议
- 使用工具Benchmark测试性能，并根据性能来进行性能优化
- slice预分配内存：尽可能在使用make（）初始化切片时提供容量信息；在已有切片基础上创建切片，不会创建新的底层数组，那么原底层数组在内存中有引用，得不到释放，可使用copy代替re-slice
- map预分配内存
- 使用strings.Builder来处理字符串拼接---->var builder strings.Builder； builder.WriteString(str)
- 使用空结构体节省内存--->实现Set，可以考虑用map来代替，对于这个场景，只需要用到map的键，而不需要用到值
- 如何使用atomic包而不是使用锁来保护一个变量（ps：锁可以用来保护一段逻辑）
性能调优实战
原则
- 要依靠数据而不是猜测
- 要定位最大瓶颈而不是细枝末节
- 不要过早优化
- 不要过度优化
性能分析工具 pprof
pprof是用于可视化和分析性能分析数据的工具
pprof功能简介
采样过程和原理
- CPU
- 采样对象：函数调用和它们占用的时间
- 采样率：100次/秒，固定值
- 采样时间：从手动启动到手动结束
- Heap-堆内存
- 采样对象：通过内存分配器在堆上分配和释放的内存
- 采样率：每分配512KB记录一次，可在运行开头修改
- 采样时间：从程序运行开始到采样时
- 计算方式：当前使用内存 = 已分配内存 - 空闲内存
- Goroutine-协程 & ThreadCreate-线程创建
- Goroutine：记录所有用户发起且运行中的goroutine（即入口非runtime开头的）
- ThreadCreate:记录程序创建的所有系统线程的信息
- Block & Mutex
- 阻塞操作：采样阻塞操作的次数和耗时（阻塞耗时超过阈值的才会被记录）
- 锁竞争：采样争抢锁的次数和耗时（只记录固定比例的锁操作）
性能调优案例
- 业务服务优化
- 建立服务性能评估手段
- 分析性能数据，定位性能瓶颈
- 重点优化项改造
- 优化效果验证
- 基础库优化
- 分析基础库核心逻辑和性能瓶颈
- 数据按需获取
- 数据序列化协议优化
- Go语言优化
- 编译器&运行时优化
