简化 Go 中的字符串验证：validatorgo 简介-Golang-PHP中文网

Simplifying String Validation in Go: Introducing validatorgo

基於 js 庫 validator.js 的字串驗證器和消毒器庫

為什麼選擇驗證器go？

為什麼不使用流行的 Go 庫，如 Package validator 或 govalidator？雖然這兩個函式庫都很出名，但validatorgo 專注於獨立字串驗證，並提供了受validator.js 啟發的廣泛的可自訂驗證器集合，而這兩個Go 庫都沒有完全實現。

以下是 validatorgo 與 go-playground/validator 和 govalidator 相比的突出之處：

1. 與 go-playground/validator 相比

直接字串驗證：go-playground/validator 主要用於使用標籤驗證結構字段，這非常適合處理 JSON 或基於結構的資料。然而，它並不是為驗證單一字串而設計的，ValidatorGo 可以無縫地驗證單一字串，而不需要結構標籤或額外的設定。
效能：go-playground/validator 依賴反射來動態檢查結構標籤。反射雖然功能強大，但會帶來效能開銷，尤其是在驗證大型或複雜資料結構時。 validatorgo 避免了反射，從而提高了效能，對於需要單一欄位驗證的場景來說，速度更快、效率更高。

2. 與 asasskevich/govalidator 相比

自訂和靈活性：govalidator 為字串提供了一系列驗證器，但是 validatorgo 透過允許單一驗證器的特定選項和配置來增強靈活性。例如，可以自訂日期格式或區域設定規範，使開發人員能夠更好地控制根據專案需求量身定制的驗證規則。

項目動機

我創建了 validatorgo 作為另一個名為 ginvalidator 的 Go 庫的依賴項，該庫驗證 Go Web 應用程式中的 HTTP 請求。受 Express-validator（Node.js 和 Express 的流行驗證庫）的啟發，ValidatorGo 填補了 Go 生態系統中的空白，實現高效、可自訂且簡單的字串驗證。由於其他庫要么矯枉過正，缺乏功能，要么不滿足我的用例，我構建了 validatorgo 來提供實用的解決方案。

安裝

使用 go get。

 go get github.com/bube054/validatorgo

登录后复制

然後將套件匯入到您自己的程式碼中。

 import (
   "fmt"
   "github.com/bube054/validatorgo"
 )

登录后复制

如果您不滿意使用長 validatorgo 套件名稱，您可以這樣做。

 import (
   "fmt"
   vgo "github.com/bube054/validatorgo"
 )

登录后复制

Simple validator example

 func main(){
   id := "5f2a6c69e1d7a4e0077b4e6b"
   validId := vgo.IsMongoID(id)
   fmt.Println(validId) // true
 }

登录后复制

Some Validators

Below is a list of validators provided by the validatorgo package, which covers various string formats and types, making it versatile for multiple validation needs.

驗證器	描述
包含	檢查字串是否包含指定的子字串。
等於	驗證字串是否完全等於比較字串。
IsAbaRouting	檢查字串是否為有效的 ABA 路由號碼（美國銀行帳戶）。
之後	驗證日期字串是否在指定日期之後。
IsAlpha	確保字串僅包含字母 (a-zA-Z)。
是字母數字	驗證字串是否僅包含字母和數字。
是Ascii	檢查字串是否僅包含 ASCII 字元。
IsBase32	檢查字串是否為有效的 Base32 編碼值。
IsBase64	驗證字串是否採用 Base64 編碼。
之前	確保日期早於指定日期。
是布林值	檢查字串是「true」還是「false」。
是信用卡	驗證字串是否為有效的信用卡號。
是貨幣	檢查字串是否為有效的貨幣格式。
是日期	驗證字串是否為有效日期。
是十進位	確保字串代表有效的十進制數。
是電子郵件	檢查字串是否為有效的電子郵件地址格式。
為空	驗證字串是否為空。
是FQDN	檢查字串是否是完全限定的網域名稱。
IsFloat	確保字串表示浮點數。
IsHexColor	驗證字串是否為有效的十六進位顏色（例如，#FFFFFF）。
IsIP	檢查字串是否為有效的 IP 位址（IPv4 或 IPv6）。
是ISO8601	驗證字串是否採用 ISO8601 日期格式。
長度	檢查字串的長度是否在指定範圍內。
IsMimeType	驗證字串是否為有效的 MIME 類型。
是手機	檢查字串是否是指定區域設定的有效手機號碼。
IsMongoID	驗證字串是否是有效的 MongoDB ObjectID。
是數字	確保字串僅包含數字字元。
是郵遞區號	檢查字串是否是指定區域設定的有效郵遞區號。
IsRFC3339	驗證字串是否採用 RFC3339 日期格式。
是鼻涕蟲	檢查字串是否適合 URL（僅限字母、數字和破折號）。
密碼強	確保字串符合常見密碼強度要求。
IsURL	Validates if the string is a URL.
IsUUID	Checks if the string is a valid UUID (versions 1-5).
IsUpperCase	Ensures the string is all uppercase.
IsVAT	Checks if the string is a valid VAT number for specified countries.
Matches	Validates if the string matches a specified regular expression.

This table should cover most validators currently available in validatorgo. Make sure to refer to the package's documentation for more detailed usage of each validator.

⚠ Caution

When using a validator that requires an options struct (either a pointer or non-pointer), always provide values for all the struct fields explicitly.
Unlike in validator.js, where missing fields are automatically set to defaults, Go uses strict types.
This means missing values will default to false for booleans, 0 for number types, etc.
Not specifying all fields could lead to unexpected behavior if you're used to the JavaScript version.

Examples

  // do this (using the default options specified in the docs)
  ok := validatorgo.IsFQDN("example", nil)

  // or this (explicitly setting all possible fields for the structs)
  ok := validatorgo.IsFQDN("example", &validatorgo.IsFQDNOpts{
    RequireTld: false,
    AllowUnderscores: false,
    AllowTrailingDot: true,
    AllowNumericTld: false,
    IgnoreMaxLength: true
  })

  // but rarely this(not explicitly setting all possible fields)
  ok := validatorgo.IsFQDN("example", &validatorgo.IsFQDNOpts{ RequireTld: false, })

登录后复制

Simple sanitizer example

  import (
   "fmt"
   "github.com/bube054/validatorgo/sanitizer"
 )

 func main(){
   str := sanitizer.Whitelist("Hello123 World!", "a-zA-Z")
   fmt.Println(str) // "HelloWorld"
 }

登录后复制

Sanitizers

Sanitizer	Description
Trim	Removes whitespace from both ends of the string.
LTrim	Removes whitespace from the left side of the string.
RTrim	Removes whitespace from the right side of the string.
ToLower	Converts the entire string to lowercase.
ToUpper	Converts the entire string to uppercase.
Escape	Escapes HTML characters in the string to prevent injection attacks.
Unescape	Reverts escaped HTML characters back to normal characters.
NormalizeEmail	Standardizes an email address, e.g., removing dots in Gmail addresses.
Blacklist	Removes characters from the string that match specified characters or patterns.
Whitelist	Retains only characters in the string that match specified characters or patterns.
Replace	Replaces occurrences of a substring with a specified replacement.
StripLow	Removes control characters, optionally allowing some specified ones.
TrimSpace	Trims all types of whitespace from both ends of the string.
ToBoolean	Converts common truthy and falsy values in strings into boolean true or false.
ToInt	Converts a numeric string into an integer, if possible.
ToFloat	Converts a numeric string into a floating-point number, if possible.