Sử dụng Golang để xử lý mã lỗi API AWS SDK cho phản hồi API REST

Xử lý mã lỗi HTTP từ các yêu cầu AWS SDK ở Golang

Triển khai các tập lệnh phụ trợ Golang theo mô-đun để quản lý lỗi HTTP từ 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",
    }
}

Chuyển đổi mã lỗi AWS bằng xác nhận loại trong Golang

Sử dụng Xác nhận Loại để Cải thiện Xử lý Lỗi trong 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"}
}

Kiểm tra đơn vị cho chức năng chuyển đổi lỗi API AWS

Chức năng kiểm tra để xác thực phản hồi mã trạng thái HTTP đối với các lỗi API AWS khác nhau

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

Các câu hỏi thường gặp về xử lý lỗi AWS SDK ở Golang

1. Làm cách nào tôi có thể truy xuất mã trạng thái HTTP từ lỗi AWS SDK?
2. Ở Golang, lỗi AWS SDK thường được trả về dưới dạng chuỗi. Bằng cách sử dụng ánh xạ tùy chỉnh hoặc câu lệnh chuyển đổi, bạn có thể khớp mã lỗi với mã trạng thái HTTP có liên quan.
3. Đang sử dụng switch tuyên bố cách tiếp cận tốt nhất cho mã lỗi AWS?
4. Trong khi bạn có thể sử dụng một switch tuyên bố, việc tạo bảng ánh xạ thường hiệu quả hơn và dễ bảo trì hơn, đặc biệt khi số lượng mã lỗi tăng lên.
5. Mục đích của việc này là gì errors.As trong việc xử lý lỗi AWS?
6. các errors.As cho phép bạn kiểm tra xem lỗi có thuộc loại cụ thể hay không, chẳng hạn như smithy.APIError. Điều này rất cần thiết để xác định chính xác lỗi AWS ở Golang.
7. Tại sao nên sử dụng cấu trúc lỗi tùy chỉnh như UsecaseError?
8. Cấu trúc lỗi tùy chỉnh cho phép bạn định dạng phản hồi lỗi theo cách thân thiện với JSON, giúp ứng dụng khách phân tích cú pháp và hiểu lỗi dễ dàng hơn.
9. Làm cách nào để kiểm tra mã xử lý lỗi AWS SDK một cách hiệu quả?
10. Việc sử dụng lỗi mô phỏng trong kiểm thử đơn vị cho phép bạn mô phỏng lỗi AWS SDK mà không cần gọi trực tiếp AWS, giúp xác thực cách mã của bạn phản hồi với từng loại lỗi.
11. Gói nào cung cấp hằng số trạng thái HTTP ở Golang?
12. các net/http gói trong Golang cung cấp các hằng số cho mã trạng thái HTTP, giúp dễ dàng chỉ định các phản hồi tiêu chuẩn, rõ ràng cho các ứng dụng khách API.
13. Có thể phát hiện tất cả các lỗi AWS chỉ bằng một chức năng không?
14. Có, bằng cách sử dụng kết hợp errors.As và bảng ánh xạ hoặc bộ chuyển mạch, bạn có thể phát hiện và xử lý các lỗi AWS SDK khác nhau một cách hiệu quả theo cách thống nhất.
15. Bảng ánh xạ có thể làm chậm ứng dụng của tôi không?
16. Việc tra cứu bảng ánh xạ thường nhanh hơn nhiều câu lệnh if-else hoặc switch. Đó là một cách hiệu quả để xử lý nhiều mã lỗi và được khuyến khích sử dụng để lập bản đồ lỗi.
17. Tại sao cần chuyển đổi mã lỗi AWS SDK thành mã trạng thái HTTP?
18. Việc ánh xạ mã lỗi AWS tới trạng thái HTTP cho phép API của bạn trả về các phản hồi tiêu chuẩn, nhất quán, giúp ứng dụng khách nhanh chóng hiểu được bản chất của lỗi.
19. Làm cách nào tôi có thể gỡ lỗi các lỗi AWS SDK không khớp với bất kỳ mã lỗi cụ thể nào?
20. Đối với các lỗi không mong muốn, bạn có thể trả về trạng thái mặc định như 500 (Lỗi Máy chủ Nội bộ) và ghi lại chi tiết lỗi để xem lại sau bằng cách sử dụng slog.Error.

Giải pháp hợp lý để xử lý mã lỗi AWS SDK

Việc tạo cơ chế xử lý lỗi mạnh mẽ cho các yêu cầu AWS SDK trong API Golang có thể tiết kiệm đáng kể thời gian gỡ lỗi và cải thiện trải nghiệm của nhà phát triển. Thông qua xác nhận loại, ánh xạ lỗi và cấu trúc lỗi tùy chỉnh, nhà phát triển có thể chuyển đổi hiệu quả các phản hồi lỗi thô của AWS thành mã HTTP có thể đọc được và có thể thực hiện được. Thiết lập này đặc biệt hữu ích khi xử lý các lỗi xác thực trong AWS Cognito.

Bằng cách tích hợp các bài kiểm tra đơn vị với các lỗi mô phỏng, việc xử lý lỗi trở nên đáng tin cậy trong các tình huống lỗi khác nhau. Những kỹ thuật này không chỉ nâng cao chất lượng API mà còn đảm bảo API vẫn có khả năng thích ứng và bảo trì khi yêu cầu tăng lên. Việc triển khai các chiến lược này giúp API luôn phản hồi nhanh và sẵn sàng để sử dụng trong sản xuất. 🛠️