GF框架提供了强大、丰富的错误处理能力,由gerror模块实现。

使用方式

  1. import "github.com/gogf/gf/errors/gerror"

接口文档

https://godoc.org/github.com/gogf/gf/errors/gerror

错误堆栈

标准库的error错误实现比较简单,无法进行堆栈追溯,对于产生错误时的上层调用者来讲不是很友好,无法获得错误的调用链详细信息。gerror支持错误堆栈记录,通过New/NewfWrap/Wrapf均会自动记录当前错误产生时的堆栈信息。

使用示例:

  1. package main
  2. import (
  3. "fmt"
  4. "github.com/gogf/gf/errors/gerror"
  5. )
  6. func OpenFile() error {
  7. return gerror.New("permission denied")
  8. }
  9. func OpenConfig() error {
  10. return gerror.Wrap(OpenFile(), "configuration file opening failed")
  11. }
  12. func ReadConfig() error {
  13. return gerror.Wrap(OpenConfig(), "reading configuration failed")
  14. }
  15. func main() {
  16. fmt.Printf("%+v", ReadConfig())
  17. }

执行后,终端输出:

  1. reading configuration failed: configuration file opening failed: permission denied
  2. 1. reading configuration failed
  3. 1). main.ReadConfig
  4. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/geg/errors/gerror/gerror2.go:18
  5. 2). main.main
  6. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/geg/errors/gerror/gerror2.go:25
  7. 2. configuration file opening failed
  8. 1). main.OpenConfig
  9. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/geg/errors/gerror/gerror2.go:14
  10. 2). main.ReadConfig
  11. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/geg/errors/gerror/gerror2.go:18
  12. 3). main.main
  13. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/geg/errors/gerror/gerror2.go:25
  14. 3. permission denied
  15. 1). main.OpenFile
  16. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/geg/errors/gerror/gerror2.go:10
  17. 2). main.OpenConfig
  18. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/geg/errors/gerror/gerror2.go:14
  19. 3). main.ReadConfig
  20. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/geg/errors/gerror/gerror2.go:18
  21. 4). main.main
  22. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/geg/errors/gerror/gerror2.go:25

可以看到,调用端可以通过Wrap方法将底层的错误信息进行层级叠加,并且包含完整的错误堆栈信息。

fmt 格式化

通过以上示例我们可以看到,通过%+v的打印格式可以打印出完整的堆栈信息,当然gerror.Error对象支持多种fmt格式:

格式符输出内容
%v, %s打印所有的层级错误信息,构成完成的字符串返回,多个层级使用:拼接。
%-v, %-s打印当前层级的错误信息,返回字符串。
%+s打印完整的堆栈信息列表。
%+v打印所有的层级错误信息字符串,以及完整的堆栈信息,等同于%s\n%+s

使用示例:

  1. package main
  2. import (
  3. "errors"
  4. "fmt"
  5. "github.com/gogf/gf/errors/gerror"
  6. )
  7. func main() {
  8. var err error
  9. err = errors.New("sql error")
  10. err = gerror.Wrap(err, "adding failed")
  11. err = gerror.Wrap(err, "api calling failed")
  12. fmt.Printf(" %%s: %s\n", err)
  13. fmt.Printf("%%-s: %-s\n", err)
  14. fmt.Println("%+s: ")
  15. fmt.Printf("%+s\n", err)
  16. }

执行后,终端输出为:

  1. %s: api calling failed: adding failed: sql error
  2. %-s: api calling failed
  3. %+s:
  4. 1. api calling failed
  5. 1). main.main
  6. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/.example/other/test.go:14
  7. 2. adding failed
  8. 1). main.main
  9. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/.example/other/test.go:13
  10. 3. sql error

Stack 获取堆栈信息

  1. func Stack(err error) string

通过Stack方法我们可以获得error对象的完整堆栈信息,返回堆栈列表字符串。 注意参数为标准库error类型,当该参数为gerror模块生成的error时, 或者开发者自定义的error对象实现了该接口时支持打印,否则,返回空字符串。

