Golang驗證器之validator是使用詳解

前言

對於HTTP請求，我們要在腦子裡有一個根深蒂固的概念，那就是任何使用者端傳過來的資料都是不可信任的。那麼開發介面的時候需要對使用者端傳提交的引數進行引數校驗，如果提交的引數只有一個兩個，這樣我們可以簡單寫個if判斷，那麼要是有很多的引數校驗，那麼滿屏都是引數校驗的if判斷，效率不僅低還不美觀，接下來我們介紹一個引數校驗器validator。

什麼是validator

Validator 是一個 Golang 的第三方庫，用於對資料進行校驗，常用於 API 的開發中，對使用者端發出的請求資料進行嚴格校驗，防止惡意請求。

安裝

validator包安裝：

go get -u github.com/go-playground/validator/v10

使用方法

匯入validator：

import "github.com/go-playground/validator/v10"

validator 應用了 Golang 的 Struct Tag 和 Reflect機制，基本思想是：在 Struct Tag 中為不同的欄位定義各自型別的約束，然後通過 Reflect 獲取這些約束的型別資訊並在校驗器中進行資料校驗。

範例：

package main

import (
	"fmt"
	"github.com/go-playground/validator/v10"
)

type User struct {
	UserName string `json:"user_name" validate:"required"`
	Password string `json:"password" validate:"required,min=6,max=20"`
}
func main() {
	example := User{
		Password: "123",
	}
 
	//範例化驗證器
	validate  := validator.New() 

	errs := validate.Struct(example)
	if errs != nil {
		for _, err := range errs.(validator.ValidationErrors) {
			fmt.Println(err)
		}
	}

}

validator包的驗證提示預設是英文的，輸出如下：

這樣看可能不太清楚，如果需要翻譯成中文則還需安裝驗證提示翻譯包：

go get -u github.com/go-playground/locales
go get -u github.com/go-playground/universal-translator

修改後如下:

package main

import (
	"fmt"
	"github.com/go-playground/locales/zh"
	ut "github.com/go-playground/universal-translator"
	"github.com/go-playground/validator/v10"
	zh_translations "github.com/go-playground/validator/v10/translations/zh"
)

type User struct {
	UserName string `json:"user_name" validate:"required"`
	Password string `json:"password" validate:"required,min=6,max=20"`
}
func main() {
	example := User{
		Password: "123",
	}
	// 中文翻譯器
	uni := ut.New(zh.New())
	trans, _ := uni.GetTranslator("zh")

	//範例化驗證器
	validate  := validator.New()
	// 註冊翻譯器到校驗器
	err := zh_translations.RegisterDefaultTranslations(validate, trans)
	if err!=nil {
		fmt.Println(err)
		return
	}

	errs := validate.Struct(example)
	if errs != nil {
		for _, err := range errs.(validator.ValidationErrors) {
			fmt.Println(err.Translate(trans))
		}
	}

}

執行輸出：

校驗規則

下面列舉一部分我們開發中經常用到的驗證規則，詳細驗證規則可以參考檔案：

https://pkg.go.dev/gopkg.in/go-playground/validator.v10

跨欄位驗證

validator 允許定義跨欄位驗證，即：驗證某個欄位與其他欄位之間的關係。這種驗證實際上分為兩種：

• 一種是引數欄位就是同一個結構體中的平級欄位。
• 另一種是引數欄位為結構中其他欄位的欄位。

驗證語法很簡單，如果是驗證同一個結構中的欄位，則在基礎的 Tags 後面新增一個 field 字尾，例如：eqfield 定義欄位間的相等（eq）約束。如果是更深層次的欄位，在 field 之前還需要加上 cs（Cross-Struct），eq 就變為了 eqcsfield。

• eqfield=Field：必須等於 Field 的值。
• nefield=Field：必須不等於 Field 的值。
• gtfield=Field：必須大於 Field 的值。
• gtefield=Field： 必須大於等於 Field 的值。
• ltfield=Field：必須小於 Field 的值。
• ltefield=Field：必須小於等於 Field 的值。
• eqcsfield=Other.Field：必須等於 struct Other 中 Field 的值。
• necsfield=Other.Field：必須不等於 struct Other 中 Field 的值。
• gtcsfield=Other.Field：必須大於 struct Other 中 Field 的值；
• gtecsfield=Other.Field：必須大於等於 struct Other 中 Field 的值。
• ltcsfield=Other.Field：必須小於 struct Other 中 Field 的值。
• ltecsfield=Other.Field：必須小於等於 struct Other 中 Field 的值。

另外還有幾個常用的 Tag：

• required_with=Field1 Field2：在 Field1 或者 Field2 存在時，必須；
• required_with_all=Field1 Field2：在 Field1 與 Field2 都存在時，必須；
• required_without=Field1 Field2：在 Field1 或者 Field2 不存在時，必須；
• required_without_all=Field1 Field2：在 Field1 與 Field2 都存在時，必須；

錯誤處理

通過看原始碼，我們可以看到validator 返回的錯誤有兩種，一種是引數錯誤，一種是校驗錯誤，它們都實現了 error 介面。

• 引數錯誤時，返回 InvalidValidationError 型別；
• 校驗錯誤時，返回 ValidationErrors 型別。ValidationErrors 是一個錯誤切片，儲存了每個欄位違反的每個約束資訊。

所以 validator 校驗返回的結果有 3 種情況：

• nil：沒有錯誤；
• InvalidValidationError：輸入引數錯誤；
• ValidationErrors：欄位違反約束。

validator 返回的錯誤有兩種，一種是引數錯誤，一種是校驗錯誤，它們都實現了 error 介面。

引數錯誤時，返回 InvalidValidationError 型別；

校驗錯誤時，返回 ValidationErrors 型別。ValidationErrors 是一個錯誤切片，儲存了每個欄位違反的每個約束資訊。

所以 validator 校驗返回的結果只有 3 種情況：

nil：沒有錯誤；

InvalidValidationError：輸入引數錯誤；

ValidationErrors：欄位違反約束。

我們可以在程式中判斷 err != nil 時，可以依次將 err轉換為 InvalidValidationError 和 ValidationErrors 以獲取更詳細的資訊：

err := validate.Struct(user)
if err != nil {
    invalid, ok := err.(*validator.InvalidValidationError)
      if ok {
        fmt.Println("param error:", invalid)
        return
    }
    
    validationErrs := err.(validator.ValidationErrors)
    for _, validationErr := range validationErrs {
        fmt.Println(validationErr)
    }
}

小結

通過以上的內容我們瞭解了validator一些基本的功能和用法，在我們開發中大大提高了開發效率。

validator功能非常豐富，使用較為簡單方便。它的應用非常廣泛，建議瞭解一下。

到此這篇關於Golang驗證器之validator是使用詳解的文章就介紹到這了,更多相關Golang validator內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！