1. 引言

github.com/go-playground/validator 是一個 Go 語言的庫，用於對結構體欄位進行驗證。它提供了一種簡單而靈活的方式來定義驗證規則，並在驗證過程中檢查結構體欄位是否滿足這些規則。這個庫可以用於驗證各種資料，包括從使用者輸入到 API 請求中的資料，以確保資料的完整性和有效性。

在這篇文章中，我們將從一個簡單的問題出發，帶你瞭解 Validator 庫的用途，也會介紹Validator 的基本使用，同時也會介紹Validator 能夠給我們帶來的優點。

2. 問題引入

在平常開發過程中，不管是Web應用程式來接收頁面請求，還是建立一個服務來接收其他服務的請求，不可避免的，我們都需要檢查請求引數是否合法，是否有效。

假設我們開發一個使用者註冊功能的 Web 應用程式。使用者在註冊頁面上提供了以下資訊：使用者名稱、電子郵件地址、密碼和確認密碼。那麼我們必須編寫下述程式碼，保證使用者輸入資訊合法性，如下:

type User struct {
        Username string
        Email    string
}

func (u *User) checkUserIsInvalid() error {
    // 檢查使用者名稱長度是否合法
    if len(user.Username) < 3 || len(user.Username) > 20 {
        return errors.New("Invalid username length")
    }
    // 檢查電子郵件地址是否合法
    if !isValidEmail(user.Email) {
        return errors.New("Invalid email address")
    }
    return nil
}
    
func registerUser(user User) error {
    // 檢查輸入是否合法
    err := user.checkUserIsInvalid()
    if err != nil {
        return errors.New("Invalid Input")
    }

    // 使用者註冊邏輯...
    return nil
}

這裡的實現並沒有太大的問題。但是如果程式中有20個地方，都檢查了使用者名稱長度是否合法，如果這個驗證邏輯更復雜一點，那就不太合理了，這裡的一個做法是將驗證邏輯抽取為一個函數，範例如下:

func checkUserNameIsValid(username string) bool{
    if len(username) < 3 || len(username) > 20 {
        return false
    }
    return true
}

然後用到這段邏輯的，直接呼叫該函數即可，不需要再重複實現，這個也能夠解決一部分場景的問題。但是假想一下，如果我們的驗證邏輯不像上面那麼簡單，而是涉及到多個欄位的組合驗證，型別轉換，巢狀結構體的場景，這個時候我們的驗證邏輯會非常複雜。

比如我們需要實現一個巢狀結構體的校驗邏輯，此時我們需要遍歷每一個欄位，可能會有非常深的if...else程式碼，亦或者比較深層次的函數呼叫，這個複雜邏輯不管是實現還是後續的閱讀，都會花費我們大量的精力。

迴歸到我們的訴求，其實我們並不是很關心巢狀了多少層結構體，我們更關注的是針對某一個 欄位/值，其值是否滿足我們的預期。那有沒有辦法，做到我們實現一個驗證邏輯，通過某種手段作用到目標欄位，而不需要去關注具體的資料結構，這樣子既能做到驗證邏輯的複用，同時也避免了對複雜資料結構的解析，從而簡化我們的驗證邏輯。

其實還真有，當前存在大量的驗證庫，能夠幫助我們實現資料驗證。接下來我們就來了解下Go語言中的Validator庫，其能夠讓我們專注於驗證邏輯的編寫，而不需要考慮邏輯的複用以及複雜資料結構的處理等許多問題，同時在某種程度上也提高了程式碼的可讀性。

3. Validator 的基本使用

Validator 是基於標籤來實現的，我們只需要在結構體的欄位上使用 validate 標籤，然後設定標籤值，每一個標籤值代表一個驗證規則。這些標籤值將告訴 validator 結構體的欄位應該滿足哪些條件，然後通過呼叫Validator 提供的 API ，便能夠實現資料的校驗。

下面我們通過一個簡單的例子來進行說明，幫助我們快速入門Validator 庫的使用:

type User struct {
   FirstName      string     `validate:"required"`
   LastName       string     `validate:"required"`
   Age            uint8      `validate:"gte=20,lte=60"`
   Email          string     `validate:"required,email"`
}

func main() {
   validate = validator.New()
   user := &User{
      FirstName:      "Badger",
      LastName:       "Smith",
      Age:            18,
      Email:          "[email protected]",
   }

   // returns nil or ValidationErrors ( []FieldError )
   err := validate.Struct(user)
   if err != nil {
      fmt.Println(err)
   }
}

上面例子中，我們定義了一個 User 結構體，包含了不同型別的欄位，每個欄位都通過validate 標籤定義一些驗證規則。

其中FirstName 和 LastName 都設定了 required 規則，Age 設定了gte=0 和 lte=130 規則，Email 則設定了required 和 email 兩個規則。其中required，gte，lte 和 email 規則是 Validator 庫自帶的校驗規則，可以直接設定。

在結構體設定好驗證規則後，在main 函數中通過New 方法建立一個 Validate 範例，然後通過呼叫Struct 方法，便會自動根據結構體標籤設定的規則對物件的值進行驗證。如果驗證通過，將返回nil，否則會返回一個ValidationErrors型別的錯誤物件，其中包含驗證失敗的詳細資訊。

比如上面Age 欄位不滿足條件，此時user 物件將不能通過校驗，會返回對應的錯誤資訊，如下:

Key: 'User.Age' Error:Field validation for 'Age' failed on the 'gte' tag

4. Validator優點

如果我們使用 Validator 庫，邏輯就可以抽取出來為一個公共的驗證庫，然後每一個驗證邏輯對應一個驗證規則名，這個Validator 庫有支援，後續會講述到。

然後在結構體中，使用validate 標籤指定需要的驗證規則，這樣子我們就不需要待驗證資料的資料結構，也複用了驗證規則，同時將驗證規則與欄位繫結到一起，也提高了程式碼的可讀性。

通過使用Validator 庫，我們能夠迴歸到核心關注的內容，驗證傳入資料的合法性， 而不是去解析資料結構，程式碼複用等一系列複雜的事情，把這些複雜的事情交給 Validator 幫我們做。

5. 總結

本文介紹了 Go 語言中的 github.com/go-playground/validator 庫，該庫用於對結構體欄位進行驗證。文章從一個簡單的問題出發，引入了Validator 庫的使用。

之後介紹了 Validator 庫的基本使用，包括如何建立驗證範例、執行驗證以及處理驗證錯誤。通過範例程式碼，演示瞭如何使用標籤來設定驗證規則，以及如何通過 Validator 庫簡化資料驗證過程，提高程式碼的可讀性和可維護性。

總的來說，在比較複雜的場景，通過使用Validator庫，我們可以專注於驗證邏輯的編寫，而不必擔心資料結構的解析和重複的驗證程式碼，能夠很好得提高程式碼的可讀性和可維護性。

一文了解Validator庫

1. 引言

2. 問題引入

3. Validator 的基本使用

4. Validator優點

5. 總結