这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
1.编程原则
实际应用场景千变万化,各种语言的特性和语法各不相同,但是高质量编程遵循的原则是相同的。
简单性
- 消除“多余的复杂性”,以简单清晰的逻辑编写代码。
- 不理解的代码无法修复改进
可读性
- 代码是写给人看的,而不是机器
- 编写可维护代码的第一步是确保代码可读
生产力
- 团队整体工作效率非常重要
2.代码规范
如何编写高质量的go代码?
注释
公共符号始终要注释
- 包中声明的每个公共的符号、变量、常量、函数以及结构都需要添加注释。
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何,对库中的任何函数都必须进行注释
注释应该做的事情
- 注释应该解释代码的作用
- 注释应该解释代码如何做的
- 注释应该解释代码实现的原因
- 注释应该解释代码在什么情况下会出错
- 公共符号始终要注释
代码格式
推荐使用gofmt进行格式化代码
- gofmt为go官方提供的工具,可以格式化代码为官方统一风格。
- goimports也是go官方提供的工具,实际上等于gofmt加上依赖包管理,自动增删依赖的包引用、将依赖包字母顺序排序分类。
命名规范
简洁胜于冗长
控制流程
优先处理异常/特殊情况
错误与异常处理
- 简单错误
- 复杂错误
- 错误对比判定
- panic
- 小结
3.性能优化
优化方式
- 预分配内存
- 切片
- 大内存未释放
- string.Builder
预分配
- 空结构体
- atomic包
- 小结
性能调优原则
pprof性能调优工具
pprof工具采样过程和原理
性能调优案例
- 业务服务优化