一尘不染

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

go

我想知道 在go中处理多层抽象错误
的最佳方法是什么。每当我必须在程序中添加新的级别抽象时,都必须将错误代码从较低级别传输到较高级别。从而日志文件中有重复的通讯,或者我必须记住删除低级别的通讯形式并将其转移到更高级别。下面简单地举例。我跳过了创建每个对象的简短代码,但是我认为您理解我的问题

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到更高的级别而没有其他日志,那么我会丢失每个级别发生的信息。

这个怎么解决?私人副本如何沟通?还是我的方法是唯一的好方法?

如果创建一些对象以某种抽象级别在数据库中进行搜索,那么问题将更加令人沮丧,然后在logFile中从同一任务中得到的代码也很少。


阅读 209

收藏
2020-07-02

共1个答案

一尘不染

编辑: 此答案早于Go 1.13,它提供的功能与所介绍的技术类似。请检查The Go Blog:处理Go
1.13中的错误


您应该处理错误,或者不处理错误,而是将错误委托给更高级别(给调用者)。处理错误并返回错误的做法是错误的做法,因为调用方也一样,错误可能会多次处理。

处理错误意味着检查错误并根据该错误做出决定,可能只是将其记录下来,但这也算作“处理”。

如果您选择不处理而是将其委托给更高级别,那可能会很好,但不要仅仅返回您获得的错误值,因为对于没有上下文的调用者而言,它可能毫无意义。

注释错误

一个非常好的推荐方法是 注释错误 。这意味着您创建并返回一个 新的 错误值,但是旧的错误值也被包装在返回的值中。包装器为包装的错误提供了上下文。

没有为标注错误公共图书馆: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递归为a
,从而以递归方式保留了包装的错误: 错误堆栈

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

戴夫·切尼(Dave Cheney):不要只是检查错误,请妥善处理

“扩展”错误

如果您喜欢简单的事物和/或不想麻烦外部库,并且可以提取原始错误(准确的错误 ,而不是可以的错误 字符串
)也可以,那么您可以只需使用上下文扩展错误并返回此新的扩展错误。

扩展错误最简单的方法是使用fmt.Errorf(),它允许您创建“
nice”格式的错误消息,并且它会返回一个type值,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

确保还阅读博客文章:错误处理和执行

2020-07-02