Skip to content

Commit 58ff03c

Browse files
inhereinhere
committed
style: update zh and en readme, add more docs
1 parent f6a433d commit 58ff03c

File tree

2 files changed

+94
-21
lines changed

2 files changed

+94
-21
lines changed

‎README.md

+22-10
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
`validate` is a generic Go data validate and filter tool library.
1111

1212
- Support quick validate `Map`, `Struct`, `Request`(`Form`, `JSON`, `url.Values`, `UploadedFile`) data
13+
- Supports checking each child value in a slice. eg: `v.StringRule("tags.*", "required|string|minlen:1")`
14+
- Validating `http.Request` automatically collects data based on the request `Content-Type` value
1315
- Support filter/sanitize data before validate
1416
- Support add custom filter/validator func
1517
- Support scene settings, verify different fields in different scenes
@@ -32,13 +34,11 @@
3234

3335
## Validate Struct
3436

35-
### Config the struct use tags
36-
37-
Use the `validate` tag of the structure, you can quickly verify a structure data.
37+
Use the `validate` tag of the structure, you can quickly config a structure.
3838

39-
**`v1.2.1+` Update**:
39+
### Config the struct use tags
4040

41-
Can use `message` and `label` tags, config the field translates and error messages on struct.
41+
Field translations and error messages for structs can be quickly configured using the `message` and `label` tags.
4242

