基本介绍

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

  1. // 校验错误信息: map[键名]map[规则名]错误信息
  2. type ErrorMap map[string]map[string]string
  3. // 校验错误对象
  4. type Error
  5. func (e *Error) FirstItem() (key string, msgs map[string]string)
  6. func (e *Error) FirstRule() (rule string, err string)
  7. func (e *Error) FirstString() (err string)
  8. func (e *Error) Map() map[string]string
  9. func (e *Error) Maps() ErrorMap
  10. func (e *Error) String() string
  11. func (e *Error) Strings() (errs []string)

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

大多数情况下,我们不关心具体出错的校验规则,可以使用String方法直接返回所有的错误信息即可。

简要说明:

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

  1. FirstItem 在有多个键名/属性校验错误的时候,用以获取出错的第一个键名,以及其对应的出错规则和错误信息;其顺序性只有使用顺序校验规则时有效,否则返回的结果是随机的;
  2. FirstRule 会返回FirstItem中得第一条出错的规则及错误信息;
  3. FirstString 会返回FirstRule中得第一条规则错误信息;
  4. Map 会返回FirstItem中得出错自规则及对应错误信息map;
  5. Maps 会返回所有的出错键名及对应的出错规则及对应的错误信息(map[string]map[string]string);
  6. String 会返回所有的错误信息,构成一条字符串返回,多个规则错误信息之间以;符号连接;
  7. Strings 会返回所有的错误信息,构成[]string类型返回;

gerror.Current支持

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

  1. func (a *contentApi) DoUpdate(r *ghttp.Request) {
  2. var (
  3. data *define.ContentApiDoUpdateReq
  4. serviceUpdateReq *define.ContentServiceUpdateReq
  5. )
  6. if err := r.ParseForm(&data); err != nil {
  7. response.JsonExit(r, 1, gerror.Current(err).Error())
  8. }
  9. if err := gconv.Struct(data, &serviceUpdateReq); err != nil {
  10. response.JsonExit(r, 1, err.Error())
  11. }
  12. if err := service.Content.Update(r.Context(), serviceUpdateReq); err != nil {
  13. response.JsonExit(r, 1, err.Error())
  14. } else {
  15. response.JsonExit(r, 0, "")
  16. }
  17. }

这里使用了gerror.Current(err).Error()来获取校第一条验错误信息。