Go 高质量编程和错误处理｜青训营笔记这是我参与「第五届青训营」伴学笔记创作活动的第 5 天今天的内容是 go的高

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

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

前言

本节内容记录了课程的第4、5节以及工程实战的时候一些常用的约定

part1 高质量编程

1.高质量编程的标准和要求

标准：正确可靠、简洁清晰、无性能隐患
要求：简单性、可读性、生产力

2.高质量编程的常见编码规范

（1）代码格式

使用 gofmt 自动格式化代码，保证所有的 Go 代码与官方推荐格式保持一致
事实上我们常用工具: prettier

prettire:一款自动格式化的插件工具

prettier:
    silent: true
    desc: Format config files.
    cmds:
      - npx prettier --write --list-different ./

统一格式的好处在于: 提升可读性，更容易维护、需要更少的学习成本、团队合作成本，同时可以降低 Review 成本

（2）注释

注释应该解释代码作用
注释应该解释代码如何做的
注释应该解释代码实现的原因
注释应该解释代码什么情况会出错
注释应该提供代码未表达出的上下文信息
公共符号始终要注释

（3）命名规范

variable
- 简洁
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 足够的上下文信息
function
- 简短
- 不携带包名的上下文信息
- 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
- 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息
package
- 只由小写字母组成。不包含大写字母和下划线等字符
- 不要与标准库同名。例如不要使用 sync 或者 strings

总结: 关于命名的大多数规范核心在于考虑上下文

(4) 控制流程

避免嵌套，保持正常流程清晰
如果两个分支中都包含 return 语句，则可以去除冗余的 else
尽量保持正常代码路径为最小缩进，优先处理错误情况/特殊情况，并尽早返回或继续循环来减少嵌套，增加可读性

总结: 减低代码理解复杂度提高代码的可读性

(5) 错误和异常处理

简单错误处理
- 简单错误是指仅出现这一次且不会在其他地方被捕获
- 优先使用 errors.New 来创建匿名变量来直接表示该错误。有格式化需求时使用 fmt.Errorf
- 自定义错误多次出现可以把自定义错误集中保存处理
错误的 Wrap 和 Unwrap
- 在 fmt.Errorf 中使用 %w 关键字来将一个错误 wrap 至其错误链中
- Go1.13 在 errors 中新增了三个新 API 和一个新的 format 关键字，分别是 errors.Is、errors.As 、errors.Unwrap 以及 fmt.Errorf 的 %w。如果项目运行在小于 Go1.13 的版本中，导入 golang.org/x/xerrors 来使用。以下语法均已 Go1.13 作为标准。
错误判定
- 使用 errors.Is 可以判定错误链上的所有错误是否含有特定的错误。
- 在错误链上获取特定种类的错误，使用 errors.As
panic
- 不建议在业务代码中使用 panic
- 如果当前 goroutine 中所有 deferred 函数都不包含 recover 就会造成整个程序崩溃
- 当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic
recover
- recover 只能在被 defer 的函数中使用，嵌套无法生效，只在当前 goroutine 生效
- 如果需要更多的上下文信息，可以 recover 后在 log 中记录当前的调用栈。

总结

panic 用于真正异常的情况
error 尽可能提供简明的上下文信息，方便定位问题

(6) git规范提交

feat - 新功能 feature
fix - 修复 bug
docs - 文档注释
style - 代码格式(不影响代码运行的变动)
refactor - 重构、优化(既不增加新功能，也不是修复bug)
perf - 性能优化
test - 增加测试
chore - 构建过程或辅助工具的变动
revert - 回退
build - 打包

part2 错误处理

错误和异常：

出现错误的时候通过返回值进行返回错误err 之后处理
出现异常的时候直接抛出异常停止程序运行

常见的错误处理方式

最简单直接的方式是直接return错误
- if err := Foo(); err != nil { return err }
- 问题：
  - 然而，在实际使用中我们往往需要将包含一些自定义的错误信息，这是容易形成每一个err都需要判断，并且转载对应错误信息的情况
  - 代码格式过于混乱

集中处理

defer方式

func validator() {
     var err error
     defer func() {
             if err != nil {
                     switch err {
                     case xxx1:
                             fmt.Println(err)
                     case xxx2:
                             fmt.Println(err)
                     default:
                             fmt.Println("unknown err")
                     }
                     return
             }
             fmt.Println("It's ok!")
             return
     }()

     if err = func1(); err != nil {
             return
     }
     if err = func2(); err != nil {
             return
     }
 }

在调用函数的时候如果出现异常情况就直接return 由defer进行特殊说明

标签方式

func validator() {
        var err error
        if err = func1(); err != nil {
                goto ERR
        }
        if err = func2(); err != nil {
                goto ERR
        }
        return
ERR:
        switch err {
        case xxx1:
                fmt.Println(err)
        case xxxA2:
                fmt.Println(err)
        default:
                fmt.Println("unknown err")
        }
}

当出现错误的时候跳转到错误处理区域

panic + recover //异常处理

func mayPanic() {
     panic("a problem")
 }

 func main() {

     defer func() {
         if r := recover(); r != nil {

             fmt.Println("Recovered. Error:\n", r)
         }
     }()

     mayPanic()

     fmt.Println("After mayPanic()")
 }

recover 只有在 defer 中调用才会生效；
panic 允许在 defer 中嵌套多次调用；
panic 只会对当前 Goroutine 的 defer 有效

Wrap方案

// 错误嵌套
fmt.Errorf("failed to login: %w", err)

// AS: 按顺序寻找错误链中是否有与目标匹配的错误？ 
// 第二个参数可以是任何实现了error接口的非空类型
// 如果有返回true，并将err替换成错误链上第一个匹配上的
// 否则返回false
func As(err error, target any) bool 

// Is: 判断错误链上是否有能匹配上的错误
func Is(err, target error) bool

// Unwrap 解开一层错误链
func Unwrap(err error) error

参考文献

码风略丑读者见谅 --2023/2/1

Go 高质量编程和错误处理｜ 青训营笔记

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

前言