这是我参与「第五届青训营 」伴学笔记创作活动的第 4 天

简介

什么是高质量
编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码

各种边界条件是否考虑完备
异常情况处理
稳定性保证
易读易维护

编码规范

如何编写高质量的Go代码？有一些公认的开源的编码规范可以提供我们参考，像一些公司内部也有自己的编码规范。

下面选几个重要的规范来介绍下：

代码格式

代码各种能统一的话，团队之间合作就能把关注点放在具体的逻辑上，提高效率。
推荐使用gofmt自动格式化代码

注释

公共符号始终要注释

• 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
• 任何既不明显也不简单的公共功能必须予以注释
• 无论长度或复杂成都如何，对库中的任何函数都必须进行注释
• 例外：不需要注释接线接口的方法。

命名规范

变量

• 简洁胜于冗长
• 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写

• • 例如使用ServeHTTP而不是ServeHttp
  • 使用XMLHTTPRequest或者xmlHTTPRequest

• 变量距离其被使用的地方越远，则需要携带越多的上下文信息

• • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

i 和 index 的作用域范围仅限于for循环内部时，index的额外冗长几乎没有增加对于程序的理解。

函数

• 函数名不携带包名的上下文信息，因为包名和函数名总数成对出现的
• 函数名尽量简短
• 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
• 当名为foo的包某个函数返回类型T时(T并不是Foo)，可以在函数名中加入类型信息

包名

• 只由小写字母组成，不包含大写字母和下划线等字符
• 简短并包含一定的上下文信息，例如schema、task等
• 不要与标准库同名，例如不要使用sync、strings等

以下规则尽量满足，以标准库包名为例

• 不使用常用变量名作为包名，例如使用bufio而不是buf
• 使用单数而不是复数，例如使用encoding而不是encodings
• 谨慎地使用缩写，例如使用fmt在不破坏上下文的情况下比format更加简短

控制流程

当我们能够给变量或者函数选择合适的名称后，接下来就是实现具体功能了，经常用到的就是if else这种条件控制语句，那么在使用中需要注意哪些点?

首先是避免嵌套
从最简单的一个if else条件开始，如果两个分支都包含returm语句，则可以去除冗余的else 方便后续维护，else一般是正常流程，如果需要在正常流程新增判断逻辑，避免分支嵌套

错误和异常处理

error尽可能提供简明的上下文信息链，方便定位问题，panic用于真正异常的情况，recover生效范围，在当前goroutine的被defer的函数中生效。

错误的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中记录当前的调用栈