- 如何编写更简洁清晰的代码
- 常用Go语言程序优化手段
- 熟悉Go语言性能分析工具
- 了解工程中性能优化的原则和流程
高质量
编写的代码能够达到正确可靠,简洁清晰的目标可称为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理,稳定性保证
- 易读易维护
编程原则: 实际应用场景千变万化,各种语言的特性和语法各不相同 但是高质量编程遵循的原则是相通的
简单性
- 消除“多余的复杂性”,以清晰的逻辑编写代码
- 不理解的代码无法修复改进
可读性
- 代码是给人看的,而不是机器
- 编写可维护的代码的第一步是确保代码可读
生产力
- 团队整体工作效率非常重要
如何编写高质量的Go代码
代码格式 推荐使用gofmt自动格式化代码
注释
注释应该解释代码的作用
- 适合注释公共符号
注释应该解释代码如何做的
- 适合注释实现过程
注释应该解释代码实现的原因
- 适合解释代码的外部因素
- 提供额外上下文
注释应该解释代码什么情况会出错
- 适合解释代码的限制条件
命名规范
-----------variable----------
简洁胜于冗长 缩略词全大写,但当其位于变量开头且不需要导出时,全使用小写 变量距离其被使用的地方越远,则需要携带更多的上下文信息
----------function---------- 函数名不携带包名的上下文信息,因为包名和函数名总是成对出现的 函数名尽量简短 当名为foo的包某个函数返回类型Foo时,可以省略类型信息而不导致歧义 当名为foo的包某个函数返回类型T时(T并不是Foo),可以在函数名中加入类型信息
----------package---------- 只由小写字母组成,不包含大写字母和下划线 简短并包含一定的上下文信息 不要与标准库同名 不适用常用变量名作为包名 使用单数而不是复数 谨慎地使用缩写
控制流程
避免嵌套,保持正常流程清晰 尽量保持正常代码路径为最小缩进
错误和异常处理
简单错误 简单的错误的是仅出现一次的错误,且在其他地方不需要捕获该错误 优先使用errors.New来创建匿名变量来直接表示简单错误 如果有格式化的需求,使用fmt.Errorf
错误的Wrap和Unwrap 错误的Wrap实际上是提供了一个error嵌套另一个error的能力 从而生成一个error的追踪链 在fmt.Errorf中使用:%w关键字来将一个错误关联至错误链中
panic 不建议在业务中使用panic 调用函数不包含recover会造成程序崩溃 若问题可以被屏蔽或解决,建议使用error代替panic 当程序启动阶段发生不可逆转的错误时,可以在init或main函数中使用panic