文檔 · go-playground/validator中文文檔

Package validator ================= <img align="right" src="https://raw.githubusercontent.com/go-playground/validator/v9/logo.png">[![Join the chat at https://gitter.im/go-playground/validator](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/go-playground/validator?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) ![Project status](https://img.shields.io/badge/version-10.11.1-green.svg) [![Build Status](https://travis-ci.org/go-playground/validator.svg?branch=master)](https://travis-ci.org/go-playground/validator) [![Coverage Status](https://coveralls.io/repos/go-playground/validator/badge.svg?branch=master&service=github)](https://coveralls.io/github/go-playground/validator?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/go-playground/validator)](https://goreportcard.com/report/github.com/go-playground/validator) [![GoDoc](https://godoc.org/github.com/go-playground/validator?status.svg)](https://pkg.go.dev/github.com/go-playground/validator/v10) ![License](https://img.shields.io/dub/l/vibe-d.svg) 包驗證器根據標簽對結構和單個字段進行值驗證。它具有以下**特色**功能：: - 使用驗證標記或自定義驗證器進行跨域和跨結構驗證。 - 切片、陣列和映射潛水，允許驗證多維字段的任何或所有級別。 - 能夠深入地圖鍵和值進行驗證 - 通過在驗證之前確定類型接口的基礎類型來處理該接口。 - 處理自定義字段類型，如sql驅動程序Valuer請參閱 [Valuer](https://golang.org/src/database/sql/driver/types.go?s=1210:1293#L29) - 別名驗證標記，允許將多個驗證映射到單個標記，以便更容易地定義結構上的驗證 - 提取自定義字段名，例如，可以指定在驗證時提取JSON名稱，并在生成的FieldError中提供該名稱 - 可自定義的i18n感知錯誤消息。 - 的默認驗證器 [gin](https://github.com/gin-gonic/gin) web框架；在gin see中從v8升級到v9 [here](https://github.com/go-playground/validator/tree/master/_examples/gin-upgrading-overriding) 安裝 ------------ 使用 go get. go get github.com/go-playground/validator/v10 然后將驗證器包導入到您自己的代碼中。 import "github.com/go-playground/validator/v10" 錯誤返回值 ------- 驗證函數返回類型錯誤它們返回類型錯誤以避免下面討論的問題，其中 err != nil： * http://stackoverflow.com/a/29138676/3158232 * https://github.com/go-playground/validator/issues/134 對于錯誤的驗證輸入，Validator僅返回InvalidValidationError，nil或ValidationErrors作為類型錯誤；因此，在代碼中，您需要做的就是檢查返回的錯誤是否不是nil，如果沒有檢查錯誤是否為InvalidValidationError（如果需要，大多數情況下不是），請將其類型轉換為ValidationErrors，如下所示： ```go err := validate.Struct(mystruct) validationErrors := err.(validator.ValidationErrors) ``` 使用和文檔 ------ 請參見 https://pkg.go.dev/github.com/go-playground/validator/v10 詳細的使用文檔。 ##### 例子: - [簡單](https://github.com/go-playground/validator/blob/master/_examples/simple/main.go) - [自定義字段類型](https://github.com/go-playground/validator/blob/master/_examples/custom/main.go) - [結構層](https://github.com/go-playground/validator/blob/master/_examples/struct-level/main.go) - [翻譯和自定義錯誤](https://github.com/go-playground/validator/blob/master/_examples/translations/main.go) - [Gin 升級和/或覆蓋驗證器](https://github.com/go-playground/validator/tree/v9/_examples/gin-upgrading-overriding) - [wash - 將所有內容組合在一起的示例應用程序](https://github.com/bluesuncorp/wash) 驗證規則 ------ ### Fields: | Tag | 描述 | | - | - | | eqcsfield | 字段等于另一個字段 (相對)| | eqfield | 字段等于另一個字段 | | fieldcontains | NOT DOCUMENTED IN doc.go | | fieldexcludes | NOT DOCUMENTED IN doc.go | | gtcsfield | 大于另一個相關字段的字段 | | gtecsfield | 字段大于或等于另一個相關字段 | | gtefield | 字段大于或等于另一個字段 | | gtfield | 字段大于另一個字段 | | ltcsfield | 小于另一個相關字段 | | ltecsfield | 小于或等于另一個相關字段 | | ltefield | 小于或等于另一個字段 | | ltfield | 小于另一個字段 | | necsfield | 字段不等于另一個字段（相對） | | nefield | 字段不等于另一個字段 | ### Network: | Tag | 描述 | | - | - | | cidr | 無類域間路由 CIDR | | cidrv4 | 無類域間路由 CIDRv4 | | cidrv6 | 無類別域間路由CIDRv6 | | datauri | 資源URL | | fqdn | 完全限定域名 (FQDN) | | hostname | 主機名 RFC 952 | | hostname_port | 主機端口 | | hostname_rfc1123 | 主機名 RFC 1123 | | ip | 互聯網協議地址 IP | | ip4_addr | 互聯網協議地址 IPv4 | | ip6_addr | 互聯網協議地址 IPv6 | | ip_addr | 互聯網協議地址 IP | | ipv4 | 互聯網協議地址 IPv4 | | ipv6 | 互聯網協議地址 IPv6 | | mac | Media Access Control Address MAC | | tcp4_addr | Transmission Control Protocol Address TCPv4 | | tcp6_addr | Transmission Control Protocol Address TCPv6 | | tcp_addr | Transmission Control Protocol Address TCP | | udp4_addr | User Datagram Protocol Address UDPv4 | | udp6_addr | User Datagram Protocol Address UDPv6 | | udp_addr | User Datagram Protocol Address UDP | | unix_addr | Unix domain socket end point Address | | uri | URI String | | url | URL String | | url_encoded | URL Encoded | | urn_rfc2141 | Urn RFC 2141 String | ### Strings: | Tag | 描述 | | - | - | | alpha | 僅限字母 | | alphanum | 字母數字 | | alphanumunicode | 字母數字Unicode | | alphaunicode | 字母Unicode | | ascii | ASCII | | boolean | Boolean | | contains | 包含 | | containsany | 包含任何 | | containsrune | 包含 Rune | | endsnotwith | 結尾不是 | | endswith | Ends With | | excludes | 排除 | | excludesall | Excludes All | | excludesrune | Excludes Rune | | lowercase | 小寫 | | multibyte | 多字節字符 | | number | NOT DOCUMENTED IN doc.go | | numeric | Numeric | | printascii | 可打印的 ASCII | | startsnotwith | Starts Not With | | startswith | Starts With | | uppercase | 大寫 | ### Format: | Tag | 描述 | | - | - | | base64 | Base64 字符串 | | base64url | Base64URL String | | bic | 企業識別碼 (ISO 9362) | | bcp47_language_tag | 語言標簽 (BCP 47) | | btc_addr | 比特幣地址 | | btc_addr_bech32 | 比特幣 Bech32 地址（segwit | | credit_card | 信用卡號 | | datetime | Datetime | | e164 | e164格式電話號碼 | | email | E-mail String | | eth_addr | 以太坊地址 | | hexadecimal | 十六進制字符串 | | hexcolor | 十六進制顏色字符串 | | hsl | HSL String | | hsla | HSLA String | | html | HTML Tags | | html_encoded | HTML編碼 | | isbn | 國際標準書號 | | isbn10 | 國際標準圖書編號10 | | isbn13 | 國際標準圖書編號13 | | iso3166_1_alpha2 | 兩個字母的國家代碼 (ISO 3166-1 alpha-2) | | iso3166_1_alpha3 | 三字母國家代碼 (ISO 3166-1 alpha-3) | | iso3166_1_alpha_numeric | 數字國家代碼（ISO 3166-1 數字） | | iso3166_2 | 國家細分代碼 (ISO 3166-2) | | iso4217 | 貨幣代碼 (ISO 4217) | | json | JSON | | jwt | JSON Web Token (JWT) | | latitude | 緯度 | | longitude | 經度 | | postcode_iso3166_alpha2 | 郵政編碼 | | postcode_iso3166_alpha2_field | 郵政編碼 | | rgb | RGB String | | rgba | RGBA String | | ssn | 社會保障號碼SSN | | timezone | 時區 | | uuid | 通用唯一標識符 UUID | | uuid3 | 通用唯一標識符 UUID v3 | | uuid3_rfc4122 | 通用唯一標識符 UUID v3 RFC4122 | | uuid4 | Universally Unique Identifier UUID v4 | | uuid4_rfc4122 | Universally Unique Identifier UUID v4 RFC4122 | | uuid5 | Universally Unique Identifier UUID v5 | | uuid5_rfc4122 | Universally Unique Identifier UUID v5 RFC4122 | | uuid_rfc4122 | Universally Unique Identifier UUID RFC4122 | | md4 | MD4 hash | | md5 | MD5 hash | | sha256 | SHA256 hash | | sha384 | SHA384 hash | | sha512 | SHA512 hash | | ripemd128 | RIPEMD-128 hash | | ripemd128 | RIPEMD-160 hash | | tiger128 | TIGER128 hash | | tiger160 | TIGER160 hash | | tiger192 | TIGER192 hash | | semver | 語義版本控制 2.0.0 | | ulid | 普遍唯一的字典排序標識符 ULID | ### Comparisons: | Tag | 描述 | | - | - | | eq | 等于 | | gt | 大于| | gte | 大于或等于 | | lt | 小于 | | lte | 小于或等于 | | ne | 不等于 | ### Other: | Tag | 描述 | | - | - | | dir | 目錄 | | file | 文件路徑 | | isdefault | 是默認的 | | len | 長度 | | max | 最大 | | min | 最小 | | oneof | One Of | | required | 必需的 | | required_if | 驗證字段在指定字段等于某個值的情況才是必須的 | | required_unless | 驗證字段在指定字段不等于某個值的情況才是必須的 | | required_with | 驗證字段只有在任一其它指定字段存在的情況才是必須的 | | required_with_all | 驗證字段只有在所有指定字段存在的情況下才是必須的 | | required_without | 驗證字段只有當任一指定字段不存在的情況下才是必須的 | | required_without_all | 驗證字段只有當所有指定字段不存在的情況下才是必須的 | | excluded_if | Excluded If | | excluded_unless | Excluded Unless | | excluded_with | Excluded With | | excluded_with_all | Excluded With All | | excluded_without | Excluded Without | | excluded_without_all | Excluded Without All | | unique | 唯一 | #### Aliases: | Tag | 描述 | | - | - | | iscolor | hexcolor\|rgb\|rgba\|hsl\|hsla | | country_code | iso3166_1_alpha2\|iso3166_1_alpha3\|iso3166_1_alpha_numeric | 基準 ------ ###### Run on MacBook Pro (15-inch, 2017) go version go1.10.2 darwin/amd64 ```go goos: darwin goarch: amd64 pkg: github.com/go-playground/validator BenchmarkFieldSuccess-8 20000000 83.6 ns/op 0 B/op 0 allocs/op BenchmarkFieldSuccessParallel-8 50000000 26.8 ns/op 0 B/op 0 allocs/op BenchmarkFieldFailure-8 5000000 291 ns/op 208 B/op 4 allocs/op BenchmarkFieldFailureParallel-8 20000000 107 ns/op 208 B/op 4 allocs/op BenchmarkFieldArrayDiveSuccess-8 2000000 623 ns/op 201 B/op 11 allocs/op BenchmarkFieldArrayDiveSuccessParallel-8 10000000 237 ns/op 201 B/op 11 allocs/op BenchmarkFieldArrayDiveFailure-8 2000000 859 ns/op 412 B/op 16 allocs/op BenchmarkFieldArrayDiveFailureParallel-8 5000000 335 ns/op 413 B/op 16 allocs/op BenchmarkFieldMapDiveSuccess-8 1000000 1292 ns/op 432 B/op 18 allocs/op BenchmarkFieldMapDiveSuccessParallel-8 3000000 467 ns/op 432 B/op 18 allocs/op BenchmarkFieldMapDiveFailure-8 1000000 1082 ns/op 512 B/op 16 allocs/op BenchmarkFieldMapDiveFailureParallel-8 5000000 425 ns/op 512 B/op 16 allocs/op BenchmarkFieldMapDiveWithKeysSuccess-8 1000000 1539 ns/op 480 B/op 21 allocs/op BenchmarkFieldMapDiveWithKeysSuccessParallel-8 3000000 613 ns/op 480 B/op 21 allocs/op BenchmarkFieldMapDiveWithKeysFailure-8 1000000 1413 ns/op 721 B/op 21 allocs/op BenchmarkFieldMapDiveWithKeysFailureParallel-8 3000000 575 ns/op 721 B/op 21 allocs/op BenchmarkFieldCustomTypeSuccess-8 10000000 216 ns/op 32 B/op 2 allocs/op BenchmarkFieldCustomTypeSuccessParallel-8 20000000 82.2 ns/op 32 B/op 2 allocs/op BenchmarkFieldCustomTypeFailure-8 5000000 274 ns/op 208 B/op 4 allocs/op BenchmarkFieldCustomTypeFailureParallel-8 20000000 116 ns/op 208 B/op 4 allocs/op BenchmarkFieldOrTagSuccess-8 2000000 740 ns/op 16 B/op 1 allocs/op BenchmarkFieldOrTagSuccessParallel-8 3000000 474 ns/op 16 B/op 1 allocs/op BenchmarkFieldOrTagFailure-8 3000000 471 ns/op 224 B/op 5 allocs/op BenchmarkFieldOrTagFailureParallel-8 3000000 414 ns/op 224 B/op 5 allocs/op BenchmarkStructLevelValidationSuccess-8 10000000 213 ns/op 32 B/op 2 allocs/op BenchmarkStructLevelValidationSuccessParallel-8 20000000 91.8 ns/op 32 B/op 2 allocs/op BenchmarkStructLevelValidationFailure-8 3000000 473 ns/op 304 B/op 8 allocs/op BenchmarkStructLevelValidationFailureParallel-8 10000000 234 ns/op 304 B/op 8 allocs/op BenchmarkStructSimpleCustomTypeSuccess-8 5000000 385 ns/op 32 B/op 2 allocs/op BenchmarkStructSimpleCustomTypeSuccessParallel-8 10000000 161 ns/op 32 B/op 2 allocs/op BenchmarkStructSimpleCustomTypeFailure-8 2000000 640 ns/op 424 B/op 9 allocs/op BenchmarkStructSimpleCustomTypeFailureParallel-8 5000000 318 ns/op 440 B/op 10 allocs/op BenchmarkStructFilteredSuccess-8 2000000 597 ns/op 288 B/op 9 allocs/op BenchmarkStructFilteredSuccessParallel-8 10000000 266 ns/op 288 B/op 9 allocs/op BenchmarkStructFilteredFailure-8 3000000 454 ns/op 256 B/op 7 allocs/op BenchmarkStructFilteredFailureParallel-8 10000000 214 ns/op 256 B/op 7 allocs/op BenchmarkStructPartialSuccess-8 3000000 502 ns/op 256 B/op 6 allocs/op BenchmarkStructPartialSuccessParallel-8 10000000 225 ns/op 256 B/op 6 allocs/op BenchmarkStructPartialFailure-8 2000000 702 ns/op 480 B/op 11 allocs/op BenchmarkStructPartialFailureParallel-8 5000000 329 ns/op 480 B/op 11 allocs/op BenchmarkStructExceptSuccess-8 2000000 793 ns/op 496 B/op 12 allocs/op BenchmarkStructExceptSuccessParallel-8 10000000 193 ns/op 240 B/op 5 allocs/op BenchmarkStructExceptFailure-8 2000000 639 ns/op 464 B/op 10 allocs/op BenchmarkStructExceptFailureParallel-8 5000000 300 ns/op 464 B/op 10 allocs/op BenchmarkStructSimpleCrossFieldSuccess-8 3000000 417 ns/op 72 B/op 3 allocs/op BenchmarkStructSimpleCrossFieldSuccessParallel-8 10000000 163 ns/op 72 B/op 3 allocs/op BenchmarkStructSimpleCrossFieldFailure-8 2000000 645 ns/op 304 B/op 8 allocs/op BenchmarkStructSimpleCrossFieldFailureParallel-8 5000000 285 ns/op 304 B/op 8 allocs/op BenchmarkStructSimpleCrossStructCrossFieldSuccess-8 3000000 588 ns/op 80 B/op 4 allocs/op BenchmarkStructSimpleCrossStructCrossFieldSuccessParallel-8 10000000 221 ns/op 80 B/op 4 allocs/op BenchmarkStructSimpleCrossStructCrossFieldFailure-8 2000000 868 ns/op 320 B/op 9 allocs/op BenchmarkStructSimpleCrossStructCrossFieldFailureParallel-8 5000000 337 ns/op 320 B/op 9 allocs/op BenchmarkStructSimpleSuccess-8 5000000 260 ns/op 0 B/op 0 allocs/op BenchmarkStructSimpleSuccessParallel-8 20000000 90.6 ns/op 0 B/op 0 allocs/op BenchmarkStructSimpleFailure-8 2000000 619 ns/op 424 B/op 9 allocs/op BenchmarkStructSimpleFailureParallel-8 5000000 296 ns/op 424 B/op 9 allocs/op BenchmarkStructComplexSuccess-8 1000000 1454 ns/op 128 B/op 8 allocs/op BenchmarkStructComplexSuccessParallel-8 3000000 579 ns/op 128 B/op 8 allocs/op BenchmarkStructComplexFailure-8 300000 4140 ns/op 3041 B/op 53 allocs/op BenchmarkStructComplexFailureParallel-8 1000000 2127 ns/op 3041 B/op 53 allocs/op BenchmarkOneof-8 10000000 140 ns/op 0 B/op 0 allocs/op BenchmarkOneofParallel-8 20000000 70.1 ns/op 0 B/op 0 allocs/op ``` 補充軟件 ---------------------- 這是一個軟件列表，可以在驗證前或驗證后使用該庫進行補充。 * [form](https://github.com/go-playground/form) - 將 url.Values 解碼為 Go 值并將 Go 值編碼為 url.Values。雙陣列和全地圖支持。 * [mold](https://github.com/go-playground/mold) - 幫助修改或設置數據結構和其他對象中的數據的通用庫如何貢獻 ------ Make a pull request... License ------- 在 MIT 許可證下分發，請參閱代碼中的許可證文件以獲取更多詳細信息。維護者 ----------- 這個項目已經發展到足夠大，需要不止一個人來適當地支持社區。如果你有興趣成為維修人員，請聯系我 https://github.com/deankarn