golang常用库之pkg/errors包第三方错误处理包案例详解

Golang常用库之-pkg/errors包

背景

golang自带了错误信息包error

• 只提供了简单的用法, 如errors.New(),和errors.Error()用来传递和获取错误信息.
• 明显官方的包已经不能满足了, 只能采取其他方法补救, 如:采用三方errors包。

关于官方errors包

Go 语言使用 error 类型来返回函数执行过程中遇到的错误，如果返回的 error 值为 nil，则表示未遇到错误，否则 error 会返回一个字符串，用于说明遇到了什么错误。

查看golang的errors包你会发现其源码是：

package errors

// New returns an error that fORMats as the given text.
// Each call to New returns a distinct error value even if the text is identical.
func New(text string) error {
	return &errorString{text}
}
// errorString is a trivial implementation of error.
type errorString struct {
	s string
func (e *errorString) Error() string {
	return e.s

New方法通过传入的text创建不同的errorString，这个结构体实现了Error()方法，这样便可以动态的创建不同的错误类型。

New返回了一个实现error接口的errorString类型的指针。 那为啥不是返回errorString的值类型？？

我们在调用errors.New("")来返回一个错误时， **可以通过比较指针，来比较error是否相等， 实际上就是控制相同的错误我们只创建一个error对象。**否则对象复制一下，在比较就是false了。

而且指针才会与nil相比较， 如果是字符串"" 虽然错误内容为空，但是还是有错误的。

看过源码我们很清楚的知道内置的error类型包含的信息十分有限

官方errors包使用demo

package main

import (
	"errors"
	"fmt"
)
func main()  {
	err := errors.New("errors！！！！！！！！！！")
	if err != nil {
		fmt.Print(err)
	}
}

什么是pkg/errors包

GitHub.com/pkg/errors

Golang 的 error 不会像 Java 那样打印 stackTrack 信息。回溯 err 很是不方便。

pkg/errors 是一个用的比较多，同时也比较灵活的一个golang 异常处理包，我们基于此包，可以灵活的处理软件开发中的异常

位于github.com/pkg/errors 的errors包是Go标准库的替代品。它提供了一些非常有用的操作用于封装和处理错误。

经过 github.com/pkg/errors 这个包来处理 err，WithStack(err) 函数能够打印 stack

pkg/errors包使用demo

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

注意，使用 log.Errorf("%+v", err) 才会打印 stackTrack，使用 %v %s 不行。

package main

import (
	E "errors"
	"fmt"
	"github.com/pkg/errors"
)
func main() {
	err0 := t1()
	err := errors.Wrap(err0, "附加信息")
	if err != nil {
		//打印错误需要%+v才能详细输出
		fmt.Printf("err :%+v\n", err)
	}
	fmt.Println("Hello world")
}
func t1() error {
	return E.New("错误")

结果：

优秀开源项目使用案例

https://github.com/marmotedu/errors

作者基于 github.com/pkg/errors 包，增加对 error code 的支持，完全兼容 github.com/pkg/errors。

性能跟 github.com/pkg/errors 基本持平。

该 errors 包匹配的错误码设计请参考：marmotedu/sample-code

可以用于WEB服务 code message JSON返回效果。
如果返回结果中存在 code 字段，则表示调用 api 接口失败。例如：

{
  "code": 100101,
  "message": "Database error"
}

上述返回中 code 表示错误码，message 表示该错误的具体信息。每个错误同时也对应一个 Http 状态码，比如上述错误码对应了 HTTP 状态码 500(Internal Server Error)。

参考

Golang的错误处理
参考URL: https://zhuanlan.zhihu.com/p/89821850

到此这篇关于golang常用库之-pkg/errors包 第三方错误处理包的文章就介绍到这了,更多相关golang pkg/errors包第三方错误处理包内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网！