举报投诉联系我们 手机版 热门标签 编程学
您的位置:编程学 > goframe api GoFrame 数据校验-校验结果

goframe api GoFrame 数据校验-校验结果

2023-05-29 07:18 GoFrame教程

goframe api GoFrame 数据校验-校验结果

goframe api GoFrame 数据校验-校验结果

goframe api

基本介绍

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

type Error interface {
	Code() gcode.Code
	Current() error
	Error() string
	FirstItem() (key string, messages map[string]error)
	FirstRule() (rule string, err error)
	FirstError() (err error)
	Items() (items []map[string]map[string]error)
	Map() map[string]error
	Maps() map[string]map[string]error
	String() string
	Strings() (errs []string)
}

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

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

简要说明:

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

 方法  说明
 ​Code  常用方法。实现​gerror​的​Code​接口,在校验组件中,该方法固定返回错误码​gcode.CodeValidationFailed
 ​Error  常用方法。实现标准库的​error.Error​接口,获取返回所有校验错误组成的错误字符串。内部逻辑同​String​方法
 ​Current  常用方法。实现了​gerror​的​Current​接口,用于获取校验错误中的第一条错误对象
 ​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​方法获取它的第一条错误信息,这在接口校验失败时返回错误信息非常方便。我们来看一个示例:

package main

import (
	"github.com/gogf/gf/v2/errors/gerror"
	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/os/gctx"
	"github.com/gogf/gf/v2/util/gvalid"
)

func main() {
	type User struct {
		Name string `v:"required#请输入用户姓名"`
		Type int    `v:"required|min:1#|请选择用户类型"`
	}
	var (
		err  error
		ctx  = gctx.New()
		user = User{}
	)
	if err = g.Validator().Data(user).Run(ctx); err != nil {
		g.Dump(err.(gvalid.Error).Maps())
		g.Dump(gerror.Current(err))
	}
}

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

{
    "Name": {
        "required": "请输入用户姓名",
    },
    "Type": {
        "min": "请选择用户类型",
    },
}
"请输入用户姓名"

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


阅读全文
以上是编程学为你收集整理的goframe api GoFrame 数据校验-校验结果全部内容。
声明:本站所有文章资源内容,如无特殊说明或标注,均为采集网络资源。如若本站内容侵犯了原著者的合法权益,可联系本站删除。
相关文章
© 2024 编程学 bianchengxue.com 版权所有 联系我们
桂ICP备19012293号-7 返回底部