gin binding方法参数校验

为了能够更方便的获取请求相关参数,提高开发效率,gin框架提供了Bind系列方法。

绑定方法分类

Bind系列方法大致分两类:

  1. Should类型
  2. Must类型

二者的区别就是:should和must的区别,即must绑定失败会报错

绑定方法关系图

Should类型

在这里插入图片描述

Must类型

在这里插入图片描述

ShouldBindBodyWith

在这里插入图片描述
假设有这样的场景:

  1. 请求体中的数据分为:校验用数据和接口用数据
  2. 校验用数据绑定给auth中间件的结构体,api用数据绑定为api结构体
  3. 一个请求上下分则需要绑定两次,但request.Body只可读取一次

此时,shouldBindBodyWith就应用而生:

  1. ShouldBindBodyWith is similar with ShouldBindWith, but it stores the request
    body into the context, and reuse when it is called again.
  2. 将request.body再次存储在上下文中
  3. 后续调用都得使用该方法

校验器

  1. gin框架使用github.com/go-playground/validator进行参数校验,目前已经支持github.com/go-playground/validator/v10了。
  2. 文档:validator
  3. github:validator

简单示例

package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

type SignUpParam struct {
	Age        uint8  `json:"age" binding:"gte=1,lte=130"`
	Name       string `json:"name" binding:"required"`
	Email      string `json:"email" binding:"required,email"`
	Password   string `json:"password" binding:"required"`
	RePassword string `json:"re_password" binding:"required,eqfield=Password"`
}

func main() {
	r := gin.Default()

	r.POST("/signup", func(c *gin.Context) {
		var u SignUpParam
		if err := c.ShouldBind(&u); err != nil {
			c.JSON(http.StatusOK, gin.H{
				"msg": err.Error(),
			})
			return
		}
		// 保存入库等业务逻辑代码...

		c.JSON(http.StatusOK, "success")
	})

	_ = r.Run(":8999")
}

此时,若gin的Bind方法会根据binding标签校验字段,发送一个请求,查看报错信息:

{"msg":"Key: 'SignUpParam.Email' Error:Field validation for 'Email' failed on the 'email' tag\nKey: 'SignUpParam.Password' Error:Field validation for 'Password' failed on the 'required' tag\nKey: 'SignUpParam.RePassword' Error:Field validation for 'RePassword' failed on the 'required' tag"}

从最终的输出结果可以看到 validator 的检验生效了,但是错误提示的字段不是特别友好,我们可能需要将它翻译成中文。

翻译校验错误提示信息

validator库本身是支持国际化的,借助相应的语言包可以实现校验错误提示信息的自动翻译。

package main

import (
	"fmt"
	"net/http"

	"github.com/gin-gonic/gin"
	"github.com/gin-gonic/gin/binding"
	"github.com/go-playground/locales/en"
	"github.com/go-playground/locales/zh"
	ut "github.com/go-playground/universal-translator"
	"github.com/go-playground/validator/v10"
	enTranslations "github.com/go-playground/validator/v10/translations/en"
	zhTranslations "github.com/go-playground/validator/v10/translations/zh"
)

// 定义一个全局翻译器T
var trans ut.Translator

// InitTrans 初始化翻译器
func InitTrans(locale string) (err error) {
	// 修改gin框架中的Validator引擎属性,实现自定制
	if v, ok := binding.Validator.Engine().(*validator.Validate); ok {

		zhT := zh.New() // 中文翻译器
		enT := en.New() // 英文翻译器

		// 第一个参数是备用(fallback)的语言环境
		// 后面的参数是应该支持的语言环境(支持多个)
		// uni := ut.New(zhT, zhT) 也是可以的
		uni := ut.New(enT, zhT, enT)

		// locale 通常取决于 http 请求头的 'Accept-Language'
		var ok bool
		// 也可以使用 uni.FindTranslator(...) 传入多个locale进行查找
		trans, ok = uni.GetTranslator(locale)
		if !ok {
			return fmt.Errorf("uni.GetTranslator(%s) failed", locale)
		}

		// 注册翻译器
		switch locale {
		case "en":
			err = enTranslations.RegisterDefaultTranslations(v, trans)
		case "zh":
			err = zhTranslations.RegisterDefaultTranslations(v, trans)
		default:
			err = enTranslations.RegisterDefaultTranslations(v, trans)
		}
		return
	}
	return
}

