Использование Golang для обработки кодов ошибок API AWS SDK для ответов REST API

Обработка кодов ошибок HTTP из запросов AWS SDK в Golang

Реализация модульных серверных сценариев Golang для управления ошибками HTTP из AWS SDK.

// 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",
    }
}

Преобразование кодов ошибок AWS с утверждениями типов в Golang

Использование утверждений типа для улучшенной обработки ошибок в 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"}
}

Модульные тесты для функций преобразования ошибок API AWS

Функции тестирования для проверки ответов кода состояния HTTP на наличие различных ошибок API AWS.

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)
    }
}

Общие вопросы по обработке ошибок AWS SDK в Golang

1. Как получить коды состояния HTTP из ошибок AWS SDK?
2. В Golang ошибки AWS SDK часто возвращаются в виде строк. Используя пользовательское сопоставление или оператор переключения, вы можете сопоставить коды ошибок с соответствующими кодами состояния HTTP.
3. Использует switch заявления о наилучшем подходе к кодам ошибок AWS?
4. Хотя вы можете использовать switch Как правило, создание таблицы сопоставления, как правило, более эффективно и удобно в обслуживании, особенно по мере увеличения количества кодов ошибок.
5. Какова цель errors.As при обработке ошибок AWS?
6. errors.As Функция позволяет проверить, относится ли ошибка к определенному типу, например smithy.APIError. Это важно для точного выявления ошибок AWS в Golang.
7. Зачем использовать специальную структуру ошибок, например UsecaseError?
8. Пользовательская структура ошибок позволяет форматировать ответы об ошибках в формате JSON, что упрощает анализ и понимание ошибок клиентскими приложениями.
9. Как эффективно протестировать код обработки ошибок AWS SDK?
10. Использование макетов ошибок в модульных тестах позволяет моделировать ошибки AWS SDK без прямого вызова AWS, помогая проверить, как ваш код реагирует на каждый тип ошибок.
11. Какой пакет предоставляет константы статуса HTTP в Golang?
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 SDK, которые не соответствуют какому-либо конкретному коду ошибки?
20. В случае непредвиденных ошибок вы можете вернуть статус по умолчанию, например 500 (внутренняя ошибка сервера), и записать сведения об ошибке для последующего просмотра с помощью slog.Error.

Оптимизированные решения для обработки кодов ошибок AWS SDK

Создание надежного механизма обработки ошибок для запросов AWS SDK в Golang API может существенно сэкономить время на отладку и улучшить качество работы разработчиков. С помощью утверждений типов, сопоставлений ошибок и пользовательских структур ошибок разработчики могут эффективно преобразовывать необработанные ответы об ошибках AWS в читаемые и действенные HTTP-коды. Эта настройка особенно полезна при работе с ошибками аутентификации в AWS Cognito.

Благодаря интеграции модульных тестов с ложными ошибками обработка ошибок становится надежной в различных сценариях ошибок. Эти методы не только повышают качество API, но и гарантируют, что API останется адаптируемым и поддерживаемым по мере роста требований. Реализация этих стратегий обеспечивает отзывчивость API и его готовность к использованию в рабочей среде. 🛠️