基本介绍

校验结果为一个error错误对象,内部使用gvalid.Error对象实现。当数据规则校验成功时,校验方法返回的结果为nil。当数据规则校验失败时,返回的该对象是包含结构化的层级map,包含多个字段及其规则及对应错误信息,以便于接收端能够准确定位错误规则。相关数据结构及方法如下:https://pkg.go.dev/github.com/gogf/gf/v2/util/gvalid

  1. type Error interface {
  2. Code() gcode.Code
  3. Current() error
  4. Error() string
  5. FirstItem() (key string, messages map[string]error)
  6. FirstRule() (rule string, err error)
  7. FirstError() (err error)
  8. Items() (items []map[string]map[string]error)
  9. Map() map[string]error
  10. Maps() map[string]map[string]error
  11. String() string
  12. Strings() (errs []string)
  13. }

可以结合后续的示例理解这个数据结构。我们可以通过Maps()方法获得该原始错误信息数据结构map。但在大多数时候我们可以通过Error接口的其他方法来方便地获取特定的错误信息。

大多数情况下,我们不关心具体出错的校验规则,可以使用Error/String方法直接返回所有的错误信息即可。大部分的方法获取错误信息时根据校验规则的顺序性与否,返回的结果顺序会不太一样。

简要说明:

获取校验结果的值可以通过多个校验结果方法获取,为让各位开发者有充分的理解,详细说明以下:

方法说明
Code常用方法。实现gerrorCode接口,在校验组件中,该方法固定返回错误码 gcode.CodeValidationFailed
Error常用方法。实现标准库的error.Error接口,获取返回所有校验错误组成的错误字符串。内部逻辑同String方法。
Current常用方法。实现了gerrorCurrent接口,用于获取校验错误中的第一条错误对象。
Items在顺序性校验中将会按照校验规则顺序返回校验错误数组。其顺序性只有在顺序校验时有效,否则返回的结果是随机的。
Map返回FirstItem中得出错自规则及对应错误信息map
Maps返回所有的出错键名及对应的出错规则及对应的错误信息(map[string]map[string]error)。
String返回所有的错误信息,构成一条字符串返回,多个规则错误信息之间以;符号连接。其顺序性只有使用顺序校验规则时有效,否则返回的结果是随机的。
Strings返回所有的错误信息,构成[]string类型返回。其顺序性只有使用顺序校验规则时有效,否则返回的结果是随机的。
FirstItem在有多个键名/属性校验错误的时候,用以获取出错的第一个键名,以及其对应的出错规则和错误信息。其顺序性只有使用顺序校验规则时有效,否则返回的结果是随机的。
FirstRule返回FirstItem中得第一条出错的规则及错误信息。其顺序性只有使用顺序校验规则时有效,否则返回的结果是随机的。
FirstString返回FirstRule中得第一条规则错误信息。其顺序性只有使用顺序校验规则时有效,否则返回的结果是随机的。

gerror.Current支持

我们可以看到,gvalid.Error实现了Current() error接口,因此可以通过gerror.Current方法获取它的第一条错误信息,这在接口校验失败时返回错误信息非常方便。我们来看一个示例:

  1. package main
  2. import (
  3. "github.com/gogf/gf/v2/errors/gerror"
  4. "github.com/gogf/gf/v2/frame/g"
  5. "github.com/gogf/gf/v2/os/gctx"
  6. "github.com/gogf/gf/v2/util/gvalid"
  7. )
  8. func main() {
  9. type User struct {
  10. Name string `v:"required#请输入用户姓名"`
  11. Type int `v:"required|min:1#|请选择用户类型"`
  12. }
  13. var (
  14. err error
  15. ctx = gctx.New()
  16. user = User{}
  17. )
  18. if err = g.Validator().Data(user).Run(ctx); err != nil {
  19. g.Dump(err.(gvalid.Error).Maps())
  20. g.Dump(gerror.Current(err))
  21. }
  22. }

这里使用了gerror.Current(err)来获取校第一条验错误信息。执行后,终端输出:

  1. {
  2. "Name": {
  3. "required": "请输入用户姓名",
  4. },
  5. "Type": {
  6. "min": "请选择用户类型",
  7. },
  8. }
  9. "请输入用户姓名"

需要注意的是,数据校验时存在顺序性校验非顺序性校验,这会对获取第一条错误信息的结果产生影响。关于顺序与非顺序性校验,具体可以参考后续章节介绍。