type SignUpParam struct {
	Age        uint8  `json:"age" binding:"gte=1,lte=130"`
	Name       string `json:"name" binding:"required"`
	Email      string `json:"email" binding:"required,email"`
	Password   string `json:"password" binding:"required"`
	RePassword string `json:"re_password" binding:"required,eqfield=Password"`
}

func main() {
	if err := InitTrans("zh"); err != nil {
		fmt.Printf("init trans failed, err:%v\n", err)
		return
	}

	r := gin.Default()

	r.POST("/signup", func(c *gin.Context) {
		var u SignUpParam
		if err := c.ShouldBind(&u); err != nil {
			// 获取validator.ValidationErrors类型的errors
			errs, ok := err.(validator.ValidationErrors)
			if !ok {
				// 非validator.ValidationErrors类型错误直接返回
				c.JSON(http.StatusOK, gin.H{
					"msg": err.Error(),
				})
				return
			}
			// validator.ValidationErrors类型错误则进行翻译
			c.JSON(http.StatusOK, gin.H{
				"msg":errs.Translate(trans),
			})
			return
		}
		// 保存入库等具体业务逻辑代码...

		c.JSON(http.StatusOK, "success")
	})

	_ = r.Run(":8999")
}

同样的请求再来一次,查看报错信息:

{"msg":{"SignUpParam.Email":"Email必须是一个有效的邮箱","SignUpParam.Password":"Password为必填字段","SignUpParam.RePassword":"RePassword为必填字段"}}

自定义错误提示信息的字段名

上面的错误提示看起来是可以了,但是还是差点意思,首先是错误提示中的字段并不是请求中使用的字段,例如:RePassword是我们后端定义的结构体中的字段名,而请求中使用的是re_password字段。

只需要在初始化翻译器的时候像下面一样添加一个获取json tag的自定义方法即可。

// InitTrans 初始化翻译器
func InitTrans(locale string) (err error) {
	// 修改gin框架中的Validator引擎属性,实现自定制
	if v, ok := binding.Validator.Engine().(*validator.Validate); ok {

		// 注册一个获取json tag的自定义方法
		v.RegisterTagNameFunc(func(fld reflect.StructField) string {
			name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0]
			if name == "-" {
				return ""
			}
			return name
		})

		zhT := zh.New() // 中文翻译器
		enT := en.New() // 英文翻译器

		// 第一个参数是备用(fallback)的语言环境
		// 后面的参数是应该支持的语言环境(支持多个)
		// uni := ut.New(zhT, zhT) 也是可以的
		uni := ut.New(enT, zhT, enT)
}

再次发送请求,查看错误信息:
{"msg":{"SignUpParam.email":"email必须是一个有效的邮箱","SignUpParam.password":"password为必填字段","SignUpParam.re_password":"re_password为必填字段"}}

但是还是有点瑕疵,那就是最终的错误提示信息中心还是有我们后端定义的结构体名称——SignUpParam,这个名称其实是不需要随错误提示返回给前端的,前端并不需要这个值。

定义一个去掉结构体名称前缀的自定义方法:

func removeTopStruct(fields map[string]string) map[string]string {
	res := map[string]string{}
	for field, err := range fields {
		res[field[strings.Index(field, ".")+1:]] = err
	}
	return res
}

在代码中使用上述函数将翻译后的errors做一下处理即可:

if err := c.ShouldBind(&u); err != nil {
	// 获取validator.ValidationErrors类型的errors
	errs, ok := err.(validator.ValidationErrors)
	if !ok {
		// 非validator.ValidationErrors类型错误直接返回
		c.JSON(http.StatusOK, gin.H{
			"msg": err.Error(),
		})
		return
	}
	// validator.ValidationErrors类型错误则进行翻译
	// 并使用removeTopStruct函数去除字段名中的结构体名称标识
	c.JSON(http.StatusOK, gin.H{
		"msg": removeTopStruct(errs.Translate(trans)),
	})
	return
}

最终报错信息:
{"msg":{"email":"email必须是一个有效的邮箱","password":"password为必填字段","re_password":"re_password为必填字段"}}

自定义结构体校验方法

上面的校验还是有点小问题,就是当涉及到一些复杂的校验规则,比如re_password字段需要与password字段的值相等这样的校验规则,我们的自定义错误提示字段名称方法就不能很好解决错误提示信息中的其他字段名称了。

报错信息:
{"msg":{"email":"email必须是一个有效的邮箱","re_password":"re_password必须等于Password"}}

