请求校验

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

示例1,基本使用

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

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

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

为了演示测试效果,这里在正常的返回结果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"}}
  3. $ curl "http://127.0.0.1:8199/register?name=john&password1=123456&password2=12345"
  4. {"code":1,"error":"密码长度不够; 两次密码不一致","data":null}
  5. $ curl "http://127.0.0.1:8199/register"
  6. {"code":1,"error":"请输入账号; 账号长度为6到30位; 请输入密码; 密码长度不够; 请确认密码; 两次密码不一致","data":null}

示例2,校验错误处理

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

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

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

执行后,我们通过curl工具来测试一下:

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