GoFrame框架数据校验之校验结果Error接口对象

目录

• 基本介绍
• 方法示例
• 注意问题
• 方法详解
• 进阶
• 注意问题
• 总结

上一篇文章介绍了 GoFrame数据校验之校验对象 | 校验结构体 ，得到了大家积极的反馈。

再接再厉，这篇总结分享：GoFrame数据校验之校验结果总结分享。

基本介绍

校验结果为一个Error接口对象。当数据规则校验成功时，校验方法返回的结果为nil。

当数据规则校验失败时，返回的该对象是包含结构化的层级map，包含多个字段及其规则及对应错误信息，以便于接收端能够准确定位错误规则。

方法示例

首先我们看一下Error的数据结构：

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接口的其他方法来获取特定的错误信息。

当我们并不关心具体出错的校验规则时，可以使用String方法，直接返回所有的错误信息。

方法详解

获取校验结果的值可以通过多个校验结果方法获取：

Items()在顺序性校验中将会按照校验规则返回校验错误的信息数组。其顺序性只有使用顺序校验规则时有效，否则返回的结果是随机的。

Map() 会返回FirstItem中的出错规则及对应的错误信息map。

Maps() 会返回所有的出错键名及对应的出错规则及对应的错误信息(map[string]map[string]string)。

String() 会返回所有的错误信息，构成一条字符串返回，多个规则错误信息之间以;符号连接。其顺序性只有使用顺序校验规则时有效，否则返回的结果是随机的。我们会比较常用。

Strings 会返回所有的错误信息，构成[]string类型返回。其顺序性只有使用顺序校验规则时有效，否则返回的结果是随机的。

FirstItem 在有多个键名/属性校验错误的时候，用以获取出错的第一个键名，以及其对应的出错规则和错误信息。其顺序性只有使用顺序校验规则时有效，否则返回的结果是随机的。

FirstRule 会返回FirstItem中得第一条出错的规则及错误信息。其顺序性只有使用顺序校验规 则时有效，否则返回的结果是随机的。

FirstString 会返回FirstRule中得第一条规则错误信息。其顺序性只有使用顺序校验规则时有效，否则返回的结果是随机的。

进阶

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

注意问题

数据校验时存在顺序性校验和非顺序性校验，这会对获取第一条错误信息的结果产生影响。

关于顺序与非顺序性校验，可以关注我，后面的文章中会更新说明。

总结

这篇文章为大家介绍了GoFrame gvalid 校验结果相关的知识点：

校验结果为一个Error接口对象。当数据规则校验成功时，校验方法返回的结果为nil。

当数据规则校验失败时，返回的该对象是包含结构化的层级map，包含多个字段及其规则及对应错误信息，以便于接收端能够准确定位错误规则。

更多关于GoFrame数据校验Error接口对象的资料请关注脚本之家其它相关文章！