1 概述
1.1 golang error接口
golang的error接口只包含一个方法Eorror() string,此方法只是返回一个纯粹的字符串,思想理念就是用纯粹的字符串来描述一个错误。error接口隐藏了error实现类的细节,只能"弹出"一个字符串,程序代码只能根据这个字符串来决定代码走向。但某些情况下,程序员更希望能得到一个描述错误的对象,它能弹出更富态的信息(例如code等)。
1.2 github.com/pkg/errors包
此包赋予了原生error接口一个"套娃"的功能,不会破坏原有的error结构。
此包能对原生error接口进行封装多一层信息(Wrap),也能对error进行解封装(UnWrap)、支持错误堆栈,还有Is()方法和As()方法。
Is方法用于判断当前error是不是目标error,如果能进行解封装,也会判断内部error是不是目标error。
As方法用于提取最内层的error接口的实现类,得到最内层的实现类则能弹出更多信息(例如code等)。
2 测试
2.1 代码
package main
import (
"fmt"
"github.com/pkg/errors"
)
func main() {
var daoErr error
var modelErr error
var controllerErr error
// 第三方包返回的err
thirdPartyErr := &MyError{ Code: 200, Message: "this is a third party package error"}
// dao层的err包含第三方包的err
if thirdPartyErr != nil {
daoErr = errors.Wrap(thirdPartyErr, "this is a dao err message")
}
// model层err包含dao层err
if daoErr != nil {
modelErr = errors.WithMessage(daoErr, "this is a model err message")
}
// controller层err包含model层err
if modelErr != nil {
controllerErr = errors.WithMessage(modelErr, "this is a controller err message")
}
// 打印controller层err
fmt.Printf("%+v\n", controllerErr)
fmt.Println()
// 判断内层的err是不是目标err
fmt.Println("errors.Is() result:", errors.Is(controllerErr, thirdPartyErr))
fmt.Println("errors.Is() result:", errors.Is(controllerErr, daoErr))
fmt.Println("errors.Is() result:", errors.Is(controllerErr, modelErr))
fmt.Println("errors.Is() result:", errors.Is(controllerErr, controllerErr))
fmt.Println()
// 提取最内层的err实现
targetError := &MyError{}
fmt.Println("errors.As() result:", errors.As(controllerErr, &targetError))
fmt.Println("target err:", targetError)
// 解开一层err
fmt.Println()
controllerUnwrapErr := errors.Unwrap(controllerErr)
fmt.Println("controllerUnwrapErr == modelErr:", controllerUnwrapErr == modelErr)
}
type MyError struct {
// 对外使用 - 错误码
Code int
// 对外使用 - 错误信息
Message string
}
func (e *MyError) Error() string {
return e.Message
}
2.2 输出
3 小结
原生error接口过于简洁,满足不了需要富态化的错误信息的情景。github.com/pkg/errors包给了一个套娃的功能,保留了内部error接口的完整性,因为如果将内层error接口实现类扁平化成一个字符串再被放入一个新的error接口中,原有数据结构被破坏了,只能从弹出的字符串中进行字符搜索来到达提取错误信息之目的。