Go Gin의 구조체 태그 유효성 검사에서 오류 메시지를 어떻게 사용자 정의할 수 있나요?

Go Gin에서 구조체 태그 유효성 검사를 위한 오류 메시지 사용자 정의

Go용 인기 웹 프레임워크인 Gin은 go-playground/validator/를 활용합니다. 구조체 유효성 검사를 위한 v10. 유효성 검사가 실패하면 일반적으로 자세한 오류 메시지가 반환됩니다. 이 문서에서는 이러한 메시지를 사용자 정의하여 보다 사용자 친화적인 환경을 제공하는 방법을 살펴봅니다.

오류 유형 이해

Gin의 유효성 검사에서 반환된 오류는 유효성 검사기입니다.ValidationErrors . 이 오류 유형에는 validator.FieldErrors 모음이 포함되어 있으며, 각각은 잘못된 필드와 해당 유효성 검사 태그를 나타냅니다.

오류 메시지 사용자 정의

오류 메시지를 사용자 정의하려면 다음을 수행하세요. error.As 함수를 사용하여 validator.ValidationErrors를 오류로 변환합니다. 변환되면 개별 유효성 검사기.FieldErrors에 액세스하고 사용된 유효성 검사 태그를 기반으로 사용자 정의 오류 메시지를 생성할 수 있습니다.

사용자 정의 오류 모델 생성

먼저 정의합니다. 다음과 같은 사용자 정의 오류 모델:

type ApiError struct {
    Field string
    Msg   string
}

검증을 위한 오류 메시지 사용자 정의 태그

다음으로 검증 태그를 사용자 정의 오류 메시지에 매핑하는 도우미 함수를 정의합니다.

func msgForTag(tag string) string {
    switch tag {
    case "required":
        return "This field is required"
    case "email":
        return "Invalid email"
    }
    return ""
}

검증 오류 바인딩 및 처리

핸들러 함수에서 요청을 구조체에 바인딩하고 유효성 검사를 확인할 수 있습니다. 오류:

var u User
err := c.BindQuery(&u)
if err != nil {
    var ve validator.ValidationErrors
    if errors.As(err, &ve) {
        out := make([]ApiError, len(ve))
        for i, fe := range ve {
            out[i] = ApiError{fe.Field(), msgForTag(fe.Tag())}
        }
        c.JSON(http.StatusBadRequest, gin.H{"errors": out})
    }
    return
}

출력 예

이 사용자 정의 오류 처리를 사용하면 다음 형식으로 JSON 응답을 반환할 수 있습니다.

{
    "errors": [
        {
            "Field": "Number",
            "Msg": "This field is required"
        }
    ]
}

이는 사용자에게 더욱 사용자 친화적이고 유익한 오류 응답을 제공합니다.

위 내용은 Go Gin의 구조체 태그 유효성 검사에서 오류 메시지를 어떻게 사용자 정의할 수 있나요?의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!