四、高质量编程简介及编码规范
1.1什么是高质量
编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理
- 易读易维护
编程原则
实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的
简单性
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
可读性
- 代码是写给人看的，而不是机器
- 编写可维护的代码的第一步是确保代码可靠
生产力
- 团队整体工作效率非常重要
1.2编码规范
如何编写高质量的Go代码
- 代码格式
- 注释
- 命名规范
- 控制流程
- 错误和异常处理
可以使用gofmt自动格式化代码
gofmt：Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格，常见IDE都支持方便配制 goimports：也是Go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包的引用、将依赖包按字母序排序并分类
1.3编码规范-注释
- 注释应该做的
- 注释应该解释代码作用
- 注释应该解释代码如何做的.
- 注释应该解释代码实现的原因.
- 注释应该解释代码什么情况会出错
小结
- 代码是最好的注释
- 注释应该提供代码未表达出的上下文信息
1.4编码规范命名规范
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用ServeHTTP而不是ServeHttp
- 使用XMLHTTPRequest或者xmlHTTPRequest
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
小结
- 核心目标是降低阅读理解代码的成本，重点考虑上下文信息，设计简洁清晰的名称
1.5 编码规范-控制流程
-
避免嵌套，保持正常流程清晰
-
尽量保持正常代码路径为最小缩进
- 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
-
尽量保持正常代码路径为最小缩进
小结
- 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
- 正常流程代码沿着屏幕向下移动
- 提升代码可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
1.6编码规范错误和异常处理
简单错误
- 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用errors.New来创建匿名变量来直接表示简单错误
- 如果有格式化的需求，使用fmt.Errorf
错误的Wrap和Unwrap
-
错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
-
在fmt. Errorf中使用: %w关键字来将一个错误关联至错误链中
错误判定
- 判定一个错误是否为特定错误，使用errors.Is
- 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
- 在错误链上获取特定种类的错误，使用errors.As
panic
- 不建议在业务代码中使用panic
- 调用函数不包含recover会造成程序崩溃
- 若问题可以被屏蔽或解决，建议使用error代替panic
- 当程序启动阶段发生不可逆转的错误时，可以在init 或main函数中使用panic
recover
- recover只能在被defer的函数中使用嵌套无法生效
- 只在当前goroutine生效
- defer的语句是后进先出
- 如果需要更多的上下文信息，可以recover后在log中记录当前的调用栈
小结
- error尽可能提供简明的上下文信息链，方便定位问题panic用于真正异常的情况
- recover生效范围，在当前goroutine 的被defer的函数中生效
