Wie kann ich Fehlermeldungen aus der Struct-Tag-Validierung von Go Gin anpassen?

Anpassen von Fehlermeldungen für die Struct-Tag-Validierung in Go Gin

Gin, ein beliebtes Web-Framework für Go, nutzt go-playground/validator/ v10 für Strukturvalidierung. Wenn die Validierung fehlschlägt, werden in der Regel ausführliche Fehlermeldungen zurückgegeben. In diesem Artikel wird erläutert, wie Sie diese Nachrichten anpassen können, um ein benutzerfreundlicheres Erlebnis zu bieten.

Den Fehlertyp verstehen

Der von Gins Validierung zurückgegebene Fehler ist ein validator.ValidationErrors . Dieser Fehlertyp enthält eine Sammlung von validator.FieldErrors, die jeweils ein ungültiges Feld und sein Validierungs-Tag darstellen.

Fehlermeldungen anpassen

Wir können die Fehlermeldungen anpassen Konvertieren Sie „validator.ValidationErrors“ mithilfe der Funktion „errors.As“ in „error“. Nach der Konvertierung können wir auf die einzelnen validator.FieldErrors zugreifen und benutzerdefinierte Fehlermeldungen basierend auf dem verwendeten Validierungs-Tag erstellen.

Erstellen eines benutzerdefinierten Fehlermodells

Zuerst definieren wir ein benutzerdefiniertes Fehlermodell, wie zum Beispiel:

type ApiError struct {
    Field string
    Msg   string
}

Anpassen von Fehlermeldungen für die Validierung Tags

Als nächstes definieren wir eine Hilfsfunktion, um Validierungs-Tags benutzerdefinierten Fehlermeldungen zuzuordnen:

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

Validierungsfehler binden und behandeln

In unserer Handler-Funktion können wir die Anfrage an unsere Struktur binden und auf Validierung prüfen Fehler:

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
}

Beispielausgabe

Mit dieser benutzerdefinierten Fehlerbehandlung können wir eine JSON-Antwort mit dem folgenden Format zurückgeben:

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

Dies bietet dem Benutzer eine benutzerfreundlichere und informativere Fehlerreaktion.

Das obige ist der detaillierte Inhalt vonWie kann ich Fehlermeldungen aus der Struct-Tag-Validierung von Go Gin anpassen?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!