目前实现最优雅,打印堆栈良好的包。
参考: https://studygolang.com/articles/17430?fr=sidebar
下载安装
go get -x github.com/pkg/errors
跟踪堆栈信息的函数使用
// 新生成一个错误, 带堆栈信息
func New(message string) error
//只附加新的信息
func WithMessage(err error, message string) error
//只附加调用堆栈信息
func WithStack(err error) error
//同时附加堆栈和信息
func Wrap(err error, message string) error
打印出堆栈信息
%s,%v //功能一样,输出错误信息,不包含堆栈
%q //输出的错误信息带引号,不包含堆栈
%+v //输出错误信息和堆栈
如:
fmt.Println(fmt.Sprintf("%s", err))
fmt.Println(fmt.Sprintf("%q", err))
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信息
关键代码如下
func C() error {
_, err := os.Open("abc")
if err != nil {
err = errors.WithStack(err)
return err
}
return nil
}
入口函数打印信息
func main() {
err := a.A()
if err != nil {
fmt.Println(PrintMessage(err)) // 打印普通信息
fmt.Println(PrintStack(err)) // 打印信息附带堆栈信息
return
}
fmt.Println("ok")
}
// 打印普通信息,没有堆栈信息
func PrintMessage(err error) string {
return err.Error()
}
// 打印详细信息,附带堆栈信息。
func PrintStack(err error) string {
errMsg := fmt.Sprintf("%+v", err)
return CleanPath(errMsg)
}
// 脱敏
func CleanPath(s string) string {
return strings.ReplaceAll(s, GetCurrentPath() + "/", "")
}
// 获取当前项目目录
func GetCurrentPath() string {
getwd, err := os.Getwd()
if err != nil {
return ""
}
return strings.Replace(getwd, "\\", "/", -1)
}
输出信息
很清晰的显示 c.go -> b.go -> a.go -> main.go的执行顺序(这里与调用顺序刚好相反嘛)
open abc: The system cannot find the file specified.
learn_error/c.C
c/c.go:11
learn_error/b.B
b/b.go:6
learn_error/a.A
a/a.go:6
main.main
main.go:11
总结
关键代码
import (
"github.com/pkg/errors"
"os"
)
func C() error {
_, err := os.Open("abc")
if err != nil {
err = errors.WithStack(err) // 对err进行包装,附带堆栈信息处理。
return err
}
return nil
}
如果和其他库进行协作,考虑使用errors.wrap或者errors.wrapf保存堆栈信息。同样适用于和标准库协作的时候。
直接返回错误,而不是每个错误产生的地方到处打日志。
在程序的顶部或者是工作的goroutine顶部(请求入口),使用%+v把推展详情记录
Errors before go 1.13
最简单的错误检查
有时候我们需要对sentinel error 进行检查
实现了error interface的已定义error sttuct,进行断言使用获取更丰富的上下文
go1.13errors包包含两个用于检查错误的新函数 Is 和 As
用%w包装错误
使用fmt.Errorf 向错误添加附加信息
在GO1.13中fmt.Errorf支持新的#w谓词
用%w包装错误可用于errors.Is 以及errors.As: