Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
基本介绍
校验结果为一个Error
接口对象。当数据规则校验成功时,校验方法返回的结果为nil
。当数据规则校验失败时,返回的该对象是包含结构化的层级map
,包含多个字段及其规则及对应错误信息,以便于接收端能够准确定位错误规则。相关数据结构及方法如下: https://godoc.org/github.com/gogf/gf/util/gvalid
Code Block | ||
---|---|---|
| ||
type Error interface { Current() error Error() string FirstItem() (key string, messages map[string]string) FirstRule() (rule string, err string) FirstString() (err string) Items() (items []map[string]map[string]string) Map() map[string]string Maps() map[string]map[string]string String() string Strings() (errs []string) } |
可以结合后续的示例理解这个数据结构。我们可以通过Maps()
方法获得该原始错误信息数据结构map
。但在大多数时候我们可以通过Error
接口的其他方法来方便地获取特定的错误信息。
Tip |
---|
大多数情况下,我们不关心具体出错的校验规则,可以使用 |
简要说明:
获取校验结果的值可以通过多个校验结果方法获取,为让各位开发者有充分的理解,详细说明以下:
FirstItem
在有多个键名/属性校验错误的时候,用以获取出错的第一个键名,以及其对应的出错规则和错误信息;其顺序性只有使用顺序校验规则时有效,否则返回的结果是随机的FirstRule
会返回FirstItem
中得第一条出错的规则及错误信息FirstString
会返回FirstRule
中得第一条规则错误信息Items
在顺序性校验中将会按照校验规则返回校验错误的信息数组Items
在顺序性校验中将会按照校验规则返回校验错误的信息数组。其顺序性只有使用顺序校验规则时有效,否则返回的结果是随机的。Map
会返回FirstItem
中得出错自规则及对应错误信息map
。Maps
会返回所有的出错键名及对应的出错规则及对应的错误信息(map[string]map[string]string
)。String
会返回所有的错误信息,构成一条字符串返回,多个规则错误信息之间以;
符号连接符号连接。其顺序性只有使用顺序校验规则时有效,否则返回的结果是随机的。Strings
会返回所有的错误信息,构成[]string
类型返回类型返回。其顺序性只有使用顺序校验规则时有效,否则返回的结果是随机的。FirstItem
在有多个键名/属性校验错误的时候,用以获取出错的第一个键名,以及其对应的出错规则和错误信息。其顺序性只有使用顺序校验规则时有效,否则返回的结果是随机的。FirstRule
会返回FirstItem
中得第一条出错的规则及错误信息。其顺序性只有使用顺序校验规则时有效,否则返回的结果是随机的。FirstString
会返回FirstRule
中得第一条规则错误信息。其顺序性只有使用顺序校验规则时有效,否则返回的结果是随机的。
gerror.Current
支持
我们可以看到,gvalid.Error
实现了Current() error
接口,因此可以通过gerror.Current
方法获取它的第一条错误信息,这在接口校验失败时返回错误信息非常方便。我们来看一个示例:
Code Block | ||
---|---|---|
| ||
func (a *contentApi) DoUpdate(r *ghttp.Request) { var ( data *define.ContentApiDoUpdateReq serviceUpdateReq *define.ContentServiceUpdateReq ) if err := r.ParseForm(&data); err != nil { response.JsonExit(r, 1, gerror.Current(err).Error()) } if err := gconv.Struct(data, &serviceUpdateReq); err != nil { response.JsonExit(r, 1, err.Error()) } if err := service.Content.Update(r.Context(), serviceUpdateReq); err != nil { response.JsonExit(r, 1, err.Error()) } else { response.JsonExit(r, 0, "") } } |
这里使用了gerror.Current(err).Error()
来获取校第一条验错误信息。
Note |
---|
需要注意的是,数据校验时存在顺序性校验和非顺序性校验,这会对获取第一条错误信息的结果产生影响。关于顺序与非顺序性校验,具体可以参考后续章节介绍。 |
Panel | ||
---|---|---|
| ||
|