一文瞭解Validator庫

来源:https://www.cnblogs.com/chenjiazhan/archive/2023/09/01/17672768.html
-Advertisement-
Play Games

java中要實現excel新老格式的轉換比較麻煩,開源庫也沒幾個好用的。用ChatGpt查詢也是推薦直接用POI,下麵是藉助ChatGPT寫出來的代碼,經過小小修改,格式轉換良好,基本能用,就是效率比較低下。將就著用吧,哎! /** * Excel格式從xls轉換成xlsx格式 * * @param ...


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 標簽定義一些驗證規則。

其中FirstNameLastName 都設置了 required 規則,Age 設置了gte=0lte=130 規則,Email 則設置了requiredemail 兩個規則。其中requiredgtelteemail 規則是 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庫,我們可以專註於驗證邏輯的編寫,而不必擔心數據結構的解析和重覆的驗證代碼,能夠很好得提高代碼的可讀性和可維護性。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 我喜歡Kusto (或商用版本 Azure Data Explorer,簡稱 ADX) 是大家可以有目共睹的,之前還專門寫過這方面的書籍,請參考 [大數據分析新玩法之Kusto寶典](https://kusto.book.xizhang.com), 很可能在今年還會推出第二季,正在醞釀題材和場景中。 ...
  • 本章詳細指導了你如何安裝 HarmonyOS SDK、配置開發環境、創建 HarmonyOS 項目。現在,你已經準備好開始 HarmonyOS 開發了。 ...
  • TV屏使用遙控器控制,通過焦點操作界面,就跟電視投屏類似 一共兩個核心,焦點的處理,按鍵的監聽處理 按鍵原生提供了onKeyDown 來監聽,通過不同的 keyCode 區分不同的按鍵 一般如果沒有遙控器,可以通過電腦鍵盤測試,使用投屏軟體投屏後,對鍵盤按鍵效果跟遙控器類似 有時候沒有實體按鍵(比如 ...
  • 寫博客也有一個月了,發現博客園自帶的主題都不太好看,然後搜索了一下發現這款主題【Cnblogs-Theme-SimpleMemory】界面還挺好看的,也是開源的。那[西瓜程式猿]就以這個主題來介紹一下如何在博客園中進行配置,跟著一起來操作吧! ...
  • # 概述 Content-Type和Accept是兩個HTTP標頭(HTTP headers),用於在HTTP請求和響應之間傳遞有關請求的數據類型和響應的首選內容類型的信息。這兩個標頭在HTTP通信中起著關鍵的作用。 1. Content-Type: - `Content-Type` 是HTTP請求 ...
  • # ExpressJS集成express-ws [TOC] ## 版本 ```JSON "express": "~4.16.1", "express-ws": "^5.0.2", ``` ## 簡單使用 - app.js ```JS const express = require('express' ...
  • # vscode使用圖片所遇到的問題 1、截屏出來的圖片放到像素大廚量時發現量出來的像素太大 解決方法一: 設置設計圖為2x,這樣能把誤差降低很多,但跟實際大小還是差了一些,可以自己在微調。如下圖所示 ![屏幕截圖 2023-09-01 135647](https://gitee.com/zheng ...
  • 導語 一開始我們就說過Kafka是一款開源的高吞吐、分散式的消息隊列系統,那麼今天我們就來說下它的分散式架構和高可用性以及雙/多中心部署。 Kafka 體系架構簡介 以下是 Kafka 的軟體架構,整個 Kafka 體繫結構由 Producer、Consumer、Broker、ZooKeeper 組 ...
一周排行
    -Advertisement-
    Play Games
  • 示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後,項目結構如下所示: MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread] 特性用於需要與 COM 組件交互的應用程式,尤其是依賴單線程模型(如 Windows Forms 應用程式)的組件。在 STA 模式下,線程擁有自己的消息迴圈,這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • 在WinForm中使用全局異常捕獲處理 在WinForm應用程式中,全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理,可以有效地捕獲並處理未預見的異常,從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • 前言 給大家推薦一款開源的 Winform 控制項庫,可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫,同時也提供了工具類庫、擴展 ...
  • 說明 該文章是屬於OverallAuth2.0系列文章,每周更新一篇該系列文章(從0到1完成系統開發)。 該系統文章,我會儘量說的非常詳細,做到不管新手、老手都能看懂。 說明:OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友,請關註我吧(*^▽^*) ...
  • 一、下載安裝 1.下載git 必須先下載並安裝git,再TortoiseGit下載安裝 git安裝參考教程:https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit,Git客戶端,32/6 ...
  • 前言 在項目開發過程中,理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼,還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程:Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 一:背景 1. 講故事 前段時間有位朋友找到我,說他的窗體程式在客戶這邊出現了卡死,讓我幫忙看下怎麼回事?dump也生成了,既然有dump了那就上 windbg 分析吧。 二:WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死,入口門檻很低,後續往下分析就不一定了,不管怎麼說先用 !clrsta ...
  • 前言 人工智慧時代,人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API,工具不僅易於集成,還具備高效處理能力。 本文將介紹一款如何利用這些API,為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...