GoFrame 數(shù)據(jù)校驗-校驗結(jié)果

基本介紹

校驗結(jié)果為一個?error?錯誤對象，內(nèi)部使用?gvalid.Error?對象實現(xiàn)。當(dāng)數(shù)據(jù)規(guī)則校驗成功時，校驗方法返回的結(jié)果為?nil?。當(dāng)數(shù)據(jù)規(guī)則校驗失敗時，返回的該對象是包含結(jié)構(gòu)化的層級?map?，包含多個字段及其規(guī)則及對應(yīng)錯誤信息，以便于接收端能夠準(zhǔn)確定位錯誤規(guī)則。相關(guān)數(shù)據(jù)結(jié)構(gòu)及方法如下：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)
}

可以結(jié)合后續(xù)的示例理解這個數(shù)據(jù)結(jié)構(gòu)。我們可以通過?Maps()?方法獲得該原始錯誤信息數(shù)據(jù)結(jié)構(gòu)?map?。但在大多數(shù)時候我們可以通過?Error?接口的其他方法來方便地獲取特定的錯誤信息。

大多數(shù)情況下，我們不關(guān)心具體出錯的校驗規(guī)則，可以使用?Error/String?方法直接返回所有的錯誤信息即可。大部分的方法獲取錯誤信息時根據(jù)校驗規(guī)則的順序性與否，返回的結(jié)果順序會不太一樣。

簡要說明：

獲取校驗結(jié)果的值可以通過多個校驗結(jié)果方法獲取，為讓各位開發(fā)者有充分的理解，詳細(xì)說明以下：

gerror.Current支持

我們可以看到，?gvalid.Error?實現(xiàn)了?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)?來獲取校第一條驗錯誤信息。執(zhí)行后，終端輸出：

{
    "Name": {
        "required": "請輸入用戶姓名",
    },
    "Type": {
        "min": "請選擇用戶類型",
    },
}
"請輸入用戶姓名"

需要注意的是，數(shù)據(jù)校驗時存在順序性校驗和非順序性校驗，這會對獲取第一條錯誤信息的結(jié)果產(chǎn)生影響。