目前实现最优雅，打印堆栈良好的错误包。

下载安装

go get -x github.com/pkg/errors

主要函数

  1. // 新生成一个错误, 带堆栈信息
  2. func New(message string) error
  4. //只附加新的信息
  5. func WithMessage(err error, message string) error
  7. //只附加调用堆栈信息
  8. func WithStack(err error) error
  10. //同时附加堆栈和信息
  11. func Wrap(err error, message string) error

打印出堆栈信息

  1. %s,%v //功能一样，输出错误信息，不包含堆栈
  2. %q //输出的错误信息带引号，不包含堆栈
  3. %+v //输出错误信息和堆栈
  4. 如：
  5. fmt.Println(fmt.Sprintf("%s", err))
  6. fmt.Println(fmt.Sprintf("%q", err))
  7. fmt.Println(fmt.Sprintf("%+v", err))

测试

新建三个文件，a.go, b.go, c.go 还有一个入口文件main.go
调用顺序是main.go -> c.go -> b.go -> c.go 由c.go里一个函数返回一个error信息

c.go中的关键代码如下：

  1. func C() error {
  2.     _, err := os.Open("abc")
  3.     if err != nil {
  4.         err = errors.WithStack(err)
  5.         return err
  6.     }
  7.     return nil
  8. }

入口函数打印信息

  2. func main() {
  3.     err := a.A()
  4.     if err != nil {
  5.         fmt.Println(PrintMessage(err)) // 打印普通信息
  6.         fmt.Println(PrintStack(err)) // 打印信息附带堆栈信息
  7.         return
  8.     }
  9.     fmt.Println("ok")
  10. }
  11. // 打印普通信息，没有堆栈信息
  12. func PrintMessage(err error) string {
  13.     return err.Error()
  14. }
  16. // 打印详细信息，附带堆栈信息。
  17. func PrintStack(err error) string {
  18.     errMsg := fmt.Sprintf("%+v", err)
  19.     return CleanPath(errMsg)
  20. }
  22. // 代码路径脱敏
  23. func CleanPath(s string) string {
  24.     return strings.ReplaceAll(s, GetCurrentPath() + "/", "")
  25. }
  27. // 获取当前项目目录
  28. func GetCurrentPath() string {
  29.     getwd, err := os.Getwd()
  30.     if err != nil {
  31.         return ""
  32.     }
  33.     return strings.Replace(getwd, "\\", "/", -1)
  34. }

输出信息

很清晰的显示 c.go -> b.go -> a.go -> main.go的执行顺序（这里与调用顺序刚好相反，最下层的错误出现在最上面。）

  1. open abc: The system cannot find the file specified.
  2. learn_error/c.C
  3.     c/c.go:11
  4. learn_error/b.B
  5.     b/b.go:6
  6. learn_error/a.A
  7.     a/a.go:6
  8. main.main
  9.     main.go:11

总结

包装error的关键代码：

  1. import (
  2.     "github.com/pkg/errors"
  3.     "os"
  4. )
  6. func C() error {
  7.     _, err := os.Open("abc")
  8.     if err != nil {
  9.         err = errors.WithStack(err) // 对err进行包装，附带堆栈信息处理。
  10.         return err
  11.     }
  12.     return nil
  13. }

通过使用这个 github.com/pkg/errors 错误库，我们可以收集更多的信息，可以让我们更容易的定位问题。
我们收集的这些信息不止可以输出到控制台，也可以当做日志，使用输出到相应的Log日志里，便于分析问题。

据说这个库，会被加入到Golang 标准 SDK 里，期待着，如果加入的话，应该就是补充现在标准库里的errors 这个package了。