„Golang“ naudojimas AWS SDK API klaidų kodams tvarkyti REST API atsakymams

HTTP klaidų kodų tvarkymas iš AWS SDK užklausų Golang

Modulinių Golang backend scenarijų diegimas, siekiant valdyti HTTP klaidas iš 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 klaidų kodų konvertavimas naudojant tipo tvirtinimus Golang

Tipo tvirtinimų naudojimas patobulintam klaidų tvarkymui Golange

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 klaidų konvertavimo funkcijų vienetų testai

Testavimo funkcijos, skirtos HTTP būsenos kodo atsakymams patvirtinti dėl skirtingų AWS API klaidų

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

Dažni klausimai apie AWS SDK klaidų tvarkymą Golange

1. Kaip galiu gauti HTTP būsenos kodus iš AWS SDK klaidų?
2. Golange AWS SDK klaidos dažnai pateikiamos kaip eilutės. Naudodami tinkintą susiejimą arba perjungimo teiginį galite suderinti klaidų kodus su atitinkamais HTTP būsenos kodais.
3. Naudoja switch teiginiai yra geriausias AWS klaidų kodų metodas?
4. Nors galite naudoti a switch Teiginį, susiejimo lentelės kūrimas paprastai yra efektyvesnis ir lengviau prižiūrimas, ypač didėjant klaidų kodų skaičiui.
5. Koks tikslas errors.As tvarkant AWS klaidas?
6. The errors.As funkcija leidžia patikrinti, ar klaida yra konkretaus tipo, pvz smithy.APIError. Tai būtina norint tiksliai nustatyti AWS klaidas Golange.
7. Kodėl verta naudoti pasirinktinę klaidų struktūrą, pvz UsecaseError?
8. Tinkinta klaidų struktūra leidžia formatuoti klaidų atsakymus JSON patogiu būdu, todėl kliento programoms lengviau analizuoti ir suprasti klaidas.
9. Kaip galiu efektyviai išbandyti AWS SDK klaidų apdorojimo kodą?
10. Naudojant netikras klaidas vienetų testuose, galite imituoti AWS SDK klaidas tiesiogiai neiškviečiant AWS, taip padedant patvirtinti, kaip jūsų kodas reaguoja į kiekvieną klaidos tipą.
11. Koks paketas pateikia HTTP būsenos konstantas Golang?
12. The net/http Paketas Golang siūlo HTTP būsenos kodų konstantas, todėl API klientams lengva priskirti aiškius standartinius atsakymus.
13. Ar įmanoma sugauti visas AWS klaidas naudojant vieną funkciją?
14. Taip, naudojant derinį errors.As ir atvaizdavimo lentelę ar jungiklį, galite efektyviai užfiksuoti ir tvarkyti įvairias AWS SDK klaidas vieningai.
15. Ar žemėlapių lentelė gali sulėtinti mano taikomąją programą?
16. Susiejimo lentelės paieška paprastai yra greitesnė nei kelių if-else arba switch teiginių. Tai efektyvus būdas tvarkyti daugybę klaidų kodų ir labai rekomenduojamas klaidų atvaizdavimui.
17. Kodėl reikia konvertuoti AWS SDK klaidų kodus į HTTP būsenos kodus?
18. AWS klaidų kodų susiejimas su HTTP būsenomis leidžia jūsų API grąžinti standartinius, nuoseklius atsakymus, o tai padeda klientų programoms greitai suprasti klaidos pobūdį.
19. Kaip galiu derinti AWS SDK klaidas, kurios neatitinka jokio konkretaus klaidos kodo?
20. Jei atsiranda netikėtų klaidų, galite grąžinti numatytąją būseną, pvz., 500 (vidinė serverio klaida), ir užregistruoti išsamią klaidos informaciją, kad galėtumėte peržiūrėti vėliau naudodami slog.Error.

Supaprastinti AWS SDK klaidų kodų tvarkymo sprendimai

Sukūrus patikimą AWS SDK užklausų klaidų valdymo mechanizmą Golang API, galima sutaupyti daug derinimo laiko ir pagerinti kūrėjo patirtį. Naudodami tipo tvirtinimus, klaidų atvaizdavimą ir pasirinktines klaidų struktūras, kūrėjai gali efektyviai paversti neapdorotus AWS klaidų atsakymus į skaitomus, veiksmingus HTTP kodus. Ši sąranka ypač naudinga dirbant su AWS Cognito autentifikavimo klaidomis.

Integruojant vienetų testus su netikromis klaidomis, klaidų tvarkymas tampa patikimas įvairiuose klaidų scenarijuose. Šie metodai ne tik pagerina API kokybę, bet ir užtikrina, kad augant reikalavimams API būtų pritaikoma ir prižiūrima. Įgyvendinus šias strategijas, API reaguoja ir yra paruošta naudoti gamyboje. 🛠️