这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
编程原则
-
简单性
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
-
可读性
- 代码是写给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读
-
生产力
- 团队整体工作效率非常重要
代码格式
gofmt
Go 语言官方提供的工具，能自动格式化 Go 语言代码为官方统一风格
常见 IDE 都支持方便的配置
goimports
也是 Go 语言官方提供的工具
实际等于 gofmt 加上依赖包管理
自动增删依赖的包引用、将依赖包按字母序排序并分类
注释
公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
- 但有一个例外，不需要注释实现接口的方法
命名规范
变量命名
-
简洁胜于冗长
-
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用 ServeHTTP 而不是 ServeHttp
- 使用 XMLHTTPRequest 或者 xmlHTTPRequest
-
变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
函数命名
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
- 当名为 foo 的包某个函数返回类型 T 时 (T 并不是 Foo)，可以在函数名中加入类型信息
包命名
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如 schema、task 等
- 不要与标准库同名。例如不要使用 sync 或者 strings
以下规则尽量满足，以标准库包名为例
- 不使用常用变量名作为包名。例如使用 bufio 而不是 buf
- 使用单数而不是复数。例如使用 encoding 而不是 encodings
- 谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短
控制流程
避免 if-else 嵌套
尽量保持正常代码路径为最小缩进
错误和异常处理
复杂错误使用 %w 在 fmt.Errorf 关联错误链
使用 errors.Is 判定错误，其与 == 不同的是该方法可以判定错误链上的所有错误是否含有特定的错误
使用 error.As 获取错误链上特定种类的错误
不建议在业务代码中使用 panic
recover 只在当前 goroutine 有效
性能优化建议
基准性能测试 -> benchmem 工具
go test -bench=. -benchmem
Slice
slice 预分配内存
原数组较大，代码在原切片新建小切片时建议使用 copy 代替 re-slice 避免原底层数组在内存中有引用得不到释放的情况
Map
map 预分配内存
字符串处理
使用 strings.Builder 并使用 Grow 方法预分配内存
使用空结构体节省内存
atomic 包
性能优化分析工具 pprof
# 以命令行方式查看
go tool pprof "http://localhost:6060/debug/pprof/profile?seconds=10"
(pprof) top
list 函数名
# 以 web 方式查看
# 注意需安装 graphviz，教程见：https://blog.csdn.net/qq_43750528/article/details/127213064
go tool pprof -http=:8080 "http://localhost:6060/debug/pprof/goroutine"
