golang Error的一些坑
golang Error的一些坑
golang error的设计可能是被人吐槽最多的golang设计了。
最经典的err!=nil只影响代码风格设计，而有一些坑会导致我们的程序发生一些与我们预期不符的问题，开发过程中需要注意。
errors.Is判断error是否Wrap不符合预期
errors.Is经常用于判断当前的的error（第一个参数）是否包含target error（第二个参数），用于替代==判断当前err与target err的关系，like：
const badInput = "abc"
var ErrBadInput = errors.New("bad input")
func validateInput(input string) error {
if input == badInput {
return fmt.Errorf("validateInput: %w", ErrBadInput)
}
return nil
}
func main() {
input := badInput
err := validateInput(input)
if errors.Is(err, ErrBadInput) {
fmt.Println("bad input error")
}
}
结果输出：bad input error ，符合预期。
但是我们再来看看下面代码：
func main() {
errMsg := "123"
fmt.Println(errors.Is(errors.New(errMsg), errors.New(errMsg))) //结果反直觉，结果为false
err123 := errors.New(errMsg)
fmt.Println(errors.Is(err123, err123)) //结果为true
}
我们使用相同的errMsg初始化了两个err，使用errors.Is比较，结果为false。
原因是errors.Is虽然可以不断的拆包unwarp，但是在不能继续unwarp的时候，会用err == Error 直接比较错误对象与指定的错误对象，也就是指针的对比，肯定就对比不通过了。
这样很容易踩坑。
虽然erros.Is是会自动帮unwarp的，但是底层本质上还是指针的对比，new出来的err肯定是不同的err。
经验教训：
-
不要使用erros.New的方式来判断error是否相等或包含，如果非要使用就用error()把error信息打出来来比较吧。
-
为什么常能看见库设计者是直接实例化了一个
public的error对象来提供给你使用，而不是将其设置为private让你自己去new一个来判断（设计成private之后使用者就必须使用errors.Err()打印出msg来判断是否相等了，实在太蠢），like：
如果不了解erros.Is的使用可以参考：https://gosamples.dev/check-error-type/
自定义error判断是否为nil不符合预期
见代码：
type CustomizedError struct {
}
func (c CustomizedError) Error() string {
return "CustomizedError"
}
func func1() error {
var err *CustomizedError = nil
return err
}
func main() {
err := func1()
if err != nil {
log.Fatalf("1 err: %v", err) // 不符合预期，以为 err 为nil，但是会进这个分支
}
}
上面判断不符合预期的原因是error类型是一个接口Interface，interface 设计为了两部分：
- type
- value
其中，value 由一个任意的具体值表示，称作 interface 的 dynamic value ；而 type 则对应该 value 的类型（即 dynamic type）；例如对于对于 var a int = 3来说，把a 赋值给interface时， interface是使用(int, 3)进行存储的。
因此当想判断 interface 的值为 nil时 ，则必须是其内部 value 和 type 均未设置的情况，即 (nil, nil) ；
在上面的代码案例中func1()中返回值err的type已经不是nil了，因此后续会判断不通过。
禁言教训：
- 自定义error的时候禁止在任何地方出现dynamic value为nil的error，like：
var err *CustomizedError = nil，要么直接返回nil，要么初始化一个不为nil的返回。 - 延续上一条：如果自己是库的提供者，因此避免暴露自定义的error类型，而是只提供
NewMyError() error函数，避免使用方产生误用。like：
type myErr struct { // 注意这里的设计，myErr没有暴露出去
code int
msg string
}
func (e myErr) Error() string {
return fmt.Sprintf("code:%d,msg:%v", e.code, e.msg)
}
func New(code int, msg string) error {// 注意这里的设计，myErr没有暴露出去，只提供一个返回error的初始化方法
return myErr{
code: code,
msg: msg,
}
}
func GetCode(err error) int {
if e, ok := err.(myErr); ok {
return e.code
}
return -1
}
func GetMsg(err error) string {
if e, ok := err.(myErr); ok {
return e.msg
}
return ""
}
参考资料：
https://coolshell.cn/articles/21140.html
https://juejin.cn/post/6974037920567017509