这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
高质量编程
高质量编程简介
什么是高质量的编程
- 各种边界条件考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
编程原则：
- 简单性：简单清晰的逻辑
- 可读性：编写可维护的代码的第一步是确保代码可读
- 生产力：团队整体的工作效率非常高
编码规范
代码格式
使用gofmt自动格式化代码。 使用goimports来格式化引入的包
- gofmt：官方提供的工具，能自动格式化Go语言为官方同一风格
- goimports：官方提供的工具，自动增删依赖的包引用，将依赖包按字母排序并分类
注释
注释的作用：
- 注释应该解释代码作用
- 适合注释公共符号
- 注释应该解释代码如何做的
- 适合注释实现过程
- 注释应该解释代码实现的原因
- 适合解释代码的外部因素
- 提供额外的上下文
- 注释应该解释代码什么情况下会出错
- 适合解释代码的限制条件
- 公共符号始终要注释
- 例外：不需要注释实现接口的方法
- 对于公共符号都有注释说明
- 需明确易混淆的结构的作用
代码是最好的注释
注释应提供代码未表达的上下文信息
命名规范
- 简介胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用
ServeHTTP而不是ServeHttp - 使用
XMLHTTPRequest或者xmlHTTPRequest
- 例如使用
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，是的在不同地方可以轻易辨认出其含义。
注意变量名所携带的信息量和作用域范围，将方法函数的名称和其包的名称相互配合好，使包的信息可以为变量或者函数的命名提供额外信息来表明作用，而不是在变量和函数处重复包的名称造成冗余。
- package
- 只由小写字母组成，不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息
- 不要与标准库同名，如不要用sync和strings
- 规则尽量满足，以标准库包名为例
- 不适用常用变量名作为包名
- 使用单数而不是复数
- 谨慎使用缩写，在不破坏上下文的情况下可以适当使用缩写
控制流程
- 避免嵌套，保持正常流程清晰
- 尽量保持正常代码路径为最小缩进
- 优先处理错误情况、特殊情况，尽早返回或继续循环来减少嵌套
主要的规则
- 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
- 正常流程代码沿着屏幕向下移动
- 提升代码可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
错误和异常处理
简单错误
- 简单错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用
errors.New来创建匿名变量来直接表示简单错误 - 如果有格式化的需求，使用fmt。Errorf
错误的Wrap和Unwrap
- 错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
- 在fmt.Errorf中使用：%w关键字来将一个错误关联至错误链中
错误判定
- 判定一个错误是否为特定错误，使用
errors.Is - 不同于使用
==，使用该方法可以判定错误链上所有错误是否含有特定的错误 - 在错误链上获取特定种类的错误，使用
errors.As
panic
- 不建议在业务代码中使用panic
- 调用函数不包含recover会造成程序崩溃
- 若问题被屏蔽或解决，建议使用erros代替panic
- 当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic
recover
- recover只能在被defer的函数中使用
- 嵌套无法使用
- 只在当前的goroutine中生效
- defer的语句是后进先出
- 如果许哟啊更多的上下文，可以recover后在log中巨鹿当前的调用栈
未完待续......