4343
- Support configuration field mapping through structure tag, read the value of `json` tag by default
4444
- Support configuration error message via structure's `message` tag
@@ -235,7 +235,8 @@ func main() {
235235

236236
## Validate Request
237237

238-
If it is an HTTP request, you can quickly validate the data and pass the verification. Then bind the secure data to the structure.
238+
If it is an HTTP request, you can quickly validate the data and pass the verification.
239+
Then bind the secure data to the structure.
239240

240241
```go
241242
package main
@@ -320,7 +321,7 @@ v := d.Validation()
320321

321322
## More Usage
322323

323-
### Validate error
324+
### Validate Error
324325

325326
`v.Errors` is map data, top key is field name, value is `map[string]string`.
326327

@@ -415,7 +416,7 @@ type GlobalOption struct {
415416
}
416417
```
417418

418-
Usage:
419+
**Usage**:
419420

420421
```go
421422
// change global opts
@@ -433,9 +434,11 @@ validate.Config(func(opt *validate.GlobalOption) {
433434
import "github.com/gookit/validate/locales/zhcn"
434435

435436
// for all Validation.
436-
// NOTICE: must be register before on validate.New()
437+
// NOTICE: must be registered before on validate.New(), it only need call at once.
437438
zhcn.RegisterGlobal()
438439

440+
// ... ...
441+
439442
v := validate.New()
440443

441444
// only for current Validation
@@ -464,7 +467,16 @@ v.AddMessages(map[string]string{
464467
})
465468
```
466469

467-
- For a struct
470+
- Use struct tags: `message, label`
471+
472+
```go
473+
type UserForm struct {
474+
Name string `validate:"required|minLen:7" label:"User Name"`
475+
Email string `validate:"email" message:"email is invalid" label:"User Email"`
476+
}
477+
```
478+
479+
- Use struct method `Messages()`
468480

469481
```go
470482
// Messages you can custom validator error messages.

‎README.zh-CN.md

+72-11
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@
99

1010
Go通用的数据验证与过滤库，使用简单，内置大部分常用验证器、过滤器，支持自定义消息、字段翻译。
1111

12+
- 简单方便，支持前置验证检查, 支持添加自定义验证器
1213
- 支持验证 `Map` `Struct` `Request`（`Form`，`JSON`，`url.Values`, `UploadedFile`）数据
14+
- 支持检查 slice 中的每个子项值. eg: `v.StringRule("tags.*", "required|string|minlen:1")`
1315
- 验证 `http.Request` 时会自动根据请求数据类型 `Content-Type` 收集数据
14-
- 简单方便，支持前置验证检查, 支持添加自定义验证器
1516
- 支持将规则按场景进行分组设置，不同场景验证不同的字段
1617
- 已经内置了超多（**>70** 个）常用的验证器，查看 [内置验证器](#built-in-validators)
1718
- 支持在进行验证前对值使用过滤器进行净化过滤，适应更多场景
@@ -34,18 +35,17 @@ Please see the English introduction **[README](README.md)**
3435

3536
## 验证结构体(Struct)
3637

37-
结构体可以实现3个接口方法，方便做一些自定义：
38+
在结构体上添加 `validate`标签，可以快速对一个结构体进行验证设置。
3839

39-
- `ConfigValidation(v *Validation)` 将在创建验证器实例后调用
40-
- `Messages() map[string]string` 可以自定义验证器错误消息
41-
- `Translates() map[string]string` 可以自定义字段映射/翻译
40+
### 使用标签快速配置验证
4241

43-
**`v1.2.1+` 更新**:
42+
可以搭配使用 `message` 和 `label` 标签，快速配置结构体的字段翻译和错误消息。
4443

4544
- 支持通过结构体配置字段输出名称，默认读取 `json` 标签的值
4645
- 支持通过结构体的 `message` tag 配置错误消息
4746
- 支持通过结构体的 `label` tag 字段映射/翻译
4847

48+
**代码示例**:
4949

5050
```go
5151
package main
@@ -59,18 +59,60 @@ import (
5959

6060
// UserForm struct
6161
type UserForm struct {
62-
Name string `validate:"required|minLen:7"`
62+
Name string `validate:"required|min_len:7" message:"required:{field} is required" label:"用户名称"`
6363
Email string `validate:"email" message:"email is invalid" label:"用户邮箱"`
64-
Age int `validate:"required|int|min:1|max:99" message:"int:age must int| min: age min value is 1"`
64+
Age int `validate:"required|int|min:1|max:99" message:"int:age must int|min:age min value is 1"`
6565
CreateAt int `validate:"min:1"`
66+
Safe int `validate:"-"` // 标记字段安全无需验证
67+
UpdateAt time.Time `validate:"required" message:"update time is required"`
68+
Code string `validate:"customValidator"`
69+
// 结构体嵌套
70+
ExtInfo struct{
71+
Homepage string `validate:"required" label:"用户主页"`
72+
CityName string
73+
} `validate:"required" label:"扩展信息"`
74+
}
75+
76+
// CustomValidator custom validator in the source struct.
77+
func (f UserForm) CustomValidator(val string) bool {
78+
return len(val) == 4
79+
}
80+
```
81+
82+
### 使用结构体方法配置验证
83+
84+
结构体可以实现3个接口方法，方便做一些自定义：
85+
86+
- `ConfigValidation(v *Validation)` 将在创建验证器实例后调用
87+
- `Messages() map[string]string` 可以自定义验证器错误消息
88+
- `Translates() map[string]string` 可以自定义字段映射/翻译
89+
90+
**代码示例**:
91+
92+
```go
93+
package main
94+
95+
import (
96+
"fmt"
97+
"time"
98+
99+
"github.com/gookit/validate"
100+
)
101+
102+
// UserForm struct
103+
type UserForm struct {
104+
Name string `validate:"required|minLen:7"`
105+
Email string `validate:"email"`
106+
Age int `validate:"required|int|min:1|max:99"`
66107
Safe int `validate:"-"`
108+
CreateAt int `validate:"min:1"`
67109
UpdateAt time.Time `validate:"required"`
68110
Code string `validate:"customValidator"` // 使用自定义验证器
69111
// 结构体嵌套
70112
ExtInfo struct{
71113
Homepage string `validate:"required"`
72114
CityName string
73-
}
115+
} `validate:"required"`
74116
}
75117

76118
// CustomValidator 定义在结构体中的自定义验证器
@@ -80,7 +122,10 @@ func (f UserForm) CustomValidator(val string) bool {
80122

81123
// ConfigValidation 配置验证
82124
// - 定义验证场景
125+
// - 也可以添加验证设置
83126
func (f UserForm) ConfigValidation(v *validate.Validation) {
127+
// v.StringRule()
128+
84129
v.WithScenes(validate.SValues{
85130
"add": []string{"ExtInfo.Homepage", "Name", "Code"},
86131
"update": []string{"ExtInfo.CityName", "Name"},
@@ -103,14 +148,19 @@ func (f UserForm) Translates() map[string]string {
103148
"ExtInfo.Homepage": "用户主页",
104149
}
105150
}
151+
```
106152

153+
### 创建和调用验证
154+
155+
```go
107156
func main() {
108157
u := &UserForm{
109158
Name: "inhere",
110159
}
111160

112161
// 创建 Validation 实例
113162
v := validate.Struct(u)
163+
// 或者使用
114164
// v := validate.New(u)
115165

116166
if v.Validate() { // 验证成功
@@ -335,7 +385,7 @@ type GlobalOption struct {
335385
}
336386
```
337387

338-
如何配置:
388+
**如何配置**:
339389

340390
```go
341391
// 更改全局选项
@@ -353,9 +403,11 @@ type GlobalOption struct {
353403
import "github.com/gookit/validate/locales/zhcn"
354404

355405
// for all Validation.
356-
// NOTICE: must be register before on validate.New()
406+
// NOTICE: 必须在调用 validate.New() 前注册, 它只需要一次调用。
357407
zhcn.RegisterGlobal()
358408

409+
// ... ...
410+
359411
v := validate.New()
360412

361413
// only for current Validation
@@ -384,6 +436,15 @@ v.AddMessages(map[string]string{
384436
})
385437
```
386438

439+
- 使用结构体标签: `message, label`
440+
441+
```go
442+
type UserForm struct {
443+
Name string `validate:"required|minLen:7" label:"用户名称"`
444+
Email string `validate:"email" message:"email is invalid" label:"用户邮箱"`
445+
}
446+
```
447+
387448
- 结构体可以通过 `Messages()` 方法添加
388449

389450
```go

0 commit comments

Comments
 (0)