Request对象支持非常完美的请求校验能力，通过给结构体属性绑定v标签即可。由于底层校验功能通过gvalid模块实现，更详细的校验规则和介绍请参考 数据校验-结构体校验 章节。

需要注意的是，从goframe v1.16版本开始，如果参数采用结构化的输入输出管理，HTTP请求数据校验不再受结构体默认值的影响，底层调用的是gvalid组件的CheckStructWithData方法，即直接使用请求的参数执行数据校验，而给定的结构体对象仅用于校验规则和错误提示信息的定义管理。

示例1，基本使用

我们将之前的示例做下调整，增加v校验标签。

  1. package main
  3. import (
  4.     "github.com/gogf/gf/frame/g"
  5.     "github.com/gogf/gf/net/ghttp"
  6. )
  8. // 注册请求数据结构
  9. type RegisterReq struct {
  10.     Name  string `p:"username"  v:"required|length:6,30#请输入账号|账号长度为:min到:max位"`
  11.     Pass  string `p:"password1" v:"required|length:6,30#请输入密码|密码长度不够"`
  12.     Pass2 string `p:"password2" v:"required|length:6,30|same:password1#请确认密码|密码长度不够|两次密码不一致"`
  13. }
  15. // 注册返回数据结构
  16. type RegisterRes struct {
  17.     Code  int         `json:"code"`
  18.     Error string      `json:"error"`
  19.     Data  interface{} `json:"data"`
  20. }
  22. func main() {
  23.     s := g.Server()
  24.     s.Group("/", func(group *ghttp.RouterGroup) {
  25.         group.ALL("/register", func(r *ghttp.Request) {
  26.             var req *RegisterReq
  27.             if err := r.Parse(&req); err != nil {
  28.                 r.Response.WriteJsonExit(RegisterRes{
  29.                     Code:  1,
  30.                     Error: err.Error(),
  31.                 })
  32.             }
  33.             // ...
  34.             r.Response.WriteJsonExit(RegisterRes{
  35.                 Data: req,
  36.             })
  37.         })
  38.     })
  39.     s.SetPort(8199)
  40.     s.Run()
  41. }

在该示例中，我们定义了两个结构体：RegisterReq用于参数接收，RegisterRes用于数据返回。由于该接口返回的是JSON数据结构，可以看到，只有返回的结构体中存在json标签，而接收的结构体中只有p标签。因为RegisterReq仅用于参数接收，无需设置返回的json标签。

p标签是可选的，默认情况下会通过 忽略特殊字符+不区分大小写 的规则进行属性名称匹配转换，默认匹配规则满足绝大部分业务场景。

为了演示测试效果，这里在正常的返回结果Data属性中将RegisterReq对象返回，由于该对象没有绑定json标签，因此返回的JSON字段将会为其属性名称。

执行后，我们通过curl工具来测试一下：

  1. $ curl "http://127.0.0.1:8199/register?name=john&password1=123456&password2=123456"
  2. {"code":0,"error":"","data":{"Name":"john","Pass":"123456","Pass2":"123456"}}
  4. $ curl "http://127.0.0.1:8199/register?name=john&password1=123456&password2=12345"
  5. {"code":1,"error":"密码长度不够; 两次密码不一致","data":null}
  7. $ curl "http://127.0.0.1:8199/register"
  8. {"code":1,"error":"请输入账号; 账号长度为6到30位; 请输入密码; 密码长度不够; 请确认密码; 两次密码不一致","data":null}

示例2，校验错误处理

可以看到在以上示例中，当请求校验错误时，所有校验失败的错误都返回了，这样对于用户体验不是特别友好。当产生错误时，我们可以将校验错误转换为*gvalid.Error对象，随后可以通过灵活的方法控制错误的返回。

  1. package main
  3. import (
  4.     "github.com/gogf/gf/frame/g"
  5.     "github.com/gogf/gf/net/ghttp"
  6.     "github.com/gogf/gf/util/gvalid"
  7. )
  9. type RegisterReq struct {
  10.     Name  string `p:"username"  v:"required|length:6,30#请输入账号|账号长度为:min到:max位"`
  11.     Pass  string `p:"password1" v:"required|length:6,30#请输入密码|密码长度不够"`
  12.     Pass2 string `p:"password2" v:"required|length:6,30|same:password1#请确认密码|密码长度不够|两次密码不一致"`
  13. }
  15. type RegisterRes struct {
  16.     Code  int         `json:"code"`
  17.     Error string      `json:"error"`
  18.     Data  interface{} `json:"data"`
  19. }
  21. func main() {
  22.     s := g.Server()
  23.     s.Group("/", func(group *ghttp.RouterGroup) {
  24.         group.ALL("/register", func(r *ghttp.Request) {
  25.             var req *RegisterReq
  26.             if err := r.Parse(&req); err != nil {
  27.                 // Validation error.
  28.                 if v, ok := err.(gvalid.Error); ok {
  29.                     r.Response.WriteJsonExit(RegisterRes{
  30.                         Code:  1,
  31.                         Error: v.FirstString(),
  32.                     })
  33.                 }
  34.                 // Other error.
  35.                 r.Response.WriteJsonExit(RegisterRes{
  36.                     Code:  1,
  37.                     Error: err.Error(),
  38.                 })
  39.             }
  40.             // ...
  41.             r.Response.WriteJsonExit(RegisterRes{
  42.                 Data: req,
  43.             })
  44.         })
  45.     })
  46.     s.SetPort(8199)
  47.     s.Run()
  48. }

可以看到，当错误产生后，我们可以通过err.(gvalid.Error)断言的方式判断错误是否为校验错误，如果是的话则返回第一条校验错误，而不是所有都返回。更详细的错误控制方法，请参考 数据校验-校验结果 章节。

此外，我们这里也可以使用gerror.Current获取第一条报错信息，而不是使用断言判断。例如：

  1. var req *RegisterReq
  2. if err := r.Parse(&req); err != nil {
  3.     r.Response.WriteJsonExit(RegisterRes{
  4.         Code:  1,
  5.         Error: gerror.Current(err).Error(),
  6.     })
  7. }

执行后，我们通过curl工具来测试一下：

  1. $ curl "http://127.0.0.1:8199/register"
  2. {"code":1,"error":"请输入账号","data":null}
  4. $ curl "http://127.0.0.1:8199/register?name=john&password1=123456&password2=12345"
  5. {"code":1,"error":"两次密码不一致","data":null}

Content Menu