此时如果想要追求更好的提示效果,将上面的Password字段也改为和json tag一致的名称,就需要我们自定义结构体校验的方法。

为SignUpParam自定义一个校验方法如下:

type SignUpParam struct {
	Age        uint8  `json:"age" binding:"gte=1,lte=130"`
	Name       string `json:"name" binding:"required"`
	Email      string `json:"email" binding:"required,email"`
	Password   string `json:"password" binding:"required"`
	RePassword string `json:"re_password" binding:"required,eqfield=Password"`
}
// SignUpParamStructLevelValidation 自定义SignUpParam结构体校验函数
func SignUpParamStructLevelValidation(sl validator.StructLevel) {
	su := sl.Current().Interface().(SignUpParam)

	if su.Password != su.RePassword {
		// 输出错误提示信息,最后一个参数就是传递的param
		sl.ReportError(su.RePassword, "re_password", "RePassword", "eqfield", "password")
	}
}

然后在初始化校验器的函数中注册该自定义校验方法即可:

func InitTrans(locale string) (err error) {
	// 修改gin框架中的Validator引擎属性,实现自定制
	if v, ok := binding.Validator.Engine().(*validator.Validate); ok {

		// ... liwenzhou.com ...
    
		// 为SignUpParam注册自定义校验方法
		v.RegisterStructValidation(SignUpParamStructLevelValidation, SignUpParam{})

		zhT := zh.New() // 中文翻译器
		enT := en.New() // 英文翻译器
}

报错信息:
{"msg":{"email":"email必须是一个有效的邮箱","re_password":"re_password必须等于password"}}

自定义字段校验方法

除了上面介绍到的自定义结构体校验方法,validator还支持为某个字段自定义校验方法,并使用RegisterValidation()注册到校验器实例中。

为SignUpParam添加一个需要使用自定义校验方法checkDate做参数校验的字段Date。

type SignUpParam struct {
	Age        uint8  `json:"age" binding:"gte=1,lte=130"`
	Name       string `json:"name" binding:"required"`
	Email      string `json:"email" binding:"required,email"`
	Password   string `json:"password" binding:"required"`
	RePassword string `json:"re_password" binding:"required,eqfield=Password"`
	// 需要使用自定义校验方法checkDate做参数校验的字段Date
	Date       string `json:"date" binding:"required,datetime=2006-01-02,checkDate"`
}

其中datetime=2006-01-02是内置的用于校验日期类参数是否满足指定格式要求的tag。 如果传入的date参数不满足2006-01-02这种格式就会提示如下错误:{"msg":{"date":"date的格式必须是2006-01-02"}}

首先我们要在需要执行自定义校验的字段后面添加自定义tag,这里使用的是checkDate:

// customFunc 自定义字段级别校验方法
func customFunc(fl validator.FieldLevel) bool {
	date, err := time.Parse("2006-01-02", fl.Field().String())
	if err != nil {
		return false
	}
	if date.Before(time.Now()) {
		return false
	}
	return true
}

定义好了字段及其自定义校验方法后,就需要将它们联系起来并注册到校验器实例中:

// 在校验器注册自定义的校验方法
if err := v.RegisterValidation("checkDate", customFunc); err != nil {
	return err
}

此时的报错信息:
{"msg":{"date":"Key: 'SignUpParam.date' Error:Field validation for 'date' failed on the 'checkDate' tag"}}

自定义翻译方法

现在需要为自定义字段校验方法提供一个自定义的翻译方法,从而实现该字段错误提示信息的自定义显示。

// registerTranslator 为自定义字段添加翻译功能
func registerTranslator(tag string, msg string) validator.RegisterTranslationsFunc {
	return func(trans ut.Translator) error {
		if err := trans.Add(tag, msg, false); err != nil {
			return err
		}
		return nil
	}
}

// translate 自定义字段的翻译方法
func translate(trans ut.Translator, fe validator.FieldError) string {
	msg, err := trans.T(fe.Tag(), fe.Field())
	if err != nil {
		panic(fe.(error).Error())
	}
	return msg
}

定义好了相关翻译方法之后,在InitTrans函数中通过调用RegisterTranslation()方法来注册我们自定义的翻译方法。

// InitTrans 初始化翻译器
func InitTrans(locale string) (err error) {
	// ...liwenzhou.com...
	
		// 注册翻译器
		switch locale {
		case "en":
			err = enTranslations.RegisterDefaultTranslations(v, trans)
		case "zh":
			err = zhTranslations.RegisterDefaultTranslations(v, trans)
		default:
			err = enTranslations.RegisterDefaultTranslations(v, trans)
		}
		if err != nil {
			return err
		}
		// 注意!因为这里会使用到trans实例
		// 所以这一步注册要放到trans初始化的后面
		if err := v.RegisterTranslation(
			"checkDate",
			trans,
			registerTranslator("checkDate", "{0}必须要晚于当前日期"),
			translate,
		); err != nil {
			return err
		}
		return
	}
	return
}

