iris的model驗證

12th鐵人賽 golang iris go

kirai

2020-10-11 00:27:38

1230 瀏覽

分享至

model驗證

介紹完query string以及form POST之後相信大家對於使用者提交請求的處理有一些概念，所以今天再跟大家介紹一下如何利用iris來驗證model。

本文同步放置於此

model驗證

什麼是model的驗證呢，就是檢查提交的資料是不是符合網站規範，所以接下來先跟大家為什麼要驗證，再來就是跟大家分享如何做，首先先跟大家說明為什麼要驗證。

model為什麼要驗證

試想一下當提交一個註冊個人資料的請求時如果漏掉使用者名稱，或者使用者名稱的格式不符合網站規範，那在處理的過程是不是很困擾呢，所以如果有個方式可以先篩選不合格的請求，並且可以提示使用者哪裡需要調整，這樣可以提昇服務的效能也可以兼顧使用者體驗，所以接下來我們使用iris-go model-validation這範例來說明如何在iris驗證model。

iris怎麼驗證model

接下來跟大家介紹該如何驗證model，首先要請大家安裝下列套件，因為我們要使用這套件來驗證，所以請大家先安裝下列套件

$ go get github.com/go-playground/validator/v10@latest

安裝好相依的套件後接下來繼續說明，首先先定義下列model

// User contains user information.
type User struct {
    FirstName      string     `json:"fname"`
    LastName       string     `json:"lname"`
    Age            uint8      `json:"age" validate:"gte=0,lte=130"`
    Email          string     `json:"email" validate:"required,email"`
    FavouriteColor string     `json:"favColor" validate:"hexcolor|rgb|rgba"`
    Addresses      []*Address `json:"addresses" validate:"required,dive,required"`
}

// Address houses a users address information.
type Address struct {
    Street string `json:"street" validate:"required"`
    City   string `json:"city" validate:"required"`
    Planet string `json:"planet" validate:"required"`
    Phone  string `json:"phone" validate:"required"`
}

上面的model除了宣告屬性以外還定義對應到json屬性的名稱，以及最後面的驗證內容包括是否必填required以及其他的格式檢查。
接下來要怎麼使用呢，請大家看看下列例子


    // Use a single instance of Validate, it caches struct info.
    v := validator.New()

    // Register a custom struct validation for 'User'
    // NOTE: only have to register a non-pointer type for 'User', validator
    // internally dereferences during it's type checks.
    v.RegisterStructValidation(UserStructLevelValidation, User{})

    app := iris.New()
    // Register the validator to the Iris Application.
    app.Validator = v

func UserStructLevelValidation(sl validator.StructLevel) {
    user := sl.Current().Interface().(User)

    if len(user.FirstName) == 0 && len(user.LastName) == 0 {
        sl.ReportError(user.FirstName, "FirstName", "fname", "fnameorlname", "")
        sl.ReportError(user.LastName, "LastName", "lname", "fnameorlname", "")
    }
}

上面例子介紹給大家如何註冊驗證器，並且綁定該驗證器到iris的app內，接下來大家看看如何將使用者的請求放到定義好的model內


    app.Post("/user", func(ctx iris.Context) {
        var user User

        // Returns InvalidValidationError for bad validation input,
        // nil or ValidationErrors ( []FieldError )
        err := ctx.ReadJSON(&user)
        if err != nil {
            // This check is only needed when your code could produce
            // an invalid value for validation such as interface with nil
            // value most including myself do not usually have code like this.
            if _, ok := err.(*validator.InvalidValidationError); ok {
                ctx.StatusCode(iris.StatusInternalServerError)
                ctx.WriteString(err.Error())
                return
            }

            ctx.StatusCode(iris.StatusBadRequest)
            for _, err := range err.(validator.ValidationErrors) {
                fmt.Println()
                fmt.Println(err.Namespace())
                fmt.Println(err.Field())
                fmt.Println(err.StructNamespace())
                fmt.Println(err.StructField())
                fmt.Println(err.Tag())
                fmt.Println(err.ActualTag())
                fmt.Println(err.Kind())
                fmt.Println(err.Type())
                fmt.Println(err.Value())
                fmt.Println(err.Param())
                fmt.Println()
            }

            return
        }

上面說明在ReadJson這方法被呼叫時會將資料傳到model並且且驗證該必要資料甚至於資料內容是否符合格式，並且將錯誤的地方放到err之中。