从多个抽象级别处理错误的最佳实践

Question

我想知道什么是在go中处理多级抽象错误的最佳方法.每次如果我必须在程序中添加新的级别抽象,我就不得不将错误代码从级别转移到级别高.因此是日志文件中的重复社区或我必须重新删除通信表单级别并将其转移到更高级别.以下简单示例.我跳过创建每个对象更快和celar代码,但我认为你了解我的问题

type ObjectOne struct{
    someValue int
}

func (o* ObjectOne)CheckValue()error{
    if o.someValue == 0 {
        SomeLogger.Printf("Value is 0 error program") // communicate form first level abstraction to logger
        return errors.New("Internal value in object is 0")
    }
    return nil
}

type ObjectTwoHigherLevel struct{
    objectOne ObjectOne
}

func (oT*  ObjectTwoHigherLevel)CheckObjectOneIsReady() error{
    if err := oT.objectOne.CheckValue() ; err != nil{
        SomeLogger.Printf("Value in objectOne is not correct for objectTwo %s" , err) //  second communicate
        return  err
    }
    return nil
}

type ObjectThreeHiggerLevel struct{
    oT ObjectTwoHigherLevel
}

func (oTh* ObjectThreeHiggerLevel)CheckObjectTwoIsReady()error{
    if err := oTh.oT.CheckObjectOneIsReady() ; err != nil{
        SomeLogger.Printf("Value in objectTwo is not correct for objectThree %s" , err)
    return err
    }
    return nil
}

结果在日志文件中我得到重复的帖子

Value is 0 error program 
Value in objectOne is not correct for objectTwo Internal value in object is 0 
Value in objectTwo is not correct for objectThree Internal value in object is 0

反过来,如果我只将一些转移err到更高级别而没有额外的日志,我丢失了每个级别发生的信息.

这怎么解决？privent复制如何通信？或者我的方式是好的,唯一的？

如果我创建一些在几个抽象级别上搜索数据库中的内容的对象,那么问题会更令人沮丧,然后我在logFile中也会形成相同任务的几行.

Answer 1

您应该处理错误,或者不处理错误,而是将其委托给更高级别(对调用者).处理错误并返回它是不好的做法,好像调用者也这样做,错误可能会被处理多次.

处理错误意味着检查它并根据它做出决定,这可能只是记录它,但这也算作"处理"它.

如果你选择不处理但将其委托给更高级别,那可能完全没问题,但是不要只返回你得到的错误值,因为对于没有上下文的调用者来说它可能没有意义.

注释错误

一个非常好的和推荐的委派方式是Annotating errors.这意味着您创建并返回一个新的错误值,但旧的错误值也包含在返回的值中.包装器为包装错误提供上下文.

这里是注释错误公共图书馆:github.com/pkg/errors; 和它的godoc:errors

它基本上有2个函数:1用于包装现有错误:

func Wrap(cause error, message string) error

一个用于提取包装错误:

func Cause(err error) error

使用这些,这是您的错误处理可能如下所示:

func (o *ObjectOne) CheckValue() error {
    if o.someValue == 0 {
        return errors.New("Object1 illegal state: value is 0")
    }
    return nil
}

第二级:

func (oT *ObjectTwoHigherLevel) CheckObjectOneIsReady() error {
    if err := oT.objectOne.CheckValue(); err != nil {
        return errors.Wrap(err, "Object2 illegal state: Object1 is invalid")
    }
    return nil
}

第三级:只调用二级检查:

func (oTh *ObjectThreeHiggerLevel) CheckObjectTwoIsReady() error {
    if err := oTh.ObjectTwoHigherLevel.CheckObjectOneIsReady(); err != nil {
        return errors.Wrap(err, "Object3 illegal state: Object2 is invalid")
    }
    return nil
}

请注意,由于CheckXX()方法不处理错误,因此它们不会记录任何内容.他们委托注释错误.

如果有人使用ObjectThreeHiggerLevel决定处理错误:

o3 := &ObjectThreeHiggerLevel{}
if err := o3.CheckObjectTwoIsReady(); err != nil {
    fmt.Println(err)
}

将呈现以下好的输出:

Object3 illegal state: Object2 is invalid: Object2 illegal state: Object1 is invalid: Object1 illegal state: value is 0

没有多个日志的污染,并且所有细节和上下文都被保留,因为我们使用errors.Wrap()它产生一个错误值,格式化为string保存包装错误,递归地:错误堆栈.

您可以在博客文章中阅读有关此技术的更多信息:

Dave Cheney:不要只是检查错误,优雅地处理它们

"扩展"错误

如果你喜欢简单的东西和/或你不想使用外部库,你就可以解决原始错误(确切的错误值,而不是错误字符串),那么你可以只需使用上下文扩展错误并返回此新的扩展错误.

通过使用fmt.Errorf()允许您创建"漂亮"格式化错误消息最简单地扩展错误,并返回类型值,error以便您可以直接返回该错误.

使用fmt.Errorf(),这是您的错误处理可能如下所示:

func (o *ObjectOne) CheckValue() error {
    if o.someValue == 0 {
        return fmt.Errorf("Object1 illegal state: value is %d", o.someValue)
    }
    return nil
}

第二级:

func (oT *ObjectTwoHigherLevel) CheckObjectOneIsReady() error {
    if err := oT.objectOne.CheckValue(); err != nil {
        return fmt.Errorf("Object2 illegal state: %v", err)
    }
    return nil
}

第三级:只调用二级检查:

func (oTh *ObjectThreeHiggerLevel) CheckObjectTwoIsReady() error {
    if err := oTh.ObjectTwoHigherLevel.CheckObjectOneIsReady(); err != nil {
        return fmt.Errorf("Object3 illegal state: %v", err)
    }
    return nil
}

ObjectThreeHiggerLevel如果它决定"处理"它,将显示以下错误消息:

o3 := &ObjectThreeHiggerLevel{}
if err := o3.CheckObjectTwoIsReady(); err != nil {
    fmt.Println(err)
}

将呈现以下好的输出:

Object3 illegal state: Object2 illegal state: Object1 illegal state: value is 0

一定要阅读博客文章:错误处理和Go