从应用场景看Go中创建error的多种方式

2023-10-01 09:11:19

使用错误处理时，我们需要小心。如果不正确的使用和管理错误，那么很有可能在你的程序中隐藏错误，它会悄无声息的出现并导致更为严重的后果。Go在设计之初就支持错误处理，它的使用很简单。但Go中创建错误的方式有很多种，如果对其不熟悉，可能会导致编码更加混乱。在本文中，笔者将和大家分享自己对错误处理的理解和经验。

errors.New

errors.New是创建error最基本的方式，它接收一个字符串参数，并将其作为错误消息返回。这个函数会创建一个新的error对象，并将其返回。

err := errors.New("this is an error")

fmt.Errorf

fmt.Errorf函数与errors.New类似，但它允许我们使用格式化字符串来创建错误消息。这使得我们可以动态地生成错误消息，并且可以包含其他信息，例如函数名、行号等。

err := fmt.Errorf("this is an error: %s", "some additional information")

自定义错误

我们可以定义自己的错误类型，并实现error接口。这允许我们创建更具体的错误，并可以携带更多信息。

type MyError struct {
    message string
}

func (e *MyError) Error() string {
    return e.message
}

func NewMyError(message string) *MyError {
    return &MyError{message: message}
}

应用场景

errors.New

errors.New最适合于创建简单的错误消息，这些错误消息不需要包含其他信息。例如，我们可以使用errors.New来创建一个表示文件不存在的错误。

err := errors.New("file not found")

fmt.Errorf

fmt.Errorf最适合于创建更复杂的错误消息，这些错误消息需要包含其他信息。例如，我们可以使用fmt.Errorf来创建一个表示函数调用失败的错误，并包含函数名和行号。

err := fmt.Errorf("function call failed: %s:%d", "myFunction", 10)

自定义错误

自定义错误最适合于创建更具体的错误，这些错误需要携带更多信息。例如，我们可以创建一个表示数据库连接失败的错误，并包含数据库名称和错误代码。

type DatabaseConnectionError struct {
    database string
    errorCode int
}

func (e *DatabaseConnectionError) Error() string {
    return fmt.Sprintf("database connection failed: %s, error code: %d", e.database, e.errorCode)
}

func NewDatabaseConnectionError(database string, errorCode int) *DatabaseConnectionError {
    return &DatabaseConnectionError{database: database, errorCode: errorCode}
}