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 ルーティング番号 (米国の銀行口座) であるかどうかを確認します。
後のもの	日付文字列が指定された日付より後であるかどうかを検証します。
アルファです	文字列に文字 (a-zA-Z) のみが含まれていることを確認します。
は英数字です	文字列に文字と数字のみが含まれているかどうかを検証します。
IsAscii	文字列に ASCII 文字のみが含まれているかどうかを確認します。
IsBase32	文字列が有効な Base32 エンコード値であるかどうかを確認します。
IsBase64	文字列が Base64 エンコードであるかどうかを検証します。
IsBefore	日付が指定された日付より前であることを確認します。
IsBoolean	文字列が「true」か「false」かをチェックします。
クレジットカードです	文字列が有効なクレジット カード番号であるかどうかを検証します。
通貨	文字列が有効な通貨形式であるかどうかを確認します。
IsDate	文字列が有効な日付であるかどうかを検証します。
10 進数です	文字列が有効な 10 進数を表していることを確認します。
メールです	文字列が有効な電子メール アドレス形式であるかどうかを確認します。
空です	文字列が空かどうかを検証します。
FQDN です	文字列が完全修飾ドメイン名であるかどうかを確認します。
IsFloat	文字列が浮動小数点数を表していることを確認します。
IsHexColor	文字列が有効な 16 進カラー (例: #FFFFFF) かどうかを検証します。
IIP	文字列が有効な IP アドレス (IPv4 または IPv6) かどうかを確認します。
ISO8601	文字列が ISO8601 日付形式であるかどうかを検証します。
長さ	文字列の長さが指定された範囲内にあるかどうかを確認します。
IsMimeType	文字列が有効な MIME タイプであるかどうかを検証します。
携帯電話です	文字列が指定されたロケールで有効な携帯電話番号であるかどうかを確認します。
IsMongoID	文字列が有効な MongoDB ObjectID であるかどうかを検証します。
は数値	文字列に数字のみが含まれていることを確認します。
郵便番号です	文字列が指定されたロケールで有効な郵便番号であるかどうかを確認します。
RFC3339	文字列が RFC3339 日付形式であるかどうかを検証します。
ナメクジです	文字列が URL に適しているかどうかを確認します (文字、数字、ダッシュのみ)。
IsStrongPassword	文字列が一般的なパスワード強度要件を満たしていることを確認します。
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.

These sanitizers are often used to ensure data consistency and security by stripping out or modifying potentially unwanted or dangerous characters.

Make sure to refer to the official validatorgo documentation for specific implementations and examples of each sanitizer.

Summary

validatorgo is the ideal choice if you need:

• Efficient, reflection-free validations for individual fields without the performance costs associated with struct-based reflection.
• Highly customizable validation options that align with modern data formats, providing the same robustness as validator.js.

With validatorgo, you get a tool specifically designed for string validation, supporting both standalone and web application requirements in Go.

Maintainers

• bube054 - Attah Gbubemi David (author)

The above is the detailed content of Simplifying String Validation in Go: Introducing validatorgo. For more information, please follow other related articles on the PHP Chinese website!