Golang中如何为错误添加额外的键值对上下文信息

fmt.Errorf("something failed")

database_name

user_id

request_id

package main

import (
    "errors"
    "fmt"
    "strings"
)

// MyError 是一个自定义错误类型，用于携带额外的键值对上下文
type MyError struct {
    Op      string                 // 操作名称，例如 "GetUserByID"
    Kind    string                 // 错误类型，例如 "NotFound", "DBError"
    Context map[string]interface{} // 键值对形式的上下文
    Err     error                  // 原始错误，用于错误链
}

// Error 方法实现了 error 接口
func (e *MyError) Error() string {
    var sb strings.Builder
    sb.WriteString(fmt.Sprintf("%s: %s", e.Op, e.Kind))
    if len(e.Context) > 0 {
        sb.WriteString(" (context: ")
        first := true
        for k, v := range e.Context {
            if !first {
                sb.WriteString(", ")
            }
            sb.WriteString(fmt.Sprintf("%s=%v", k, v))
            first = false
        }
        sb.WriteString(")")
    }
    if e.Err != nil {
        sb.WriteString(fmt.Sprintf(" -> %v", e.Err))
    }
    return sb.String()
}

// Unwrap 方法实现了 errors.Wrapper 接口，支持错误链
func (e *MyError) Unwrap() error {
    return e.Err
}

// NewMyError 是一个构造函数，方便创建 MyError 实例
func NewMyError(op, kind string, err error, ctx map[string]interface{}) error {
    return &MyError{Op: op, Kind: kind, Context: ctx, Err: err}
}

// -----------------------------------------------------------------------------
// 另一种更常见且推荐的方式：结合结构化日志库
// -----------------------------------------------------------------------------

import (
    "go.uber.org/zap"
    "go.uber.org/zap/zapcore"
)

// 假设我们有一个全局的 zap logger 实例
var logger *zap.Logger

func init() {
    // 生产环境配置
    config := zap.NewProductionConfig()
    config.EncoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
    config.EncoderConfig.LevelKey = "severity" // 兼容某些日志聚合系统
    config.EncoderConfig.CallerKey = "caller"
    config.EncoderConfig.EncodeCaller = zapcore.ShortCallerEncoder
    config.OutputPaths = []string{"stdout"}

    var err error
    logger, err = config.Build()
    if err != nil {
        panic(fmt.Sprintf("failed to initialize zap logger: %v", err))
    }
    defer logger.Sync() // 确保所有缓冲的日志都被刷新
}

// performSomeOperation 模拟一个可能出错的函数，并在日志中添加上下文
func performSomeOperation(userID string, resourceID string) error {
    // 模拟一些业务逻辑，可能失败
    if userID == "invalid" {
        // 在这里，我们不直接修改原始错误，而是在记录错误时添加上下文
        err := errors.New("user ID is invalid")
        logger.Error("failed to process operation",
            zap.String("userID", userID),
            zap.String("resourceID", resourceID),
            zap.String("operation_step", "validation"),
            zap.Error(err), // 原始错误作为 zap.Error 字段
        )
        // 返回一个标准错误，或者一个包装了原始错误的错误
        return fmt.Errorf("operation failed: %w", err)
    }

    // 模拟数据库操作失败
    if resourceID == "nonexistent" {
        dbErr := errors.New("record not found in database")
        // 同样，在日志中添加上下文
        logger.Error("database query failed",
            zap.String("userID", userID),
            zap.String("resourceID", resourceID),
            zap.String("database_table", "users"),
            zap.Error(dbErr),
        )
        return NewMyError("GetUserResource", "DBError", dbErr, map[string]interface{}{
            "userID":     userID,
            "resourceID": resourceID,
            "db_table":   "resources",
        }) // 这里我们返回一个自定义错误，它自身携带了上下文
    }

    // 成功情况
    logger.Info("operation completed successfully",
        zap.String("userID", userID),
        zap.String("resourceID", resourceID),
    )
    return nil
}

func main() {
    // 示例使用自定义错误类型
    originalErr := errors.New("file permission denied")
    errWithContext := NewMyError("OpenFile", "PermissionDenied", originalErr, map[string]interface{}{
        "filePath": "/var/log/app.log",
        "userName": "guest",
    })
    fmt.Println("Custom Error:", errWithContext)

    // 使用 errors.Is 和 errors.As 检查自定义错误
    var myErr *MyError
    if errors.As(errWithContext, &myErr) {
        fmt.Printf("Error Kind: %s, Context: %v\n", myErr.Kind, myErr.Context)
    }

    // 示例使用结构化日志记录错误
    fmt.Println("\n--- Structured Logging Examples ---")
    _ = performSomeOperation("invalid", "123")
    _ = performSomeOperation("user123", "nonexistent")
    _ = performSomeOperation("user456", "resource789")
}

error: connection refused

service=user-auth-service, target_db=user_db, db_host=192.168.1.10:5432, attempt=3

fmt.Errorf