这是我参与「第三届青训营 -后端场」笔记创作活动的第1篇笔记
编码规范
高质量代码的定义：编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
代码格式：
推荐使用gofmt自动格式化代码
gofmt：Go语言官方提供的工具，能自动格式化Go 语言代码为官方统一风格常见IDE都支持方便的配置
goimports：也是Go语言官方提供的工具实际等于gofmt 加上依赖包管理自动增删依赖的包引用、将依赖包按字母序排序并分类
我用的是idea 所以这两的安装如下： 插件下载File Watchers 然后在setting里面找到 点击+号即可 goimports因为被墙了，需要通过其他方式去下载
注释
注释应该做的
-
注释应该解释代码作用
-
适合注释公共符号
- 包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
- 有一个例外，不需要注释实现接口的方法。具体不要像下面这样做
-
-
注释应该解释代码如何做的
- 适合注释实现过程
-
注释应该解释代码实现的原因
- 适合解释代码的外部因素
- 提供额外上下文
-
注释应该解释代码什么情况会出错
- 适合解释代码的限制条件
命名规范
variable
-
简洁胜于冗长
-
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写 。例如：
- 使用ServeHTTP而不是ServeHttp
- 使用XMLHTTPRequest或者xmlHTTPRequest
-
变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
function
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的函数名尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时（T并不是Foo)，可以在函数名中加入类型信息
package
- 只由小写字母组成。
- 不包含大写字母和下划线等字符简短并包含一定的上下文信息。例如schema. task等
- 不要与标准库同名。例如不要使用sync或者strings
控制流程
- 避免嵌套，保持正常流程清晰
- 尽量保持正常代码路径为最小缩进
小结：
- 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支
- 正常流程代码沿着屏幕向下移动
- 提升代码可维护性和可读性
- 故障问题大多出现在复杂的条件语句和循环语句中
错误和异常处理
简单错误
- 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用errors.New来创建匿名变量来直接表示简单错误
- 如果有格式化的需求，使用fmt.Errorf
错误的Wrap 和 Unwrap
- 错误的 Wrap 实际上是提供了一个error 嵌套另一个error的能力，从而生成一个error的跟踪链
- 在fmt.Errorf中使用:%ow关键字来将一个错误关联至错误链中
错误判定
- 判定一个错误是否为特定错误，使用errors.ls
- 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
panic
- 不建议在业务代码中使用panic
- 调用函数不包含recover会造成程序崩溃
- 若问题可以被屏蔽或解决，建议使用error代替panic
- 当程序启动阶段发生不可逆转的错误时，可以在 init或main函数中使用panic
recover
- recover 只能在被defer 的函数中使用
- 嵌套无法生效
- 只在当前goroutine生效
- defer的语句是后进先出
- 如果需要更多的上下文信息，可以recover后在 log 中记录当前的调用栈
性能优化后面再补了
