mirror of
https://github.com/chai2010/advanced-go-programming-book.git
synced 2025-05-29 16:22:21 +00:00
125 lines
4.3 KiB
Markdown
125 lines
4.3 KiB
Markdown
# 6.4. validator 请求校验
|
||
|
||
社区里曾经有人用这张图来嘲笑 PHP：
|
||
|
||
|
||
|
||
实际上这是一个语言无关的场景，需要进行字段校验的情况有很多，web 系统的 Form/json 提交只是一个典型的例子。我们用 go 来写一个类似上图的校验 demo。然后研究怎么一步步对其进行改进。
|
||
|
||
## 重构请求校验函数
|
||
|
||
假设我们的数据已经通过某个 binding 库绑定到了具体的 struct 上。
|
||
|
||
```go
|
||
type RegisterReq struct {
|
||
Username string `json:"username"`
|
||
PasswordNew string `json:"password_new"`
|
||
PasswordRepeat string `json:"password_repeat"`
|
||
Email string `json:"email"`
|
||
}
|
||
|
||
func register(req RegisterReq) error{
|
||
if len(req.Username) > 0 {
|
||
if len(req.PasswordNew) > 0 && len(req.PasswordRepeat) > 0 {
|
||
if req.PasswordNew == req.PasswordRepeat {
|
||
if emailFormatValid(req.Email) {
|
||
createUser()
|
||
return nil
|
||
} else {
|
||
return errors.New("invalid email")
|
||
}
|
||
} else {
|
||
return errors.New("password and reinput must be the same")
|
||
}
|
||
} else {
|
||
return errors.New("password and password reinput must be longer than 0")
|
||
}
|
||
} else {
|
||
return errors.New("length of username cannot be 0")
|
||
}
|
||
}
|
||
```
|
||
|
||
我们在 golang 里成功写出了 hadoken 开路的箭头型代码。。这种代码一般怎么进行优化呢？
|
||
|
||
很简单，在《重构》一书中已经给出了方案：[Guard Clauses](https://refactoring.com/catalog/replaceNestedConditionalWithGuardClauses.html)。
|
||
|
||
```go
|
||
func register(req RegisterReq) error{
|
||
if len(req.Username) == 0 {
|
||
return errors.New("length of username cannot be 0")
|
||
}
|
||
|
||
if len(req.PasswordNew) == 0 || len(req.PasswordRepeat) == 0 {
|
||
return errors.New("password and password reinput must be longer than 0")
|
||
}
|
||
|
||
if req.PasswordNew != req.PasswordRepeat {
|
||
return errors.New("password and reinput must be the same")
|
||
}
|
||
|
||
if emailFormatValid(req.Email) {
|
||
return errors.New("invalid email")
|
||
}
|
||
|
||
createUser()
|
||
return nil
|
||
}
|
||
```
|
||
|
||
代码更清爽，看起来也不那么别扭了。这是比较通用的重构理念。虽然使用了重构方法使我们的 validate 过程看起来优雅了，但我们还是得为每一个 http 请求都去写这么一套差不多的 validate 函数，有没有更好的办法来帮助我们解除这项体力劳动？答案就是 validator。
|
||
|
||
## 用 validator 解放体力劳动
|
||
|
||
从设计的角度讲，我们一定会为每个请求都声明一个 struct。前文中提到的校验场景我们都可以通过 validator 完成工作。还以前文中的 struct 为例。为了美观起见，我们先把 json tag 省略掉。
|
||
|
||
这里我们引入一个新的 validator 库：
|
||
|
||
> https://github.com/go-playground/validator
|
||
|
||
```go
|
||
import "gopkg.in/go-playground/validator.v9"
|
||
|
||
type RegisterReq struct {
|
||
// 字符串的 gt=0 表示长度必须 > 0，gt = greater than
|
||
Username string `validate:"gt=0"`
|
||
// 同上
|
||
PasswordNew string `validate:"gt=0"`
|
||
// eqfield 跨字段相等校验
|
||
PasswordRepeat string `validate:"eqfield=PasswordNew"`
|
||
// 合法 email 格式校验
|
||
Email string `validate:"email"`
|
||
}
|
||
|
||
func validate(req RegisterReq) error {
|
||
err := validate.Struct(mystruct)
|
||
if err != nil {
|
||
doSomething()
|
||
}
|
||
...
|
||
}
|
||
|
||
```
|
||
|
||
这样就不需要在每个请求进入业务逻辑之前都写重复的 validate 函数了。本例中只列出了这个 validator 非常简单的几个功能。
|
||
|
||
我们试着跑一下这个程序，输入参数设置为：
|
||
|
||
```go
|
||
//...
|
||
|
||
var req = RegisterReq {
|
||
Username : "Xargin",
|
||
PasswordNew : "ohno",
|
||
PasswordRepeat : "ohn",
|
||
Email : "alex@abc.com",
|
||
}
|
||
|
||
err := validate.Struct(mystruct)
|
||
fmt.Println(err) // Key: 'RegisterReq.PasswordRepeat' Error:Field validation for 'PasswordRepeat' failed on the 'eqfield' tag
|
||
```
|
||
|
||
如果觉得这个 validator 提供的错误信息不够人性化，例如要把错误信息返回给用户，那就不应该直接显示英文了。可以针对每种 tag 进行错误信息订制，读者可以自行探索。
|
||
|
||
## 原理
|