Golang使用error接口定义自定义错误

error

Error() string

package main

import (
    "fmt"
    "errors"
)

// MyServiceError 代表一个自定义的服务层错误
// 我个人觉得，错误类型应该尽可能地具体，这样在处理时才能有针对性。
type MyServiceError struct {
    Code    int    // 错误码，用于区分不同类型的错误
    Message string // 给用户或日志的友好提示
    Op      string // 发生错误的操作名称，比如 "GetUser", "SaveOrder"
    Err     error  // 包装的底层错误，如果存在的话
}

// Error 方法实现了 error 接口。
// 在这里，我倾向于提供一个既包含技术细节又易于理解的错误信息。
func (e *MyServiceError) Error() string {
    if e.Err != nil {
        return fmt.Sprintf("operation %s failed [code: %d]: %s (underlying error: %v)", e.Op, e.Code, e.Message, e.Err)
    }
    return fmt.Sprintf("operation %s failed [code: %d]: %s", e.Op, e.Code, e.Message)
}

// Unwrap 方法是 Go 1.13+ 引入的，用于解包被包装的错误。
// 这对于 errors.Is 和 errors.As 来说至关重要。
func (e *MyServiceError) Unwrap() error {
    return e.Err
}

// NewServiceError 是一个构造函数，方便创建 MyServiceError 实例。
// 我喜欢用这种方式封装错误创建，可以统一错误初始化的逻辑。
func NewServiceError(code int, op, msg string, err error) error {
    return &MyServiceError{
        Code:    code,
        Message: msg,
        Op:      op,
        Err:     err,
    }
}

// 模拟一个可能失败的数据库操作
func queryDatabase(id int) error {
    if id < 0 {
        // 这里模拟一个底层错误，比如数据库驱动返回的错误
        return fmt.Errorf("invalid ID provided: %d", id)
    }
    if id == 0 {
        // 模拟一个数据未找到的场景
        return errors.New("record not found")
    }
    return nil
}

// 模拟一个服务层函数，它会调用数据库操作并包装错误
func GetUserDetails(userID int) error {
    err := queryDatabase(userID)
    if err != nil {
        // 我在这里将底层错误包装成 MyServiceError
        // 这样调用者就能获得更多上下文信息
        return NewServiceError(1001, "GetUserDetails", "failed to retrieve user details", err)
    }
    return nil
}

func main() {
    // 正常情况
    err := GetUserDetails(123)
    if err != nil {
        fmt.Println("Unexpected error:", err)
    }

    // 模拟 ID 无效的错误
    err = GetUserDetails(-1)
    if err != nil {
        fmt.Println("Handled error (invalid ID):", err)
        // 使用 errors.As 检查是否是 MyServiceError 类型
        var serviceErr *MyServiceError
        if errors.As(err, &serviceErr) {
            fmt.Printf("  Specific Service Error: Code=%d, Op='%s', Message='%s'\n", serviceErr.Code, serviceErr.Op, serviceErr.Message)
            // 进一步检查底层错误
            if serviceErr.Err != nil {
                fmt.Printf("  Underlying Error: %v\n", serviceErr.Err)
            }
        }
        // 使用 errors.Is 检查是否包装了特定的底层错误
        if errors.Is(err, errors.New("invalid ID provided: -1")) { // 注意：这里需要精确匹配字符串，实际中可能更复杂
            fmt.Println("  Indeed, the underlying error was about an invalid ID.")
        }
    }

    fmt.Println("---")

    // 模拟数据未找到的错误
    err = GetUserDetails(0)
    if err != nil {
        fmt.Println("Handled error (record not found):", err)
        var serviceErr *MyServiceError
        if errors.As(err, &serviceErr) {
            fmt.Printf("  Specific Service Error: Code=%d, Op='%s', Message='%s'\n", serviceErr.Code, serviceErr.Op, serviceErr.Message)
            if serviceErr.Err != nil {
                fmt.Printf("  Underlying Error: %v\n", serviceErr.Err)
                if errors.Is(serviceErr.Err, errors.New("record not found")) {
                    fmt.Println("  The underlying error specifically indicates 'record not found'.")
                }
            }
        }
    }
}

errors.New("something went wrong")

fmt.Errorf("failed to do X: %w", err)

MyServiceError

Code

Message

Op

Err

Code

Message

Op

fmt.Errorf

%w

errors.Is

errors.As

Unwrap() error

errors.Is

errors.As

UserServiceError

OrderServiceError

DatabaseError

errors

UserServiceError

UserNotFound

OrderServiceError

InvalidOrderState

errors.As

errors.Is