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

简介

什么是高质量——编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码

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

编程原则

• 实际应用场景千变万化,各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的

简单性

• 消除“多余的复杂性”，以简单清晰的逻辑编写代码。
• 不理解的代码无法修复改进

可读性

• 代码是写给人看的，而不是机器
• 编写可维护代码的第一步是确保代码可读

生产力

• 团队整体工作效率非常重要

编码规范

如何编写高质量的Go代码

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

代码格式

gofmt

• Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格常见IDE都支持方便的配置

注释

注释应该做的

• 注释应该解释代码作用
• 注释应该解释代码如何做的
• 注释应该解释代码实现的原因
• 注释应该解释代码什么情况会出错

小结

• 代码是最好的注释
• 注释应该提供代码未表达出的上下文信息

命名规范

• variable简洁胜于冗长

• 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写

  • 例如使用ServeHTTP而不是ServeHttp
  • 使用XMLHTTPRequest或者xmlHTTPRequest

• 变量距离其被使用的地方越远，则需要携带越多的上下文信息

• 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

function

• 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
• 函数名尽量简短
• 当名为foo 的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
• 当名为foo的包某个函数返回类型T时(T并不是Foo)，可以在函数名中加入类型信息

package

• 只由小写字母组成。不包含大写字母和下划线等字符

• 简短并包含一定的上下文信息。例如schema、task 等

• 不要与标准库同名。例如不要使用sync 或者strings

• 以下规则尽量满足，以标准库包名为例

  • 不使用常用变量名作为包名。例如使用bufio而不是 buf
  • 使用单数而不是复数。例如使用encoding而不是encodings
  • 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比 format更加简短

控制流程

尽量保持正常代码路径为最小缩进

• 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
• 最常见的正常流程的路径被嵌套在两个if条件内
• 成功的退出条件是return nil，必须仔细匹配大括号来发现
• 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误
• 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套

小结

• 线性原理,处理逻辑尽量走直线，避免复杂的嵌套分支
• 正常流程代码沿着屏幕向下移动
• 提升代码可维护性和可读性
• 故障问题大多出现在复杂的条件语句和循环语句中

错误和异常处理

简单错误

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

错误的 Wrap 和 Unwrap

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

错误判定

• 判定一个错误是否为特定错误，使用errors.ls
• 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
• 在错误链上获取特定种类的错误，使用errors.As

panic

• 不建议在业务代码中使用panic
• 调用函数不包含recover 会造成程序崩溃
• 若问题可以被屏蔽或解决，建议使用error代替 panic
• 当程序启动阶段发生不可逆转的错误时,可以在init 或 main函数中使用panic

recover

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

小结

• error尽可能提供简明的上下文信息链，方便定位问题
• panic用于真正异常的情况
• recover生效范围，在当前goroutine 的被defer的函数中生效

性能优化

简介

• 性能优化的前提是满足正确可靠、简洁清晰等质量因素
• 性能优化是综合评估，有时候时间效率和空间效率可能对立。
• 针对Go语言特性，介绍Go相关的性能优化建议

Benchmark

Slice

• 切片本质是一个数组片段的描述

  • 包括数组指针
  • 片段的长度
  • 片段的容量(不改变内存分配情况下的最大长度)

• 切片操作并不复制切片指向的元素

• 创建一个新的切片会复用原来切片的底层数组

另一个陷阱:大内存未释放

• 在已有切片基础上创建切片，不会创建新的底层数组。

• 场景

  • 原切片较大，代码在原切片基础上新建小切片
  • 原底层数组在内存中有引用，得不到释放

• 可使用copy替代 re-slice

map

分析

• 不断向map中添加元素的操作会触发map 的扩容提前分配好空间
• 可以减少内存拷贝和 Rehash的消耗
• 建议根据实际需求提前预估好需要的空间

strings.Builder

使用strings.Builder

• 使用＋拼接性能最差，strings.Builder，bytes.Buffer 相近，strings.Buffer 更快

分析

• 字符串在Go语言中是不可变类型，占用内存大小是固定的
• 使用＋每次都会重新分配内存
• strings.Builder，bytes.Buffer底层都是 []byte 数组
• 内存扩容策略，不需要每次拼接重新分配内存

空结构体

使用空结构体节省内存

• 空结构体struct实例不占据任何的内存空间
• 可作为各种场景下的占位符使用
• 节省资源
• 空结构体本身具备很强的语义，即这里不需要
• 任何值，仅作为占位符

atomic包

使用atomic包

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

性能

性能调优原则

• 要依靠数据不是猜测
• 要定位最大瓶颈而不是细枝末节
• 不要过早优化
• 不要过度优化

性能分析工具 pprof

• 希望知道应用在什么地方耗费了多少CPU、Memory
• pprof 是用于可视化和分析性能分析数据的工具
• pprof 功能简介
• pprof 排查实战
• pprof 的采样过程和原理

flat cum的区别

• Flat == Cum，函数中没有调用其他函数
• Flat == 0，函数中只有其他函数的调用

性能分析工具 pprof-采样过程和原理

CPU

• 采样对象:函数调用和它们占用的时间采样率:100次/秒，固定值
• 采样时间:从手动启动到手动结束

HEAP

• 采样程序通过内存分配器在堆上分配和释放的内存，记录分配/释放的大小和数量
• 采样率:每分配512KB记录一次，可在运行开头修改，1为每次分配均记录
• 采样时间:从程序运行开始到采样时
• 采样指标: alloc_space, alloc_objects, inuse_space, inuse_objects
• 计算方式: inuse = alloc - free

Goroutine-协程& ThreadCreate-线程创建

Block-阻塞& Mutex-锁

小结

• 掌握常用pprof工具功能
• 灵活运用pprof工具分析解决性能问题。
• 了解 pprof的采样过程和工作原理

2.3性能调优案例>简介

• 介绍实际业务服务性能优化的案例
• 对逻辑相对复杂的程序如何进行性能调优
• 业务服务优化
• 基础库优化
• Go语言优化

业务优化

流程

• 建立服务性能评估手段
• 分析性能数据，定位性能瓶颈
• 重点优化项改造
• 优化效果验证

建立服务性能评估手段

• 服务性能评估方式

  • 单独benchmark无法满足复杂逻辑分析。
  • 不同负载情况下性能表现差异

• 请求流量构造

  • 不同请求参数覆盖逻辑不同
  • 线上真实流量情况

• 压测范围

  • 单机器压测
  • 集群压测

• 性能数据采集

  • 单机性能数据
  • 集群性能数据

总结

• 性能调优原则

  • 要依靠数据不是猜测。

• 性能分析工具 pprof

  • 熟练使用pprof工具排查性能问题并了解其基本原理

• 性能调优

  • 保证正确性。
  • 定位主要瓶颈