Golang을 사용하여 REST API 응답에 대한 AWS SDK API 오류 코드 처리

Golang에서 AWS SDK 요청의 HTTP 오류 코드 처리

AWS SDK에서 HTTP 오류를 관리하기 위해 모듈식 Golang 백엔드 스크립트 구현

// 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 SDK 오류 처리에 대한 일반적인 질문

1. AWS SDK 오류에서 HTTP 상태 코드를 검색하려면 어떻게 해야 합니까?
2. Golang에서는 AWS SDK 오류가 문자열로 반환되는 경우가 많습니다. 사용자 정의 매핑 또는 스위치 문을 사용하면 오류 코드를 관련 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 SDK 오류를 시뮬레이션할 수 있으므로 코드가 각 오류 유형에 어떻게 반응하는지 검증하는 데 도움이 됩니다.
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 SDK 오류를 디버깅하려면 어떻게 해야 합니까?
20. 예상치 못한 오류의 경우 500(내부 서버 오류)과 같은 기본 상태를 반환하고 나중에 검토할 수 있도록 오류 세부 정보를 기록할 수 있습니다. slog.Error.

AWS SDK 오류 코드 처리를 위한 간소화된 솔루션

Golang API에서 AWS SDK 요청에 대한 강력한 오류 처리 메커니즘을 생성하면 디버깅 시간을 크게 절약하고 개발자 경험을 향상시킬 수 있습니다. 유형 어설션, 오류 매핑 및 사용자 지정 오류 구조를 통해 개발자는 원시 AWS 오류 응답을 읽기 쉽고 실행 가능한 HTTP 코드로 효과적으로 변환할 수 있습니다. 이 설정은 AWS Cognito에서 인증 오류를 처리할 때 특히 유용합니다.

모의 오류와 단위 테스트를 통합하면 다양한 오류 시나리오에서 오류 처리가 안정적으로 이루어집니다. 이러한 기술은 API 품질을 향상시킬 뿐만 아니라 요구 사항이 증가함에 따라 API가 적응성과 유지 관리성을 유지하도록 보장합니다. 이러한 전략을 구현하면 API의 응답성과 프로덕션 사용 준비가 유지됩니다. 🛠️