报错信息:
{"msg":{"date":"date必须要晚于当前日期"}}

完整自定义校验器代码

package validators

import (
	"errors"
	"fmt"
	"github.com/gin-gonic/gin/binding"
	"github.com/go-playground/locales/en"
	"github.com/go-playground/locales/zh"
	ut "github.com/go-playground/universal-translator"
	"github.com/go-playground/validator/v10"
	enTranslations "github.com/go-playground/validator/v10/translations/en"
	zhTranslations "github.com/go-playground/validator/v10/translations/zh"
	"reflect"
	"strings"
	"time"
)

const (
	DateValidatorKetWord = "checkDate"
)

// InitTrans 初始化翻译器
// 具体参考:https://blog.youkuaiyun.com/General_zy/article/details/127938889
func InitTrans(locale string) (ut.Translator, error) {
	// 修改gin框架中的Validator引擎属性,实现自定制
	if v, ok := binding.Validator.Engine().(*validator.Validate); ok {

		// 注册一个获取json tag的自定义方法
		v.RegisterTagNameFunc(func(fld reflect.StructField) string {
			name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0]
			if name == "-" {
				return ""
			}
			return name
		})

		zhT := zh.New() // 中文翻译器
		enT := en.New() // 英文翻译器

		// 第一个参数是备用(fallback)的语言环境
		// 后面的参数是应该支持的语言环境(支持多个)
		// uni := ut.New(zhT, zhT) 也是可以的
		uni := ut.New(enT, zhT, enT)

		// locale 通常取决于 http 请求头的 'Accept-Language'
		// 也可以使用 uni.FindTranslator(...) 传入多个locale进行查找
		trans, ok := uni.GetTranslator(locale)
		if !ok {
			return nil, fmt.Errorf("uni.GetTranslator(%s) failed", locale)
		}

		var err error
		// 注册翻译器
		switch locale {
		case "en":
			err = enTranslations.RegisterDefaultTranslations(v, trans)
		case "zh":
			err = zhTranslations.RegisterDefaultTranslations(v, trans)
		default:
			err = enTranslations.RegisterDefaultTranslations(v, trans)
		}

		// 在校验器注册自定义的校验方法
		if err = v.RegisterValidation(DateValidatorKetWord, DateValidator); err != nil {
			return nil, err
		}
		// 注册自定义的校验字段
		if err = v.RegisterTranslation(
			DateValidatorKetWord,
			trans,
			RegisterTranslator(DateValidatorKetWord, "{0}必须要晚于当前日期"),
			Translate,
		); err != nil {
			return nil, err
		}

		return trans, err
	}
	return nil, errors.New("failed to initialize translator")
}

// DateValidator 日期校验器,校验传入time.Date是否晚于当前时间
func DateValidator(fl validator.FieldLevel) bool {
	date, err := time.Parse("2006-01-02", fl.Field().String())
	if err != nil {
		return false
	}
	if date.Before(time.Now()) {
		return false
	}
	return true
}

// RegisterTranslator 为自定义字段添加翻译功能
func RegisterTranslator(tag string, msg string) validator.RegisterTranslationsFunc {
	return func(trans ut.Translator) error {
		if err := trans.Add(tag, msg, false); err != nil {
			return err
		}
		return nil
	}
}

// Translate 自定义字段的翻译方法
func Translate(trans ut.Translator, fe validator.FieldError) string {
	msg, err := trans.T(fe.Tag(), fe.Field())
	if err != nil {
		panic(fe.(error).Error())
	}
	return msg
}

注意事项

required认为值为0不通过校验

gin框架中一般用通过定义结构体中的字段Tag标签来设置参数校验规则和解析字段名,转json相关信息,其中字段是否为必须项规则写在字段Tag:binding:"required"

解决方案:

把整数字段改成整数指针类型,指针没有默认值0,也就没有这个问题了,注意取值加*,设值加&总之记得他是指针就好了

