GO语言技巧-优雅的处理和返回错误

2023-02-28 约 800 字预计阅读 2 分钟

优雅地处理函数内部的错误.

小白的我写了一段时间的代码，发现有时候经常要写很多的 if err != nil 判断，有没有办法可以精简一下这些错误处理？

查阅了相关资料，发现有几种方法，我记录一下 2 种比较常用的。

defer

将需要返回的 err 变量在函数内部全局化，然后结合 defer 统一处理：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26


// 注意，err 变量必须在这里有定义
func SomeProcess() (err error) { 
    defer func() {
        if err == nil {
            return
        }

        // 如果错误类型比较多可以使用 switch
        if errors.Is(err, somepkg.ErrRecordNotExist) {
            // 这里是举一个例子，有可能捕获到某些错误，对于该函数而言不算错误，因此 err = nil
            err = nil 
        } else if errors.Like(err, somepkg.ErrConnectionClosed) {
            // 或者是说遇到连接断开的操作时，可能需要做一些重连操作之类的；甚至乎还可以在这里重连成功之后，重新拉起一次请求
        } else {
            // ...
        }
    }()

    // ...

    if err = DoSomething(); err != nil {
        return
    }

    // ...
}

这种方案要特别注意变量作用域问题：

比如前面的 if err = DoSomething(); err != nil 行，如果我们将 err = ... 改为 err := ...，那么这一行中的 err 变量和函数最前面定义的 (err error) 不是同一个变量，因此即便在此处发生了错误，但是在 defer 函数中无法捕获到 err 变量了。

pkg/errors

我们可以把调用链路上的错误打包一起返回，具体可以使用 pkg/errors 这个第三包来实现。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37


package main
 
import (
    "fmt"
    "io/ioutil"
    "os"
    "path/filepath"
    "github.com/pkg/errors"
)
 
func ReadFile(path string) ([]byte, error) {
    f, err := os.Open(path)
    if err != nil {
        return nil, errors.Wrap(err, "open failed")
    }
    defer f.Close()
    buf, err := ioutil.ReadAll(f)
    if err != nil {
        return nil, errors.Wrap(err, "read failed")
    }
    return buf, nil
}
 
func ReadConfig() ([]byte, error) {
    home := os.Getenv("HOME")
    config, err := ReadFile(filepath.Join(home, ".settings.xml"))
    return config, errors.WithMessage(err, "cound not read config")
}
 
func main() {
    _, err := ReadConfig()
    if err != nil {
        fmt.Printf("original err:%T %v\n", errors.Cause(err), errors.Cause(err))
        fmt.Printf("stack trace:\n %+v\n",err)  // %+v 可以在打印的时候打印完整的堆栈信息
        os.Exit(1)
    }
}

打印信息：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


original err:*fs.PathError open .settings.xml: The system cannot find the file specified.
stack trace:
 open .settings.xml: The system cannot find the file specified.
open failed
main.ReadFile
        G:/goproject/src/github.com/huang394070956/learning/main.go:14
main.ReadConfig
        G:/goproject/src/github.com/huang394070956/learning/main.go:26
main.main
        G:/goproject/src/github.com/huang394070956/learning/main.go:31
runtime.main
        C:/Program Files/Go/src/runtime/proc.go:250
runtime.goexit
        C:/Program Files/Go/src/runtime/asm_amd64.s:1571
cound not read config
exit status 1

这样代码上也非常简洁，处理的非常优雅，最终不管是错误信息还是堆栈信息，还可以添加自定义的上下文，同时也完全满足关于错误日志处理的规则。

结尾

关于错误日志处理的规则：

错误要被日志记录
应用程序处理错误，保证100%的完整性
之后不再报告当前错误

目录

GO语言技巧-优雅的处理和返回错误

defer

pkg/errors

结尾