Menggunakan Golang untuk Mengendalikan Kod Ralat API SDK AWS untuk Respons API REST

Mengendalikan Kod Ralat HTTP daripada Permintaan AWS SDK di Golang

Melaksanakan skrip bahagian belakang Golang modular untuk mengurus ralat HTTP daripada 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",
    }
}

Menukar Kod Ralat AWS dengan Jenis Penegasan dalam Golang

Menggunakan Penegasan Jenis untuk Pengendalian Ralat yang Diperbaiki di 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"}
}

Ujian Unit untuk Fungsi Penukaran Ralat API AWS

Fungsi ujian untuk mengesahkan respons kod status HTTP untuk ralat API AWS yang berbeza

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

Soalan Lazim mengenai Pengendalian Ralat SDK AWS di Golang

1. Bagaimanakah saya boleh mendapatkan semula kod status HTTP daripada ralat AWS SDK?
2. Di Golang, ralat AWS SDK sering dikembalikan sebagai rentetan. Dengan menggunakan pemetaan tersuai atau pernyataan suis, anda boleh memadankan kod ralat dengan kod status HTTP yang berkaitan.
3. sedang menggunakan switch menyatakan pendekatan terbaik untuk kod ralat AWS?
4. Walaupun anda boleh menggunakan a switch kenyataan, mencipta jadual pemetaan secara amnya lebih cekap dan boleh diselenggara, terutamanya apabila bilangan kod ralat meningkat.
5. Apakah tujuan errors.As dalam mengendalikan ralat AWS?
6. The errors.As fungsi membolehkan anda menyemak sama ada ralat adalah daripada jenis tertentu, seperti smithy.APIError. Ini penting untuk mengenal pasti ralat AWS di Golang dengan tepat.
7. Mengapa menggunakan struct ralat tersuai seperti UsecaseError?
8. Struktur ralat tersuai membolehkan anda memformat respons ralat dengan cara yang mesra JSON, menjadikannya lebih mudah untuk aplikasi klien menghuraikan dan memahami ralat.
9. Bagaimanakah saya boleh menguji kod pengendalian ralat SDK AWS dengan berkesan?
10. Menggunakan ralat olok-olok dalam ujian unit membolehkan anda mensimulasikan ralat SDK AWS tanpa memanggil AWS secara langsung, membantu mengesahkan cara kod anda bertindak balas kepada setiap jenis ralat.
11. Pakej apakah yang menyediakan pemalar status HTTP di Golang?
12. The net/http pakej dalam Golang menawarkan pemalar untuk kod status HTTP, menjadikannya mudah untuk memberikan respons standard yang jelas kepada pelanggan API.
13. Adakah mungkin untuk menangkap semua ralat AWS dengan satu fungsi?
14. Ya, dengan menggunakan gabungan errors.As dan jadual pemetaan atau suis, anda boleh menangkap dan mengendalikan pelbagai ralat SDK AWS dengan cekap dengan cara yang bersatu.
15. Bolehkah jadual pemetaan memperlahankan permohonan saya?
16. Carian jadual pemetaan biasanya lebih pantas daripada berbilang kenyataan if-else atau suis. Ia merupakan cara yang cekap untuk mengendalikan banyak kod ralat dan amat disyorkan untuk pemetaan ralat.
17. Mengapakah perlu untuk menukar kod ralat AWS SDK kepada kod status HTTP?
18. Pemetaan kod ralat AWS kepada status HTTP membolehkan API anda mengembalikan respons yang standard dan konsisten, yang membantu aplikasi klien memahami sifat ralat dengan cepat.
19. Bagaimanakah saya boleh menyahpepijat ralat SDK AWS yang tidak sepadan dengan mana-mana kod ralat tertentu?
20. Untuk ralat yang tidak dijangka, anda boleh mengembalikan status lalai seperti 500 (Ralat Pelayan Dalaman) dan log butiran ralat untuk semakan kemudian menggunakan slog.Error.

Penyelesaian Diperkemas untuk Mengendalikan Kod Ralat SDK AWS

Mencipta mekanisme pengendalian ralat yang teguh untuk permintaan AWS SDK dalam API Golang boleh menjimatkan masa penyahpepijatan yang ketara dan meningkatkan pengalaman pembangun. Melalui penegasan jenis, pemetaan ralat dan struktur ralat tersuai, pembangun boleh mengubah respons ralat AWS mentah secara berkesan kepada kod HTTP yang boleh dibaca dan boleh diambil tindakan. Persediaan ini amat berguna apabila bekerja dengan ralat pengesahan dalam AWS Cognito.

Dengan menyepadukan ujian unit dengan ralat olok-olok, pengendalian ralat menjadi boleh dipercayai merentas senario ralat yang berbeza. Teknik ini bukan sahaja meningkatkan kualiti API tetapi juga memastikan API kekal boleh disesuaikan dan diselenggara apabila keperluan berkembang. Melaksanakan strategi ini memastikan API responsif dan bersedia untuk kegunaan pengeluaran. 🛠️