这是我参与「第五届青训营 」伴学笔记创作活动的第 6 天
高质量编程
编程原则:简单性、可读性、生产力
编码规范
- 代码格式:推荐使用gofmt自动格式化代码,goimports--依赖包
- 注释:公共符号始终要注释,需要解释代码是如何做的,为什么这么做,在什么情况下会出错。代码是最好的注释,注释应该提供代码未表达出的上下文信息。
- 命名规范:
- 变量--缩略词全大写,但当期位于变量开头且不需要导出时,使用全小写
- 函数名不携带报名的上下文信息
- 包名只用小写字母,不与标准库同名,简短并且包含一定的上下文信息,使用单数。
- 控制流程:避免嵌套,保证正常流程清晰;尽量保持正常代码路径为最小缩进(优先处理错误、特殊情况);线性原理,处理逻辑尽量走直线。
- 错误和异常处理:
- 简单错误:仅出现一次的错误,且其他地方不需要捕获。优先使用errors.New来创建匿名变量直接表示简单错误。如果有格式化要求使用fmt.Errorf
- 错误的Wrap和Unwarp:错误的Wrap实际上是提供里一个error嵌套另一个error的能力,从而生成一个error的跟踪链。再fmt.Errorf中使用%w来将一个错误关联至错误链中
- 错误判定:error.Is;再错误链上获取特定种类的错误--error.As
- panic:不建议再业务代码中使用panic,当程序启动阶段发生不可逆转的错误时,可以再init或main函数中使用panic
- recover:只能在被defer的函数中使用,嵌套无法生效,只能在当前goroutine生成,defer语句是后进先出。
性能调优实战
建议
- Go语言提供了支持基准性能测试的benchmark工具
go test -bench=. -benchmem
- silce 预分配内存 尽可能在使用make()初始化切片时提供容量信息
在已有切片基础上创建切片,不会创建新的底层数组,可使用copy替代re-slice
-
map 预分配内存
-
使用strings.Builder, bytes.Buffer性能相近,strings.Builder更快,使用+拼接性能最差
-
使用空结构体struct{}节省内存(不占据任何的内存空间),实现Set可以考虑用map来代替,只需要用到map的键而不需要值。
-
如何使用atomic包。atomic操作是通过硬件实现,效率比锁高。锁的实现是通过操作系统来实现的,属于系统调用。对于非数值操作,可以使用atomic.Value,能承载一个interface{}
工具pprof
pprof是用于可视化和分析性能、数据的工具
浏览器查看指标:http://localhost:6060/debug/pprof/
- CPU:go tool pprof "http://localhost:6060/debug/pprof/profile?seconds=10"
- top:查看占用资源最多的函数(flat -- 当前函数本身的执行耗时,flat% -- flat占CPU总时间的比例,sum% -- 上面每一行的flat%总和,cum -- 当前函数本身加上其调用函数的总耗时
- list <具体函数名>:根据指定的正则表达式查找代码行
- web:调用关系可视化
采样对象:函数调用和它们占用的时间 采样率:100次/秒 2. 排查堆内存问题:go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/heap"
采样程序通过内存分配器在堆上分配和释放的内存,记录分配/释放的大小和数量:inuse = alloc - free
- 排查协程问题:go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/goroutine"
threadGreate:记录程序创建的所有系统线程的信息
- 排查mutex-锁问题:go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/mutex"
采样率:只记录固定比例的锁操作,1为每次枷锁均记录
- 排查block-阻塞问题:go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/block"
采样阻塞操作的次数和耗时。 采样率:阻塞耗时超过阈值的才会被记录