这是我参与「第五届青训营 」伴学笔记创作活动的第 7 天
如何编写高质量的Go代码？有一些公认的开源的编码规范可以提供我们参考，像一些公司内部也有自己的编码规范。
如何编写高质量Go代码
- 代码格式
- 注释
- 命名规范
- 控制流程
- 错误和异常处理
代码格式
推荐使用gofmt自动格式化代码
gofmt：是Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格，常见IDE都支持方便的配置
goimports：也是Go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母序排序并分类。
注释
注释应该做的：
- 注释应该解释代码作用
- 注释应该解释代码如何做的
- 注释应该解释代码实现的原因
- 注释应该解释代码什么情况会出错
- 公共符号始终要注释
公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简单的公共功能必须予以注释
- 无论长度或复杂成都如何，对库中的任何函数都必须进行注释
- 有一个例外：不需要注释实现接口的方法
- 对公共符号都有注释说明
命名规范
-
简洁胜于冗长
-
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 使用ServeHTTP而不是ServeHttp
- 使用XMLHTTPRequest或者xmlHTTPRequest
-
变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
// Bad
for index := 0; index < len(s); index++ {
// so something
}
// Good
for i := 0; i < len(s);i++ {
// so something
}
i 和 index 的作用域范围仅限于for循环内部时，index的额外冗长几乎没有增加对于程序的理解。
控制流程
- 避免嵌套，保持正常流程清晰，例如去掉不必要的
else
// Bad
if foo {
return x
} else {
return nil
}
// Good
if foo {
return x
}
return nill
如果两个分支都包含return语句，则可以去除冗余的else。
- 尽量保持正常代码路径为最小缩进，能对称就对称
// Bad
func OneFunc() error {
err := dosomething()
if err == nil {
err := dosomething()
if err == nil {
return nil
}
return err
}
return err
}
// Good
func OneFunc() error {
if err := dosomething(); err != nil {
return err
}
if err := doAnotherthing(); err != nil {
return err
}
return nil
}
优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
- 故障问题的大多出现在复杂的条件语句和循环语句中，尽量化简
错误和异常处理
简单错误
仅出现一次的错误，且在其他地方不需要捕获该错误
优先使用
errors.New来创建匿名变量来直接表示简单错误如果有格式化需求，请使用
fmt.Errorf
// 一个例子
func defaultCheckRedirect(req *Request, via []*Request) error {
if len(via) >= 10 {
// 使用errors.New
return errors.New("stopped after 10 redirects.")
}
return nil // 去掉不必要的else
}
错误的Wrap和Unwrap
错误的
Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
在
fmt.Errorf中使用%w关键字来将一个错误关联至错误链中
错误判定
- 判定一个错误是否为特定错误，使用
errors.Is- 不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
- 在错误链上获取特定种类的错误，使用
errors.As
panic
- 不建议在业务代码中使用
panic- 调用函数不包含
recover会造成程序崩溃- 若问题可以被屏蔽或解决，建议使用
error代替panic- 当程序启动阶段发生不可逆转的错误时，可以在
init或main函数中使用panic
