Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
lseRequestRequest对象支持非常完美的请求校验能力，通过给结构体属性绑定v标签即可。由于底层校验功能通过gvalid模块实现，更详细的校验规则和介绍请参考 数据校验-Struct校验 章节。
| Note |
|---|
需要注意的是，从 |
示例1，基本使用
我们将之前的示例做下调整，增加v校验标签。
| Code Block | ||
|---|---|---|
| ||
package main
import (
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
)
// RegisterReq 注册请求数据结构
type RegisterReq struct {
Name string `p:"username" v:"required|length:4,30#请输入账号|账号长度为:{min}到:{max}位"`
Pass string `p:"password1" v:"required|length:6,30#请输入密码|密码长度不够"`
Pass2 string `p:"password2" v:"required|length:6,30|same:password1#请确认密码|密码长度不够|两次密码不一致"`
}
// RegisterRes 注册返回数据结构
type RegisterRes struct {
Code int `json:"code"`
Error string `json:"error"`
Data interface{} `json:"data"`
}
func main() {
s := g.Server()
s.Group("/", func(group *ghttp.RouterGroup) {
group.ALL("/register", func(r *ghttp.Request) {
var req *RegisterReq
if err := r.Parse(&req); err != nil {
r.Response.WriteJsonExit(RegisterRes{
Code: 1,
Error: err.Error(),
})
}
// ...
r.Response.WriteJsonExit(RegisterRes{
Data: req,
})
})
})
s.SetPort(8199)
s.Run()
} |
在该示例中，我们定义了两个结构体：RegisterReq用于参数接收，RegisterRes用于数据返回。由于该接口返回的是JSON数据结构，可以看到，只有返回的结构体中存在json标签，而接收的结构体中只有p标签。因为RegisterReq仅用于参数接收，无需设置返回的json标签。
| Tip |
|---|
|
为了演示测试效果，这里在正常的返回结果Data属性中将RegisterReq对象返回，由于该对象没有绑定json标签，因此返回的JSON字段将会为其属性名称。
执行后，我们通过curl工具来测试一下：
| Code Block | ||
|---|---|---|
| ||
$ curl "http://127.0.0.1:8199/register?name=john&password1=123456&password2=123456"
{"code":0,"error":"","data":{"Name":"john","Pass":"123456","Pass2":"123456"}}
$ curl "http://127.0.0.1:8199/register?name=john&password1=123456&password2=12345"
{"code":1,"error":"密码长度不够","data":null}
$ curl "http://127.0.0.1:8199/register"
{"code":1,"error":"请输入账号","data":null} |
示例2，校验错误处理
| Tip |
|---|
最新版已经改成只返回第一个错误。 |
可以看到在以上示例中，当请求校验错误时，所有校验失败的错误都返回了，这样对于用户体验不是特别友好。当产生错误时，我们可以将校验错误转换为gvalid.Error接口对象，随后可以通过灵活的方法控制错误的返回。
| Code Block | ||
|---|---|---|
| ||
package main
import (
"github.com/gogf/gf/v2/frame/g"
"github.com/gogf/gf/v2/net/ghttp"
"github.com/gogf/gf/v2/util/gvalid"
)
type RegisterReq struct {
Name string `p:"username" v:"required|length:4,30#请输入账号|账号长度为:min到:max位{min}到:{max}位"`
Pass string `p:"password1" v:"required|length:6,30#请输入密码|密码长度不够"`
Pass2 string `p:"password2" v:"required|length:6,30|same:password1#请确认密码|密码长度不够|两次密码不一致"`
}
type RegisterRes struct {
Code int `json:"code"`
Error string `json:"error"`
Data interface{} `json:"data"`
}
func main() {
s := g.Server()
s.Group("/", func(group *ghttp.RouterGroup) {
group.ALL("/register", func(r *ghttp.Request) {
var req *RegisterReq
if err := r.Parse(&req); err != nil {
// Validation error.
if v, ok := err.(gvalid.Error); ok {
r.Response.WriteJsonExit(RegisterRes{
Code: 1,
Error: v.FirstError().FirstStringError(),
})
}
// Other error.
r.Response.WriteJsonExit(RegisterRes{
Code: 1,
Error: err.Error(),
})
}
// ...
r.Response.WriteJsonExit(RegisterRes{
Data: req,
})
})
})
s.SetPort(8199)
s.Run()
} |
可以看到，当错误产生后，我们可以通过err.(gvalid.Error)断言的方式判断错误是否为校验错误，如果是的话则返回第一条校验错误，而不是所有都返回。更详细的错误控制方法，请参考 数据校验-校验结果 章节。
| Tip | |||||
|---|---|---|---|---|---|
此外，我们这里也可以使用
|
执行后，我们通过curl工具来测试一下：
| Code Block | ||
|---|---|---|
| ||
$ curl "http://127.0.0.1:8199/register"
{"code":1,"error":"请输入账号","data":null}
$ curl "http://127.0.0.1:8199/register?name=john&password1=123456&password2=123451234567"
{"code":1,"error":"两次密码不一致","data":null} |
| Panel | ||
|---|---|---|
| ||
|