使用示例:

  1. package main
  2. import (
  3. "errors"
  4. "fmt"
  5. "github.com/gogf/gf/errors/gerror"
  6. )
  7. func main() {
  8. var err error
  9. err = errors.New("sql error")
  10. err = gerror.Wrap(err, "adding failed")
  11. err = gerror.Wrap(err, "api calling failed")
  12. fmt.Println(gerror.Stack(err))
  13. }

执行后,终端输出:

  1. 1. api calling failed
  2. 1). main.main
  3. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/.example/other/test.go:14
  4. 2. adding failed
  5. 1). main.main
  6. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/.example/other/test.go:13
  7. 3. sql error

Current 获取当前error

  1. func Current(err error) error

Current方法用于获取当前层级的错误信息,通过error接口对象返回。

使用示例:

  1. package main
  2. import (
  3. "errors"
  4. "fmt"
  5. "github.com/gogf/gf/errors/gerror"
  6. )
  7. func main() {
  8. var err error
  9. err = errors.New("sql error")
  10. err = gerror.Wrap(err, "adding failed")
  11. err = gerror.Wrap(err, "api calling failed")
  12. fmt.Println(err)
  13. fmt.Println(gerror.Current(err))
  14. }

执行后,终端输出:

  1. api calling failed: adding failed: sql error
  2. api calling failed

Next 获取下一层error

  1. func Next(err error) error

Next方法用于获取层级错误的下一级错误error接口对象。当下一层级不存在时,返回nil

使用示例:

  1. package main
  2. import (
  3. "errors"
  4. "fmt"
  5. "github.com/gogf/gf/errors/gerror"
  6. )
  7. func main() {
  8. var err error
  9. err = errors.New("sql error")
  10. err = gerror.Wrap(err, "adding failed")
  11. err = gerror.Wrap(err, "api calling failed")
  12. fmt.Println(err)
  13. err = gerror.Next(err)
  14. fmt.Println(err)
  15. err = gerror.Next(err)
  16. fmt.Println(err)
  17. }

执行后,终端输出:

  1. api calling failed: adding failed: sql error
  2. adding failed: sql error
  3. sql error

Cause 获取根error

  1. func Cause(err error) error

通过Cause方法我们可以获得error对象的根错误信息(原始错误)。 注意参数为标准库error类型,当该参数为gerror模块生成的error时, 或者开发者自定义的error对象实现了该接口方法时支持打印,否则,返回输出的error对象。

使用示例:

  1. package main
  2. import (
  3. "fmt"
  4. "github.com/gogf/gf/errors/gerror"
  5. )
  6. func OpenFile() error {
  7. return gerror.New("permission denied")
  8. }
  9. func OpenConfig() error {
  10. return gerror.Wrap(OpenFile(), "configuration file opening failed")
  11. }
  12. func ReadConfig() error {
  13. return gerror.Wrap(OpenConfig(), "reading configuration failed")
  14. }
  15. func main() {
  16. fmt.Println(gerror.Cause(ReadConfig()))
  17. }

执行后,终端输出:

  1. permission denied

日志输出支持

glog日志管理模块天然支持对gerror错误堆栈打印支持,这种支持不是强耦合性的,而是通过fmt格式化打印接口支持的。

使用示例:

  1. package main
  2. import (
  3. "errors"
  4. "github.com/gogf/gf/frame/g"
  5. "github.com/gogf/gf/errors/gerror"
  6. )
  7. func main() {
  8. var err error
  9. err = errors.New("sql error")
  10. err = gerror.Wrap(err, "adding failed")
  11. err = gerror.Wrap(err, "api calling failed")
  12. g.Log().Print(err)
  13. }

执行后,终端输出:

  1. 2020-10-17 15:22:26.793 api calling failed: adding failed: sql error
  2. 1. api calling failed
  3. 1). main.main
  4. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/.example/other/test.go:14
  5. 2. adding failed
  6. 1). main.main
  7. /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/.example/other/test.go:13
  8. 3. sql error