Golang错误处理与HTTP状态码实践

if err != nil

error

AppError

package apperror

import (
    "fmt"
    "net/http"
)

// AppError 封装了应用程序错误，包含HTTP状态码和对用户友好的消息
type AppError struct {
    OriginalErr error  // 原始错误，用于内部日志记录
    StatusCode  int    // HTTP状态码
    Code        string // 业务错误码，可选
    Message     string // 对用户友好的错误消息
}

// Error 实现 error 接口
func (e *AppError) Error() string {
    if e.OriginalErr != nil {
        return fmt.Sprintf("AppError: %s (original: %v)", e.Message, e.OriginalErr)
    }
    return fmt.Sprintf("AppError: %s", e.Message)
}

// Unwrap 实现 errors.Unwrap 接口，方便错误链追踪
func (e *AppError) Unwrap() error {
    return e.OriginalErr
}

// New 创建一个新的 AppError
func New(statusCode int, code, message string, err error) *AppError {
    return &AppError{
        OriginalErr: err,
        StatusCode:  statusCode,
        Code:        code,
        Message:     message,
    }
}

// 辅助函数，用于常见的错误类型
func BadRequest(code, message string, err error) *AppError {
    return New(http.StatusBadRequest, code, message, err)
}

func NotFound(code, message string, err error) *AppError {
    return New(http.StatusNotFound, code, message, err)
}

func InternalServer(code, message string, err error) *AppError {
    return New(http.StatusInternalServerError, code, message, err)
}

// ... 更多辅助函数

package service

import (
    "errors"
    "fmt"
    "myproject/apperror" // 假设你的 apperror 包在这里
)

type User struct {
    ID    string
    Name  string
    Email string
}

// GetUserByID 模拟从数据库获取用户
func GetUserByID(id string) (*User, error) {
    if id == "" {
        // 参数校验失败，返回 400 Bad Request
        return nil, apperror.BadRequest("INVALID_INPUT", "用户ID不能为空", nil)
    }
    if id == "nonexistent" {
        // 用户不存在，返回 404 Not Found
        return nil, apperror.NotFound("USER_NOT_FOUND", fmt.Sprintf("ID为%s的用户不存在", id), nil)
    }
    if id == "db_error" {
        // 模拟数据库错误
        dbErr := errors.New("database connection failed")
        return nil, apperror.InternalServer("DB_ACCESS_FAILED", "系统繁忙，请稍后再试", dbErr)
    }

    // 假设找到用户
    return &User{ID: id, Name: "Test User", Email: "test@example.com"}, nil
}

AppError

OriginalErr

error

package main

import (
    "encoding/json"
    "log"
    "net/http"
    "myproject/apperror" // 假设你的 apperror 包在这里
)

// APIErrorResponse 定义了统一的错误响应结构
type APIErrorResponse struct {
    Code    string `json:"code"`    // 业务错误码
    Message string `json:"message"` // 对用户友好的消息
}

// ErrorHandlerMiddleware 是一个HTTP中间件，用于统一处理错误
func ErrorHandlerMiddleware(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        defer func() {
            if rvr := recover(); rvr != nil {
                // 处理 panic
                log.Printf("Panic recovered: %v", rvr)
                w.WriteHeader(http.StatusInternalServerError)
                json.NewEncoder(w).Encode(APIErrorResponse{
                    Code:    "UNEXPECTED_ERROR",
                    Message: "服务器内部发生未知错误",
                })
            }
        }()

        // 创建一个 ResponseWriter 包装器，捕获写入
        // 实际上，更常见的做法是让 Handler 返回 error，然后在这里处理
        // 这里我们简化，假设 Handler 会直接返回错误
        next.ServeHTTP(w, r)
    })
}

// HandleAppError 是一个辅助函数，用于从 Handler 返回的 error 中提取 AppError 信息
// 并写入 HTTP 响应
func HandleAppError(w http.ResponseWriter, err error) {
    if err == nil {
        return // 没有错误，什么都不做
    }

    // 尝试将错误转换为 AppError
    var appErr *apperror.AppError
    if errors.As(err, &appErr) {
        // 如果是 AppError，使用其定义的 StatusCode 和 Message
        log.Printf("AppError encountered: %v (original: %v)", appErr.Message, appErr.OriginalErr) // 内部记录详细错误
        w.Header().Set("Content-Type", "application/json")
        w.WriteHeader(appErr.StatusCode)
        json.NewEncoder(w).Encode(APIErrorResponse{
            Code:    appErr.Code,
            Message: appErr.Message,
        })
        return
    }

    // 如果不是 AppError，则视为通用内部服务器错误
    log.Printf("Unhandled error: %v", err) // 内部记录详细错误
    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(http.StatusInternalServerError)
    json.NewEncoder(w).Encode(APIErrorResponse{
        Code:    "INTERNAL_SERVER_ERROR",
        Message: "服务器内部错误，请稍后再试",
    })
}

// GetUserHandler 示例 HTTP Handler
func GetUserHandler(w http.ResponseWriter, r *http.Request) {
    userID := r.URL.Query().Get("id")
    user, err := service.GetUserByID(userID) // 调用业务逻辑
    if err != nil {
        HandleAppError(w, err) // 统一处理错误
        return
    }

    w.Header().Set("Content-Type", "application/json")
    json.NewEncoder(w).Encode(user)
}

func main() {
    mux := http.NewServeMux()
    mux.Handle("/users", ErrorHandlerMiddleware(http.HandlerFunc(GetUserHandler))) // 应用中间件

    log.Println("Server starting on :8080")
    log.Fatal(http.ListenAndServe(":8080", mux))
}

ErrorHandlerMiddleware

HandleAppError

HandleAppError

GetUserHandler

HandleAppError

HandleAppError

AppError

AppError