小结

gin框架中validator的使用技巧同样也适用于直接使用validator库,区别仅仅在于配置的是gin框架中的校验器还是由validator.New()创建的校验器。

<think>嗯,用户让我翻译gin.Context的ShouldBind方法的注释。首先,我需要确认这个方法是做什么的。Gin框架里,ShouldBind通常用于将HTTP请求中的数据绑定到结构体里,比如JSON、XML或者表单数据。用户可能是在开发中遇到了绑定数据的问题,或者想更深入理解这个方法的工作原理。 接下来,我应该回忆一下Gin的官方文档或者源代码里的注释。可能ShouldBind的注释会提到它如何根据Content-Type自动解析请求体,并且处理错误的情况。比如,如果数据不符合结构体的标签,是否会返回错误,或者是否有自动验证的功能。 用户之前的问题是关于数据库的脏读和幻读,现在突然切换到Gin框架,可能他的学习或工作项目涉及到了Web开发,需要处理请求参数绑定。翻译注释可以帮助他更好地理解方法的使用场景和注意事项,避免常见的错误。 需要注意的是,用户可能不仅仅想要直译,还需要一些解释,比如方法返回的错误类型,或者在不同数据格式下的行为差异。例如,ShouldBind和Bind方法的区别,是否自动设置400状态码等。这时候在翻译时可能需要补充一些上下文,或者用括号注明。 另外,用户可能没有明确说明是否需要代码示例,但根据之前的对话历史,用户似乎喜欢结构化的回答,比如表格或者分点说明。因此,在翻译注释的同时,可能还需要分点解释关键特性,比如自动解析、错误处理、数据验证等。 还要确认ShouldBind的具体行为,比如是否支持多格式、如何处理Content-Type,以及它和ShouldBindJSON、ShouldBindXML等具体方法的关系。注释里可能会提到这些,需要准确翻译出来,避免误导用户。 最后,检查是否有专业术语需要保留英文,比如Content-Type、HTTP请求等,或者是否需要完全中文化。根据用户之前的提问,系统指令要求使用中文回答,所以尽量用中文,但必要时保留术语并用括号标注英文。</think>**`gin.Context.ShouldBind()` 方法注释翻译**: ```go // ShouldBind 检查请求的 Content-Type 标头,根据类型自动选择解析器, // 并将请求体(Body)内容绑定到传入的结构体指针(obj)。 // 它支持 JSON、XML、YAML、ProtoBuf、MsgPack、Form 等格式。 // 若绑定失败,会返回错误,开发者需手动处理错误并设置适当的 HTTP 状态码。 // // 注意: // - 对于 GET 请求或 DELETE 请求,默认使用 Form 绑定(即查询参数) // - 使用结构体标签(如 `form:"field"`, `json:"field"`)定义字段映射规则 // - 若需要自动验证数据,可配合 go-playground/validator 使用 // // 典型用法: // var request UserRequest // if err := c.ShouldBind(&request); err != nil { // c.JSON(400, gin.H{"error": err.Error()}) // return // } ``` **关键特性解析**: 1. **多格式自动解析** - 根据 `Content-Type` 自动选择解析器(例如 `application/json` 触发 JSON 解析) - 支持嵌套结构体、切片、映射等复杂数据类型 2. **错误处理逻辑** - 返回 `error` 类型,包含详细错误原因(如字段类型不匹配、必填字段缺失) - 开发者需自行捕获错误并决定响应方式(与 `Bind` 方法不同,后者会自动返回 400 错误) 3. **与 `Bind` 方法的区别** | 方法 | 自动设置 HTTP 400 错误 | 错误处理灵活性 | 适用场景 | |-------------|---------------------|----------|--------------------| | `Bind` | ✅ | 低 | 快速开发,统一错误响应 | | `ShouldBind` | ❌ | 高 | 需要自定义错误响应的复杂业务逻辑 | **使用示例**: ```go type LoginRequest struct { Email string `json:"email" binding:"required,email"` Password string `json:"password" binding:"required,min=6"` } func Login(c *gin.Context) { var req LoginRequest if err := c.ShouldBind(&req); err != nil { // 自定义错误响应 c.JSON(http.StatusBadRequest, gin.H{ "code": 1001, "message": "参数校验失败", "details": err.Error(), }) return } // 处理业务逻辑... } ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Generalzy

文章对您有帮助,倍感荣幸

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值