珠海网站建设专业公司,网站顶部图片素材,自己的博客和自己的网站做友链,广州建网站要多少钱Go web框架——Gin#xff08;参数绑定bind与验证器#xff09; 1 bind参数绑定1.1 JSON参数1.2 Query参数1.3 Uri绑定动态参数1.4 ShouldBind自动绑定 2 验证器2.1 常用验证器2.2 gin内置验证器2.3 自定义验证的错误信息2.4 自定义验证器 1 bind参数绑定
在Gin框架中#… Go web框架——Gin参数绑定bind与验证器 1 bind参数绑定1.1 JSON参数1.2 Query参数1.3 Uri绑定动态参数1.4 ShouldBind自动绑定 2 验证器2.1 常用验证器2.2 gin内置验证器2.3 自定义验证的错误信息2.4 自定义验证器 1 bind参数绑定
在Gin框架中bind用于绑定参数即将请求参数绑定到结构体中。通过使用bind我们可以方便地将请求参数与结构体字段进行绑定从而更方便地处理和验证参数。
Gin框架提供了多种绑定方法包括Query参数绑定、Form参数绑定、JSON参数绑定等。下面分别介绍这些方法的详细用法。
Gin 提供了两种方式1. Must Bind 不用失败校验会返回错误 2. Should Bind 如果校验不通过会返回错误
1.1 JSON参数
type UserInfo struct {Name string json:nameAge int json:ageSex string json:sex
}func main() {router : gin.Default()router.POST(/, func(c *gin.Context) {var userInfo UserInfoerr : c.ShouldBindJSON(userInfo)if err ! nil {c.JSON(200, gin.H{msg: err})return}c.JSON(200, userInfo)})router.Run(:8000)
}使用apifox提交的参数是JSON格式
{name:张三, age:21,sex:男
}这样响应的数据是与我们提交的参数是一样的 1.2 Query参数
type UserInfo struct {Name string json:name form:nameAge int json:age form:ageSex string json:sex form:sex
}func main() {router : gin.Default()router.POST(/query, func(c *gin.Context) {var userInfo UserInfoerr : c.ShouldBindQuery(userInfo)if err ! nil {fmt.Println(err)c.JSON(200, gin.H{msg: 你错了})return}c.JSON(200, userInfo)})router.Run(:8000)
}方式差不多不多写query参数响应的结果跟上面一样 1.3 Uri绑定动态参数
tag对应为uri
type UserInfo struct {Name string json:name form:name uri:nameAge int json:age form:age uri:ageSex string json:sex form:sex uri:sex
}func main() {router : gin.Default()router.POST(/uri/:name/:age/:sex, func(c *gin.Context) {var userInfo UserInfoerr : c.ShouldBindUri(userInfo)if err ! nil {fmt.Println(err)c.JSON(200, gin.H{msg: 你错了})return}c.JSON(200, userInfo)})router.Run(:8000)
}注意这里使用apifox需要传带中文参数时要在设置这里将URL自动编码改成遵循WHATWG 1.4 ShouldBind自动绑定
会根据请求头中的content-type去自动绑定form-data的参数也用这个tag用form
默认的tag就是form
绑定form-data、x-www-form-urlencode
type UserInfo struct {Name string form:nameAge int form:ageSex string form:sex
}func main() {router : gin.Default()router.POST(/form, func(c *gin.Context) {var userInfo UserInfoerr : c.ShouldBind(userInfo)if err ! nil {fmt.Println(err)c.JSON(200, gin.H{msg: 你错了})return}c.JSON(200, userInfo)})router.Run(:8000)
}传的数据和响应如下 2 验证器
需要使用参数验证功能需要加binding tag
2.1 常用验证器
// 不能为空并且不能没有这个字段
required 必填字段如binding:required // 针对字符串的长度
min 最小长度如binding:min5
max 最大长度如binding:max10
len 长度如binding:len6// 针对数字的大小
eq 等于如binding:eq3
ne 不等于如binding:ne12
gt 大于如binding:gt10
gte 大于等于如binding:gte10
lt 小于如binding:lt10
lte 小于等于如binding:lte10// 针对同级字段的
eqfield 等于其他字段的值如PassWord string binding:eqfieldPassword
nefield 不等于其他字段的值- 忽略字段如binding:-2.2 gin内置验证器
// 枚举 只能是red 或green
oneofred green // 字符串
containsfengfeng // 包含fengfeng的字符串
excludes // 不包含
startswith // 字符串前缀
endswith // 字符串后缀// 数组
dive // dive后面的验证就是针对数组中的每一个元素// 网络验证
ip
ipv4
ipv6
uri
url
// uri 在于I(Identifier)是统一资源标示符可以唯一标识一个资源。
// url 在于Locater是统一资源定位符提供找到该资源的确切路径// 日期验证 1月2号下午3点4分5秒在2006年
datetime2006-01-022.3 自定义验证的错误信息
当验证不通过时会给出错误的信息但是原始的错误信息不太友好不利于用户查看
只需要给结构体加一个msg 的tag
type UserInfo struct {Username string json:username binding:required msg:用户名不能为空Password string json:password binding:min3,max6 msg:密码长度不能小于3大于6Email string json:email binding:email msg:邮箱地址格式不正确
}当出现错误时就可以来获取出错字段上的msg。
err这个参数为ShouldBindJSON返回的错误信息obj这个参数为绑定的结构体还有一点要注意的是validator这个包要引用v10这个版本的否则会出错
完整的代码如下
import (fmtgithub.com/gin-gonic/gingithub.com/go-playground/validator/v10reflect
)type UserInfo struct {Username string json:username binding:required msg:用户名不能为空Password string json:password binding:min3,max6 msg:密码长度不能小于3大于6Email string json:email binding:email msg:邮箱地址格式不正确
}func GetValidMsg(err error, obj any) string {// 使用的时候需要传obj的指针getObj : reflect.TypeOf(obj)// 将err接口断言为具体类型if errs, ok : err.(validator.ValidationErrors); ok {// 断言成功for _, e : range errs {// 循环每一个错误信息// 根据报错字段名获取结构体的具体字段if f, exits : getObj.Elem().FieldByName(e.Field()); exits {msg : f.Tag.Get(msg)return msg}}}return err.Error()
}func main() {router : gin.Default()router.POST(/users, func(c *gin.Context) {var userInfo UserInfoerr : c.ShouldBindJSON(userInfo)if err ! nil {fmt.Println(err)c.JSON(200, gin.H{msg: GetValidMsg(err, userInfo)})return}c.JSON(200, userInfo)})router.Run(:8000)
} 2.4 自定义验证器
注册验证器函数
// github.com/go-playground/validator/v10
// 注意这个版本得是v10的if v, ok : binding.Validator.Engine().(*validator.Validate); ok {v.RegisterValidation(sign, signValid)
}编写函数
// 如果用户名不等于张三就校验失败
func signValid(fl validator.FieldLevel) bool {name : fl.Field().Interface().(string)if name ! 张三 {return false}return true
}使用
package mainimport (github.com/gin-gonic/gingithub.com/gin-gonic/gin/bindinggithub.com/go-playground/validator/v10reflect
)func GetValidMsg(err error, obj interface{}) string {// obj为结构体指针getObj : reflect.TypeOf(obj)// 断言为具体的类型err是一个接口if errs, ok : err.(validator.ValidationErrors); ok {for _, e : range errs {if f, exist : getObj.Elem().FieldByName(e.Field()); exist {return f.Tag.Get(msg) //错误信息不需要全部返回当找到第一个错误的信息时就可以结束}}}return err.Error()
}// 如果用户名不等于张三就校验失败
func signValid(fl validator.FieldLevel) bool {name : fl.Field().Interface().(string)if name ! 张三 {return false}return true
}func main() {router : gin.Default()router.POST(/, func(c *gin.Context) {type UserInfo struct {Name string json:name binding:sign msg:用户名错误Age int json:age binding:}var user UserInfoerr : c.ShouldBindJSON(user)if err ! nil {// 显示自定义的错误信息msg : GetValidMsg(err, user)c.JSON(200, gin.H{msg: msg})return}c.JSON(200, user)})// 注册if v, ok : binding.Validator.Engine().(*validator.Validate); ok {v.RegisterValidation(sign, signValid)}router.Run(:8000)
}
下面我们实验一下 Over~~
