Golang的error处理最佳实践 介绍errors包与自定义错误方法

errors

error

error

nil

if err != nil

errors.New

import "errors"

// 模拟一个简单的文件读取操作
func readFileContent(filename string) (string, error) {
    if filename == "" {
        return "", errors.New("文件名不能为空")
    }
    // 假设这里是实际的文件读取逻辑
    // ...
    return "文件内容", nil
}

fmt.Errorf

import "fmt"

// 模拟一个根据ID查询数据的操作
func queryDataByID(id int) (string, error) {
    if id < 0 {
        return "", fmt.Errorf("无效的ID：%d，ID必须是非负数", id)
    }
    // 假设这里是数据库查询逻辑
    // ...
    return fmt.Sprintf("ID为%d的数据", id), nil
}

fmt.Errorf

%w

error

Error() string

import "fmt"

// 定义一个自定义错误类型，包含操作名和具体错误码
type OperationError struct {
    Op      string // 操作名称，例如 "db.Query", "http.Request"
    Code    int    // 错误码
    Message string // 具体描述
}

// 实现 error 接口的 Error() 方法
func (e *OperationError) Error() string {
    return fmt.Sprintf("操作 %s 失败 (错误码: %d): %s", e.Op, e.Code, e.Message)
}

// 模拟一个可能返回自定义错误的操作
func processUserRequest(requestID string) error {
    if requestID == "" {
        return &OperationError{
            Op:      "processUserRequest",
            Code:    400,
            Message: "请求ID不能为空",
        }
    }
    // 假设其他处理逻辑
    return nil
}

if err != nil

try-catch

try-except

catch

_ = funcThatReturnsError()

if err != nil

errors.New

fmt.Errorf

Error() string

Unwrap() error

package main

import (
    "errors"
    "fmt"
)

// 定义一个自定义错误类型，包含更多上下文信息
type MyServiceError struct {
    Op      string // 操作名称，例如 "userService.GetUser", "db.Insert"
    Kind    string // 错误类型，例如 "NotFound", "PermissionDenied", "InvalidInput", "Internal"
    Message string // 具体的错误信息
    Err     error  // 原始错误，用于包裹底层错误
}

// 实现 error 接口
func (e *MyServiceError) Error() string {
    if e.Err != nil {
        return fmt.Sprintf("服务操作失败 [%s/%s]: %s (原始错误: %v)", e.Op, e.Kind, e.Message, e.Err)
    }
    return fmt.Sprintf("服务操作失败 [%s/%s]: %s", e.Op, e.Kind, e.Message)
}

// Unwrap 方法让 MyServiceError 成为一个可包裹的错误，支持 errors.Is 和 errors.As
func (e *MyServiceError) Unwrap() error {
    return e.Err
}

// 示例：模拟一个获取用户信息的函数，可能返回自定义错误
func GetUser(userID string) error {
    if userID == "" {
        return &MyServiceError{
            Op:      "GetUser",
            Kind:    "InvalidInput",
            Message: "用户ID不能为空",
        }
    }
    if userID == "nonexistent" {
        // 模拟底层数据库错误
        dbErr := errors.New("SQL: no rows in result set")
        return &MyServiceError{
            Op:      "GetUser",
            Kind:    "NotFound",
            Message: fmt.Sprintf("用户 %s 不存在", userID),
            Err:     dbErr, // 包裹底层错误
        }
    }
    return nil // 成功
}

func main() {
    // 示例1: 处理输入错误
    err := GetUser("")
    if err != nil {
        var serviceErr *MyServiceError
        if errors.As(err, &serviceErr) { // 使用 errors.As 提取自定义错误
            fmt.Printf("处理输入错误: 操作=%s, 类型=%s, 消息=%s\n", serviceErr.Op, serviceErr.Kind, serviceErr.Message)
        } else {
            fmt.Printf("捕获到未知错误: %v\n", err)
        }
    }

    // 示例2: 处理用户不存在错误（包含底层错误）
    err = GetUser("nonexistent")
    if err != nil {
        var serviceErr *MyServiceError
        if errors.As(err, &serviceErr) {
            fmt.Printf("处理用户不存在错误: 操作=%s, 类型=%s, 消息=%s\n", serviceErr.Op, serviceErr.Kind, serviceErr.Message)
            if serviceErr.Err != nil {
                fmt.Printf("  原始底层错误: %v\n", serviceErr.Err)
            }
        }
    }
}

MyServiceError

Kind