这是我参与「第三届青训营 -后端场」笔记创作活动的的第3篇笔记
- 高质量编程
- 编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
- 编程原则
- 简单性
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
- 可读性
- 代码是给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读
- 生产力
- 团队整体工作效率非常重要
- 简单性
- 编码规范
- 代码格式
- 推荐使用gofmt自动格式化代码
- gofmt：Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格
- goimports:Go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母序排序并分类
- 注释
- 注释应该做的
- 解释代码作用：注释公共符号
- 解释代码如何做的：注释实现过程
- 解释代码实现的原因：解释代码的外部因素，提供额外上下文
- 解释代码什么情况会出错：解释代码的限制条件
- 公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
- 命名规范
- 变量
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- ServerHTTP
- xmlHTTPRequest
- 变量距离其被使用的地方越远，需要携带越多的上下文信息
- 函数
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现
- 函数名尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时，可以在函数名中加入类型信息
- 包
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如schema、task等
- 不要与标准库同名。例如不要使用sync或strings
- 不使用常用变量名作为包名。例如使用bufio而不是buf
- 使用单数而不是复数
- 谨慎使用缩写
- 控制流程
- 避免嵌套，保持正常流程清晰
- 如果两个分支中都包含return语句，则可以去除冗余的else
- 尽量保持正常代码路径为最小缩进
- 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
func OneFunc() error{ if err := doSomething(); err != nil{ return err } if err := doAnotherTing(); err != nil{ return err } return nil //normal case } - 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
- 正常流程代码沿着屏幕向下移动
- 提升代码可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
- 避免嵌套，保持正常流程清晰
- 错误和异常处理
- 简单错误：仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用errors.New来创建匿名变量直接表示简单错误
- 如果有格式化需求，使用fmt.Errorf
- 错误的Wrap和Unwrap
- 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成error的跟踪链
- 在fmt.Errorf中使用:%w关键字来将一个错误关联到错误链中
- 错误判定
- 判定一个错误是否为特定错误，使用errors.Is
- 不同于使用==，使用该方法可以判定错误链上所有错误是否含有特定错误
- 在错误链上获取特定种类的错误，使用errors.As
- panic
- 不建议在业务代码中使用panic
- 调用函数不包含recover会造成程序崩溃
- 若问题可以被屏蔽或解决，建议使用error代替panic
- 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic
- recover
- recover只能在被defer的函数中使用
- 嵌套无法生效
- 只在当前goroutine生效
- defer的语句是后进先出
- 如果需要更多的上下文信息，可以recover后在log中记录当前调用栈
- 简单错误：仅出现一次的错误，且在其他地方不需要捕获该错误
- 变量
- 注释应该做的
- 代码格式
- 编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码
- 性能优化
- Benchmark
go test -bench=. -benchmen - 性能优化建议
slice预分配内存- 尽可能在使用
make()初始化切片时提供容量信息
- 切片本质是一个数组片段的描述，包括数组指针、片段长度以及片段容量
- 切片操作并不复制切片指向的元素
- 创建一个新的切片会复用原来切片的底层数组
- 另一个陷阱：大内存未释放
- 在已有切片基础上创建切片，不会创建新的底层数组
- 场景：原切片较大，代码在原切片基础上新建小切片
- 原底层数组在内存中有引用，得不到释放
- 可使用
copy替代re-slice
map预分配内存- 不断向map中添加元素的操作会触发map的扩容
- 提前分配好空间可以减少内存拷贝和Rehash的消耗
- 建议根据实际需求提前预估好需要的空间
- 字符串处理
- 使用
+拼接性能最差，strings.Builder,bytes.Buffer相近，strings.Builder更快- 字符串在Go语言中是不可变类型，占用内存大小是固定的
- 使用
+每次都会重新分配内存 strings.Builder,bytes.Buffer底层都是[]byte数组bytes.Buffer转化为字符串时重新申请了一块空间strings.Builder直接将底层的[]byte转换成了字符串类型返回- 内存扩容策略，不需要每次拼接重新分配内存
- 使用
strings.Builder进行字符串拼接
- 使用
- 空结构体
- 使用空结构体节省内存
- 空结构体struct{}实例不占据任何内存空间
- 可作为各种场景下的占位符使用
- 节省资源
- 空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符
- 实现Set，可以考虑用map来代替
- 对于这个场景，只需要用到map的键，而不需要值
- 即使是将map的值设置为bool类型，也会多占据1个字节空间
- 使用空结构体节省内存
- atomic包
- 锁的实现是通过操作系统来实现，属于系统调用
- atomic操作是通过硬件实现，效率比锁高
- sync.Mutex应该用来保护一段逻辑，不仅仅用于保护一个变量
- 对于非数值操作，可以使用atomic.Value，能承载一个interface{}
- Benchmark
- 性能调优实战
- 性能调优原则
- 要依靠数据不是猜测
- 要定位最大瓶颈而不是细枝末节
- 不要过早优化
- 不要过度优化
- 性能分析工具pprof：用于可视化和分析性能数据的工具
- 火焰图
- 从上到下表示调用顺序
- 每一块代表一个函数，越长代表占用CPU时间越长
- 火焰图是动态的，支持点击块进行分析
- 采样过程与原理
- CPU
- 采样对象：函数调用和它们占用的时间
- 采样率：100次/s，固定值
- 采样时间：从手动启动到手动结束
- Heap/堆内存
- 采样程序通过内存分配器在堆上分配和释放的内存，记录分配/释放的大小和数量
- 采样率：每分配512kb记录一次，可在运行开头修改，1为每次分配均记录
- 采样时间：从程序运行开始到采样时
- 采样指标：alloc_space,alloc_objects,inuse_space,inuse_objects
- 计算方式：inuse = alloc-free
- Groutine
- 记录所有用户发起且在运行中的goroutine runtime.main的调用栈信息
- ThreadCreate
- 记录程序创建的所有系统线程信息
- 阻塞
- 采样阻塞操作的次数和耗时
- 采样率：阻塞耗时超过阈值的才会被记录，1为每次阻塞均记录
- 锁
- 采样争抢锁的次数和耗时
- 采样率：只记录固定比例的锁操作，1为每次加锁均记录
- CPU
- 火焰图
- 性能调优案例
- 业务服务优化
- 服务：能单独部署，承载一定功能的程序
- 依赖：Service A的功能实现依赖Service B的响应结果，称为Service A依赖Service B
- 调用链路：能支持一个接口请求的相关服务集合及其相互之间的依赖关系
- 基础库：公共的工具包、中间件
- 基础库优化
- AB实验SDK的优化
- 分析基础库核心逻辑和性能瓶颈
- 设计完善改造方案
- 数据按需获取
- 数据序列化协议优化
- 内部压测验证
- 推广业务服务落地验证
- 分析基础库核心逻辑和性能瓶颈
- AB实验SDK的优化
- Go语言优化
- 编译器&运行时优化
- 优化内存分配策略
- 优化代码编译流程，生成更高效的程序
- 内部压测验证
- 推广业务服务落地验证
- 优点
-
接入简单，只需要调整编译配置
-
通用性强
-
- 编译器&运行时优化
- 业务服务优化
- 性能调优原则
