Menggunakan Golang untuk Menangani Kode Kesalahan API AWS SDK untuk Respons REST API

Menangani Kode Kesalahan HTTP dari Permintaan AWS SDK di Golang

Menerapkan skrip backend Golang modular untuk mengelola kesalahan HTTP dari 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",
    }
}

Mengonversi Kode Kesalahan AWS dengan Pernyataan Tipe di Golang

Menggunakan Pernyataan Tipe untuk Peningkatan Penanganan Kesalahan 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"}
}

Pengujian Unit untuk Fungsi Konversi Kesalahan API AWS

Pengujian berfungsi untuk memvalidasi respons kode status HTTP untuk berbagai kesalahan 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)
    }
}

Pertanyaan Umum tentang Penanganan Kesalahan AWS SDK di Golang

1. Bagaimana cara mengambil kode status HTTP dari kesalahan AWS SDK?
2. Di Golang, kesalahan AWS SDK sering kali dikembalikan sebagai string. Dengan menggunakan pemetaan khusus atau pernyataan peralihan, Anda dapat mencocokkan kode kesalahan dengan kode status HTTP yang relevan.
3. Sedang menggunakan switch menyatakan pendekatan terbaik untuk kode kesalahan AWS?
4. Meskipun Anda dapat menggunakan a switch pernyataan, membuat tabel pemetaan umumnya lebih efisien dan mudah dipelihara, terutama seiring bertambahnya jumlah kode kesalahan.
5. Apa tujuannya errors.As dalam menangani kesalahan AWS?
6. Itu errors.As Fungsi ini memungkinkan Anda memeriksa apakah suatu kesalahan berjenis tertentu, seperti smithy.APIError. Hal ini penting untuk mengidentifikasi kesalahan AWS di Golang secara akurat.
7. Mengapa menggunakan struct kesalahan khusus seperti UsecaseError?
8. Struktur kesalahan khusus memungkinkan Anda memformat respons kesalahan dengan cara yang ramah JSON, sehingga memudahkan aplikasi klien untuk menguraikan dan memahami kesalahan.
9. Bagaimana cara menguji kode penanganan kesalahan AWS SDK secara efektif?
10. Menggunakan kesalahan tiruan dalam pengujian unit memungkinkan Anda untuk mensimulasikan kesalahan AWS SDK tanpa memanggil AWS secara langsung, membantu memvalidasi bagaimana kode Anda merespons setiap jenis kesalahan.
11. Paket apa yang menyediakan konstanta status HTTP di Golang?
12. Itu net/http paket di Golang menawarkan konstanta untuk kode status HTTP, membuatnya mudah untuk menetapkan respons standar yang jelas ke klien API.
13. Apakah mungkin untuk menangkap semua kesalahan AWS dengan satu fungsi?
14. Ya, dengan menggunakan kombinasi errors.As dan tabel atau saklar pemetaan, Anda dapat secara efisien menangkap dan menangani berbagai kesalahan AWS SDK dengan cara yang terpadu.
15. Bisakah tabel pemetaan memperlambat aplikasi saya?
16. Pencarian tabel pemetaan umumnya lebih cepat daripada beberapa pernyataan if-else atau switch. Ini adalah cara yang efisien untuk menangani banyak kode kesalahan dan sangat disarankan untuk pemetaan kesalahan.
17. Mengapa perlu mengonversi kode kesalahan AWS SDK ke kode status HTTP?
18. Memetakan kode kesalahan AWS ke status HTTP memungkinkan API Anda mengembalikan respons standar dan konsisten, yang membantu aplikasi klien memahami sifat kesalahan dengan cepat.
19. Bagaimana cara men-debug kesalahan AWS SDK yang tidak cocok dengan kode kesalahan tertentu?
20. Untuk kesalahan tak terduga, Anda dapat mengembalikan status default seperti 500 (Kesalahan Server Internal) dan mencatat detail kesalahan untuk ditinjau nanti menggunakan slog.Error.

Solusi Sederhana untuk Menangani Kode Kesalahan AWS SDK

Membuat mekanisme penanganan kesalahan yang kuat untuk permintaan AWS SDK di API Golang dapat menghemat waktu debugging secara signifikan dan meningkatkan pengalaman pengembang. Melalui pernyataan tipe, pemetaan kesalahan, dan struktur kesalahan khusus, pengembang dapat secara efektif mengubah respons kesalahan AWS mentah menjadi kode HTTP yang dapat dibaca dan ditindaklanjuti. Pengaturan ini sangat berguna ketika menangani kesalahan autentikasi di AWS Cognito.

Dengan mengintegrasikan pengujian unit dengan kesalahan tiruan, penanganan kesalahan menjadi andal di berbagai skenario kesalahan. Teknik-teknik ini tidak hanya meningkatkan kualitas API tetapi juga memastikan API tetap dapat beradaptasi dan dipelihara seiring dengan meningkatnya kebutuhan. Penerapan strategi ini akan menjaga API tetap responsif dan siap digunakan dalam produksi. 🛠️