目前实现最优雅,打印堆栈良好的错误包。
下载安装
go get -x github.com/pkg/errors
主要函数
代码语言:javascript复制// 新生成一个错误, 带堆栈信息
func New(message string) error
//只附加新的信息
func WithMessage(err error, message string) error
//只附加调用堆栈信息
func WithStack(err error) error
//同时附加堆栈和信息
func Wrap(err error, message string) error
打印出堆栈信息
代码语言:javascript复制%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信息
c.go中的关键代码如下:
代码语言:javascript复制func C() error {
_, err := os.Open("abc")
if err != nil {
err = errors.WithStack(err)
return err
}
return nil
}
入口函数打印信息
代码语言:javascript复制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的执行顺序(这里与调用顺序刚好相反,最下层的错误出现在最上面。)
代码语言:javascript复制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
总结
包装error的关键代码:
代码语言:javascript复制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
}
通过使用这个 github.com/pkg/errors 错误库,我们可以收集更多的信息,可以让我们更容易的定位问题。 我们收集的这些信息不止可以输出到控制台,也可以当做日志,使用输出到相应的Log日志里,便于分析问题。
据说这个库,会被加入到Golang 标准 SDK 里,期待着,如果加入的话,应该就是补充现在标准库里的errors 这个package了。