使用 Golang 处理 REST API 响应的 AWS 开发工具包 API 错误代码

在 Golang 中处理来自 AWS 开发工具包请求的 HTTP 错误代码

实施模块化 Golang 后端脚本来管理 AWS 开发工具包中的 HTTP 错误

// Approach 1: Using a Mapping Table to Convert String Error Codes to HTTP Status Codes
package main

import (
    "errors"
    "fmt"
    "net/http"
    "github.com/aws/smithy-go"
)

// UsecaseError represents the custom error structure for JSON responses
type UsecaseError struct {
    Code    int    `json:"code"`
    Message string `json:"message"`
}

// Error satisfies the error interface for UsecaseError
func (e *UsecaseError) Error() string {
    return fmt.Sprintf(`{"code": %d, "message": "%s"}`, e.Code, e.Message)
}

// Map of AWS error codes to HTTP status codes
var errorCodeMapping = map[string]int{
    "NotAuthorizedException": http.StatusUnauthorized,
    "UserNotFoundException": http.StatusNotFound,
    "TooManyRequestsException": http.StatusTooManyRequests,
    "InternalErrorException": http.StatusInternalServerError,
    // Add additional mappings as necessary
}

// ConvertAWSAPIError handles AWS SDK errors and returns a UsecaseError
func ConvertAWSAPIError(err error) *UsecaseError {
    var apiErr smithy.APIError
    if errors.As(err, &apiErr) {
        code, exists := errorCodeMapping[apiErr.ErrorCode()]
        if exists {
            return &UsecaseError{
                Code:    code,
                Message: apiErr.ErrorMessage(),
            }
        }
    }
    // Default error response
    return &UsecaseError{
        Code:    http.StatusInternalServerError,
        Message: "An unknown error occurred",
    }
}

在 Golang 中使用类型断言转换 AWS 错误代码

使用类型断言改进 Golang 中的错误处理

package main

import (
    "errors"
    "fmt"
    "net/http"
    "github.com/aws/smithy-go"
)

// UsecaseError struct to hold HTTP code and message
type UsecaseError struct {
    Code    int    `json:"code"`
    Message string `json:"message"`
}

func (e *UsecaseError) Error() string {
    return fmt.Sprintf(`{"code": %d, "message": "%s"}`, e.Code, e.Message)
}

// AWSAPIErrorToHTTP maps APIError codes directly to HTTP status codes using type assertions
func AWSAPIErrorToHTTP(err error) *UsecaseError {
    var apiErr smithy.APIError
    if errors.As(err, &apiErr) {
        switch apiErr.ErrorCode() {
        case "NotAuthorizedException":
            return &UsecaseError{Code: http.StatusUnauthorized, Message: apiErr.ErrorMessage()}
        case "UserNotFoundException":
            return &UsecaseError{Code: http.StatusNotFound, Message: apiErr.ErrorMessage()}
        case "TooManyRequestsException":
            return &UsecaseError{Code: http.StatusTooManyRequests, Message: apiErr.ErrorMessage()}
        default:
            return &UsecaseError{Code: http.StatusInternalServerError, Message: apiErr.ErrorMessage()}
        }
    }
    return &UsecaseError{Code: http.StatusInternalServerError, Message: "Unknown error"}
}

AWS API 错误转换函数的单元测试

测试函数以验证不同 AWS API 错误的 HTTP 状态代码响应

package main

import (
    "errors"
    "testing"
    "net/http"
)

// Mock error types for testing
type mockAPIError struct{}

func (e *mockAPIError) ErrorCode() string {
    return "UserNotFoundException"
}

func (e *mockAPIError) ErrorMessage() string {
    return "User not found"
}

func TestConvertAWSAPIError(t *testing.T) {
    mockErr := &mockAPIError{}
    err := ConvertAWSAPIError(mockErr)
    if err.Code != http.StatusNotFound {
        t.Errorf("expected %d, got %d", http.StatusNotFound, err.Code)
    }
}

有关 Golang 中 AWS 开发工具包错误处理的常见问题

1. 如何从 AWS 开发工具包错误中检索 HTTP 状态代码？
2. 在 Golang 中，AWS SDK 错误通常以字符串形式返回。通过使用自定义映射或 switch 语句，您可以将错误代码与相关 HTTP 状态代码进行匹配。
3. 正在使用 switch 声明 AWS 错误代码的最佳方法？
4. 虽然您可以使用 switch 语句，创建映射表通常更高效且可维护，特别是当错误代码数量增加时。
5. 目的是什么 errors.As 处理AWS错误？
6. 这 errors.As 函数允许您检查错误是否属于特定类型，例如 smithy.APIError。这对于准确识别 Golang 中的 AWS 错误至关重要。
7. 为什么使用自定义错误结构，例如 UsecaseError？
8. 自定义错误结构允许您以 JSON 友好的方式格式化错误响应，使客户端应用程序更容易解析和理解错误。
9. 如何有效测试 AWS SDK 错误处理代码？
10. 在单元测试中使用模拟错误允许您模拟 AWS 开发工具包错误，而无需直接调用 AWS，从而帮助验证您的代码如何响应每种错误类型。
11. Golang 中哪个包提供了 HTTP 状态常量？
12. 这 net/http Golang 中的包提供了 HTTP 状态代码常量，可以轻松地为 API 客户端分配清晰、标准的响应。
13. 是否可以使用单个函数捕获所有 AWS 错误？
14. 是的，通过组合使用 errors.As 以及映射表或开关，您可以统一高效地捕获和处理各种AWS SDK错误。
15. 映射表会减慢我的应用程序的速度吗？
16. 映射表查找通常比多个 if-else 或 switch 语句更快。这是处理许多错误代码的有效方法，强烈推荐用于错误映射。
17. 为什么需要将AWS SDK错误代码转换为HTTP状态代码？
18. 将 AWS 错误代码映射到 HTTP 状态允许您的 API 返回标准、一致的响应，这有助于客户端应用程序快速了解错误的性质。
19. 如何调试与任何特定错误代码不匹配的 AWS 开发工具包错误？
20. 对于意外错误，您可以返回默认状态，例如 500（内部服务器错误），并记录错误详细信息以供以后查看 slog.Error。

用于处理 AWS 开发工具包错误代码的简化解决方案

在 Golang API 中为 AWS 开发工具包请求创建强大的错误处理机制可以节省大量调试时间并改善开发人员体验。通过类型断言、错误映射和自定义错误结构，开发人员可以有效地将原始 AWS 错误响应转换为可读、可操作的 HTTP 代码。在处理 AWS Cognito 中的身份验证错误时，此设置特别有用。

通过将单元测试与模拟错误集成，错误处理在不同的错误场景中变得可靠。这些技术不仅提高了 API 质量，还确保 API 随着需求的增长保持适应性和可维护性。实施这些策略可以使 API 保持响应并为生产使用做好准备。 🛠️