简介

该笔记主要关于青训营中提到过的部分go编码规范中的要点，包括：注释规范，命名规范，控制流程规范，错误和异常处理。

注释规范

• 公共符号始终要注释。
• 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释。
• 任何即不明显也不间短的公共功能必须予以注释。
• 无论长度或复杂程度如何，对库中的任何，对库中的任何函数都必须进行注释。
• 注释应该解释代码作用，如何做的，实现的原因，什么情况会出错。

命名规范

• 简洁胜于冗长。

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

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

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

• 包名：只由小写字母组成，简短并包含一定的上下文信息，不要与标准库同名。不适用常用变量名作为包名，使用单数而不是复数，谨慎地使用缩写。

控制流程规范

• 避免嵌套
• 尽量保持正常代码路径为最小缩进

错误和异常处理

简单错误（只出现一次的错误，且在其他地方不需要捕获该错误）

• 优先使用 errors.New 来创建匿名变量来直接表示简单错误。

vbnet
复制代码
errors.New("wrong information")
复制代码

• 如果有格式化的需求，使用fmt.Errorf ，使用 %w 关键字将一个错误关联至错误链中。

go
复制代码
if err != nil {
    return fmt.Errorf("error is %w", err)
}
复制代码

• 错误判定

  • 判定一个错误是否为特定错误，使用 errors.Is
  • 判定特定种类的错误，使用errors.As

kotlin
复制代码
if errors.Is(err, fs.ErrNotExist) {
    return []byte{}, nil
}
return data, err
复制代码

scss
复制代码
if errors.As(err, &pathError) {
    fmt.Println("Failed at Path:", PathError.Path)
} else {
    fmt.Println(err)
}
复制代码

• panic

  • 不建议在业务代码中使用(会导致程序结束)
  • 当程序启动阶段发生不可逆抓装的错误时，可以在 init 或 main 函数中使用 panic

• recover (异常处理, 用于在 panic 中回收某些东西或者继续执行某些事务)

  • 只能在 defer 的函数中使用
  • 嵌套无法使用
  • 只在当前 goroutine 生效