gin 框架中的参数验证及模型绑定介绍
- 这篇文章应该在之前发的,当时没有总结,现在发现知识点还挺多,再来总结下。
- 可以参考官方文档中的一些描述(参数验证及模型绑定):https://www.kancloud.cn/shuangdeyu/gin_book/949426
- 还可以参考慕课网的一门免费课程有讲解到,包括请求参数的获取,绑定,验证:https://www.imooc.com/learn/1175
- 我们知道 Gin使用 go-playground/validator.v8 验证参数。(现在应该是 v10了)
- 要了解参数的验证和很多使用方法,就可以直接打开 validator的官方文档:https://pkg.go.dev/gopkg.in/go-playground/validator.v9
一:参数获取与绑定
- 参数获取:
- 文档中有很多介绍了:https://www.kancloud.cn/shuangdeyu/gin_book
- 文档中有很多介绍了:https://www.kancloud.cn/shuangdeyu/gin_book
- 参数绑定:同样介绍了很多。
二:validator验证器
常用的一些验证
- 常用的一些验证:
-
跨字段验证:
-
1.required: 指定当前字段不能为空.
-
2 eqfield: 等于某些字段: 比如使用场景,验证密码时,输入的两次密码要保持一致, 此外还有大于,小于等等。gtfield:比如使用场景,设置登出时间 要大于登录时间的验证。
-
3 min, max: 之间用逗号间隔。
-
4 one of (v9 及以上有): 限定值必须为 给定的参数之一, 一般是数字或 字符串类型。应用场景: 当表示状态, 上架 或者下架, 0, 1表示, 就需要验证不出现其他的状态数字。
-
5 还有格式化时间的时候:
time_format:"2006-01-02"
这个不属于验证器的。 -
6 应用于切片数组或map(后续补充):
-
gin自定义验证器:
-
可以查看官方的这个示例代码: https://www.kancloud.cn/shuangdeyu/gin_book/949427
-
慕课网课程中的讲解:https://www.imooc.com/video/20189
-
validator官方的格式:
https://pkg.go.dev/gopkg.in/go-playground/validator.v9#hdr-Custom_Validation_Functions 比慕课网的写法更新: // Structure func customFunc(fl validator.FieldLevel) bool { if fl.Field().String() == "invalid" { return false } return true } validate.RegisterValidation("custom tag name", customFunc) // 官方自定义验证代码 https://gin-gonic.com/zh-cn/docs/examples/custom-validators/ // Booking 包含绑定和验证的数据。 type Booking struct { CheckIn time.Time `form:"check_in" binding:"required,bookabledate" time_format:"2006-01-02"` CheckOut time.Time `form:"check_out" binding:"required,gtfield=CheckIn,bookabledate" time_format:"2006-01-02"` } var bookableDate validator.Func = func(fl validator.FieldLevel) bool { date, ok := fl.Field().Interface().(time.Time) if ok { today := time.Now() if today.After(date) { return false } } return true }
定义翻译器
- 慕课课程中同样讲解了 如何翻译。 就是英文的错误,我们想翻译为中文返回。https://www.imooc.com/video/20190。
- 这里直接上代码了
import (
"fmt"
"github.com/gin-gonic/gin"
// gin 的binding模块
"reflect"
"strings"
"github.com/gin-gonic/gin/binding"
// 日志库
"go.uber.org/zap"
// 翻译器
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"
// 引入中文语言包 和英文语言包
"github.com/go-playground/locales/en"
"github.com/go-playground/locales/zh"
)
// 定义全局的翻译器
var trans ut.Translator
// language, 指定语言:实现的是支持中文和英文的
// 通常是取决于 http 请求头的 'Accept-Language'
func InitTrans(language string) (err error) {
// 获取 gin框架中的 Validator引擎属性,定制
if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
// 错误信息使用 json tag 作为名字, 而不是用结构体的 大写形式名字
// RegisterTagNameFunc注册一个函数以获取StructFields的备用名称。
// 例如,要使用为结构的JSON表示指定的名称,而不是普通的Go字段名称
// 官方给的代码,鼠标停在这个函数上就会显示
v.RegisterTagNameFunc(func(fld reflect.StructField) string {
name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0]
if name == "-" {
return ""
}
return name
})
zhong := zh.New() // 中文
english := en.New() // 英文
// 创建翻译器, 支持中文和英文
// fallback: 第一个参数是备用语言, 后面可添加多个语言
uni := ut.New(english, zhong, english)
var ok bool
// 根据传入的进行初始
if trans, ok = uni.GetTranslator(language); !ok {
zap.L().Error("翻译器初始化失败!")
return err
}
// 注册翻译器到gin当中用
switch language {
case "en":
err = entranslations.RegisterDefaultTranslations(v, trans)
case "zh":
err = zhtranslations.RegisterDefaultTranslations(v, trans)
}
}
return err
}
封装通用的错误验证逻辑
-
一般来讲,后端接口的基本步骤都是:
-
- 接收参数
-
- 验证参数
-
- 逻辑处理
-
- 返回结果
-
-
我们封装下 参数验证的步骤,其实也包含了,(json)参数的接收。
// 抽象出来校验数据的函数 // 返回字符串形式的校验错误, 并将数据 存入 p中 func validatorParams(c *gin.Context, p interface{}) string { // 参数绑定,默认为 对应类型的0值. // 当加上 binding:"required", 不传值就会直接进行返回错误 if err := c.ShouldBindJSON(p); err != nil { // 记录错误信息 var errMsg string // 判断err 是否是 validator error errs, ok := err.(validator.ValidationErrors) // 翻译错误 if ok { sliceErros := make([]string, 0) for _, e := range errs { sliceErros = append(sliceErros, e.Translate(trans)) } // 更新错误信息 errMsg = strings.Join(sliceErros, ",") } else { // 普通类型, 直接赋值, 参数错误 errMsg = CodeInvalidParam.Msg() // 自定义的错误类型 } // 日志记录问题 // 这里拿到 问题字符串,又去fmt.Errorf() 生成了一下错误,有点费性能 zap.L().Error("controllers/user/SignUp with invalid param", zap.Error(fmt.Errorf(errMsg))) // 返回错误信息 return errMsg } return "" }
-
实际可以这样写:
// 1. 参数校验 p := new(models.ParamsVoteData) if errMsg := validatorParams(c, p); errMsg != "" { ResponseErrorWithMsg(c, CodeInvalidParam, errMsg) // 自己封装的返回错误的函数 return }
-
上面代码注释很清晰,就差不多到这里了先。