这是我参与「第五届青训营 」伴学笔记创作活动的第 6 天
重点内容：
编码规范
如何编写高质量的Go代码
-
代码格式
- 可以使用 gofmt 和 goimports 工具自动格式化代码。
- 对于 GoLand，可以在 Settings - Tools - Actions on Save 中打开 Reformat code 和 Optimize imports.
- 也可通过 Ctrl+Alt+L 快捷键格式化代码.
-
注释
-
注释应该解释代码作用
- 适合注释公共符号
-
注释应该解释代码如何做的
- 适合注释实现过程
-
注释应该解释代码实现的原因
- 适合解释代码的外部因素
- 提供额外上下文
-
注释应该解释代码什么情况会出错
- 适合解释代码的限制条件
-
-
命名规范
-
>> variable
-
简洁胜于冗长
-
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用 ServeHTTP 而不是 ServeHttp
- 使用 XMLHTTPRequest 或者 xmlHTTPRequest变量距离其被使用的地方越远，则需要携带越多的上下文信息
-
全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
-
>> function
-
函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
-
函数名尽量简短
-
当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
-
当名为 foo 包某个函数返回类型 T 时 (T 并不是 Fo)，可以在函数名中加入类型信息
-
>> package
-
只由小写字母组成。不包含大写字母和下划线等字符
-
简短并包含一定的上下文信息。例如 schema、 task 等不要与标准库同名。例如不要使用 sync 或者 strings
-
以下规则尽量满足，以标准库包名为例
- 不使用常用变量名作为包名。例如使用 bufio 而不是 buf
- 使用单数而不是复数。例如使用 encoding 而不是 encodings
- 谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短
-
-
控制流程
-
避免嵌套，保证正常流程清晰
-
尽量保持正常代码路径为最小缩进
- 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
-
-
错误和异常处理
-
>> 简单错误
-
简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
-
优先使用 errors.New 来创建匿名变量来直接表示简单错误
-
如果有格式化的需求，使用 fmt.Errorf
-
>> 错误的Wrap和Unwarp
-
错误的 Wrap实际上是提供了一个error 嵌套另error 的能力，从而生成一个 error 的跟踪链
-
在 fmt.Errorf 中使用: % w 关键字来将一个错误关联至错误链中
-
>> 错误判定
-
判定一个错误是否为特定错误，使用errors.Is
-
不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
-
在错误链上获取特定种类的错误，使用errors.As
-
** panic**
-
不建议在业务代码中使用panic
-
调用函数不包含 recover ?会造成程序崩溃
-
若问题可以被屏蔽或解决，建议使用error 代替 panic
-
当程序启动阶段发生不可逆转的错误时可以在 imit 或 main 函数中使用 panic
-
** recover**
-
recover 只能在被 defer 的函数中使用
-
嵌套无法生效
-
只在当前 goroutine 生效
-
defer 的语句是后进先出
-
