这是我参与「第三届青训营 -后端场」笔记创作活动的的第4篇笔记。
1、高质量编程
编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码。
- 各种边界条件是否考虑完备
- 异常情况处理,稳定性保证
- 易读易维护
1.1 编程原则
实际应用场景千变万化,各种语言的特性和语法各不相同
但是高质量编程遵循的原则是相通的
-
简单性
- 消除多余的复杂性,以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
-
可读性
- 代码是写给人看的,而不是机器
- 编写可维护代码的第一步是确保代码可读
-
生产力
- 团队整体工作效率非常重要
1.2 编程规范
- 代码格式
- 注释
- 命名规范
- 控制流程
- 错误和异常处理
1.2.1 代码格式
推荐使用gofmt自动格式化代码
1.2.2 注释
- 代码是最好的注释
- 注释应该提供代码未表达出的上下文信息
1.2.3 命名规范
- 核心目标是降低阅读理解代码的成本
- 重点考虑上下文信息,设计简洁清晰的名称
1.2.4 控制流程
- 线性原理,处理逻辑尽量走直线,避免复杂的嵌套分支
- 正常流程代码沿着屏幕向下移动
- 提升代码可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
1.2.5 错误和异常处理
- error尽可能提供简明的上下文信息链,方便定位问题
- panic用于真正异常的情况
- recover生效范围,在当前goroutine的被defer的函数中生效
2、性能调优实战
2.1 性能优化建议
- 性能优化的前提是满足正确可靠、简洁清晰等质量因素
- 性能优化是综合评估,有时候时间效率和空间效率可能对立
- 针对Go语言特性,介绍Go相关的性能优化建议
2.1.1 字符串处理
使用 +拼接性能最差,strings.Builder, bytes.Buffer 相近,strings.Buffer更快
分析:
- 字符串在Go语言中是不可变类型,占用内存大小是固定的
- 使用+每次都会重新分配内存 strings.Builder,bytes.Buffer底层都是[]byte 数组
- 内存扩容策略,不需要每次拼接重新分配内存
stringbuilder会比bytebuffer更快一些的原因:
- bytes.Buffer转化为字符串时重新申请了一块空间
- strings.Builder 直接将底层的[]byte转换成了字符串类型返回
//拼接字符串
func Plus(n int,str string) string{
s := ""
for i := 0; i < n; i++ {
s += str
}
return s
}
//使用strings.Builder
func StrBuilder(n int,str string) string{
var build strings.Builder
for i := 0; i < n; i++ {
build.WriteString(str)
}
return build.String()
}
2.1.2 空结构体
使用空结构体节省内存
-
空结构体 struct好实例不占据任何的内存空间
-
可作为各种场景下的占位符使用
- 节省资源
- 空结构体本身具备很强的语义,即这里不需要 任何值,仅作为占位符
-
func EmptyStructMap(n int) { m := make(map[int]struct{}) for i:= 0; i < n; i++ { m[i] = struct{}{} } } func BoolMap(n int) { m := make(map[int]bool) for i:= 0; i < n; i++ { m[i] = false } }
2.1.3 Benchmark
go test -bench=. -benchmem
2.1.4 Slice
预分配内存
-
尽可能在使用make()初始化切片时提供容量信息
-
切片本质是一个数组片段的描述
- 包括数组指针
- 片段的长度
- 片段的容量(不改变内存分配情况下的最大长度)
-
切片操作并不复制切片指向的元素
-
创建一个新的切片会复用原来切片的底层数组
2.1.5 Map
预分配内存
- 不断向map中添加元素的操作会触发map的扩容
- 提前分配好空间可以减少内存拷贝和 Rehash 的消耗
- 建议根据实际需求提前预估好需要的空间
2.1.6 atomic包
- 锁的实现是通过操作系统来实现,属于系统调用
- atomic 操作是通过硬件实现,效率比锁高
- sync.Mutex应该用来保护一段逻辑,不仅仅用于保护一个变量
- 对于非数值操作,可以使用atomic.Value,能承载一个interface{}
小结
- 避免常见的性能陷阱可以保证大部分程序的性能
- 普通应用代码,不要一味地追求程序的性能
- 越高级的性能优化手段越容易出现问题
- 在满足正确可靠、简洁清晰的质量要求的前提下提高程序性能