gin框架学习笔记(四) ——参数绑定与参数验证

已于 2024-05-16 11:59:12 修改
阅读量327 收藏 4
点赞数 5
分类专栏： Gin 文章标签： gin 学习 笔记 golang
于 2024-05-16 11:51:46 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_73924465/article/details/138898780
版权

参数绑定

前言

在Gin框架中我们可以利用bind来将前段传递过来的参数与结构体进行参数绑定与参数校验，而这bind的方式主要有以下两种:

  • Mustbind:一般使用较少，因为参数校验失败会改变状态码
  • Shouldbind：主要使用上的校验方法，校验失败的话会返回错误

Shouldbind绑定相关参数

  • 绑定Json参数
package main

import (
	"fmt"
	"github.com/gin-gonic/gin"
)

type UserInfo struct {
	Username string `json:"username"`
	Age      int    `json:"age"`
	Sex      string `json:"sex"`
}

func main() {
	r := gin.Default()
	r.POST("/json", func(c *gin.Context) {
		var user UserInfo
		err := c.ShouldBindJSON(&user)
		if err != nil {
			fmt.Println("err:", err)
			c.JSON(200, gin.H{
				"code":    400,
				"message": "请求参数错误",
			})
			return
		}
		c.JSON(200, user)
	})
	r.Run(":8080")
}

这里我的侧是主要是两方面，一个是看参数错误的返回，一个是参数正确的返回：
在这里插入图片描述
在这里插入图片描述

  • 绑定查询参数
package main

import (
	"fmt"
	"github.com/gin-gonic/gin"
)
type UserInfo_Query struct {
	Username string `json:"username" form:"username"`
	Age      int    `json:"age" form:"age"`
	Sex      string `json:"sex" form:"sex"`
}

func main() {
	r := gin.Default()
	r.GET("/query", func(c *gin.Context) {
		var user UserInfo_Query
		err := c.ShouldBindQuery(&user)
		if err != nil {
			fmt.Println("err:", err)
			c.JSON(200, gin.H{
				"code":    400,
				"message": "请求参数错误",
			})
			return
		}
		c.JSON(200, user)
	})
	r.Run(":8080")
}

运行结果：
在这里插入图片描述
在这里插入图片描述

  • 绑定url参数
package main

import (
	"fmt"
	"github.com/gin-gonic/gin"
)

type UserInfo_Uri struct {
	Username string `json:"username" form:"username" uri:"username"`
	Age      int    `json:"age" form:"age" uri:"age"`
	Sex      string `json:"sex" form:"sex" uri:"sex"`
}
func main() {
	r := gin.Default()
	r.POST("/uri/:username/:age/:sex", func(c *gin.Context) {
		var user UserInfo_Uri
		err := c.ShouldBindUri(&user)
		if err != nil {
			fmt.Println("err:", err)
			c.JSON(200, gin.H{
				"code":    400,
				"message": "请求参数错误",
			})
			return
		}
		c.JSON(200, user)
	})
	r.Run(":8080")
}

在这里插入图片描述

  • 绑定表单参数
package main

import (
	"fmt"
	"github.com/gin-gonic/gin"
)

type UserInfo_Form struct {
	Username string `json:"username" form:"username"`
	Age      int    `json:"age" form:"age"`
	Sex      string `json:"sex" form:"sex"`
}

func main() {
	r := gin.Default()
	r.POST("/form", func(c *gin.Context) {
		var user UserInfo_Form
		err := c.ShouldBind(&user)
		if err != nil {
			fmt.Println("err:", err)
			c.JSON(200, gin.H{
				"code":    400,
				"message": "请求参数错误",
			})
			return
		}
		c.JSON(200, user)
	})
	r.Run(":8080")
}

运行结果：
在这里插入图片描述

bind绑定器

正文前的碎碎念

我们在上面介绍了很多绑定参数的方法，我们可以通过它们将一些前端传递锅里的参数存储到结构体中,进而让我们去使用，但是我们在日常生活其实并没有这么简单,博主举一个简单的例子：博主小时候玩游戏的时候要申请账号，小时候博主很喜欢玩赛尔号，但是博主只有暑假才能玩，当时老是记不住密码。试过把密码抄在书上，但是老是忘了抄在哪里，当时想把密码就设成111它又不让，当时还差点给气哭来着(呜呜呜)，那现在有一个问题，这种对密码的限制是怎么做到的呢？这就提到参数绑定了，让我们跟随赛尔号开始今天的内容了！
在这里插入图片描述

参数验证

在我们设置参数验证的时候，需要加binding tag

  • 常见验证器
    在我们说常见验证器的具体内容之前我先来演示一下验证器的作用,假如我们现在有一个密码注册页面，我们要求年龄在18岁以上，密码长度在6位以上，我们可以这么写:
package main

import (
	"github.com/gin-gonic/gin"
	"net/http"
)

type User_enroll struct {
	Username string `json:"username" form:"username"`
	Age      int    `json:"age"  form:"age" binding:"gt=18"`
	Sex      string `json:"sex"  form:"sex"`
	Password string `json:"password" form:"password" binding:"min=8"`
}

func main() {
	r := gin.Default()
	r.POST("/user", func(c *gin.Context) {
		var user User_enroll
		if err := c.ShouldBind(&user); err != nil {
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
			return
		}
		c.JSON(200, user)
	})
	r.Run(":8080")
}

我们正常按照要求输入是可以正常返回的：
在这里插入图片描述
但是不按照binding要求的话，返回是这样的:
在这里插入图片描述
除此之外，常见验证器还有其他的限制条件表示方法，如下:

// 不能为空，并且不能没有这个字段
required： 必填字段，如：binding:"required"  

// 针对字符串的长度
min 最小长度，如：binding:"min=5"
max 最大长度，如：binding:"max=10"
len 长度，如：binding:"len=6"

// 针对数字的大小
eq 等于，如：binding:"eq=3"
ne 不等于，如：binding:"ne=12"
gt 大于，如：binding:"gt=10"
gte 大于等于，如：binding:"gte=10"
lt 小于，如：binding:"lt=10"
lte 小于等于，如：binding:"lte=10"

// 针对同级字段的
eqfield 等于其他字段的值，如：PassWord string `binding:"eqfield=Password"`
nefield 不等于其他字段的值


忽略字段，如：binding:"-"

内置验证器

Gin除了常见的验证器之外,还定义了一些它自身内置的验证器，它的语法与上面的基本一致,这里就不做过多讲解了。

// 枚举  只能是red 或green
oneof=red green 

// 字符串  
contains=fengfeng  // 包含fengfeng的字符串
excludes // 不包含
startswith  // 字符串前缀
endswith  // 字符串后缀

// 数组
dive  // dive后面的验证就是针对数组中的每一个元素

// 网络验证
ip
ipv4
ipv6
uri
url
// uri 在于I(Identifier)是统一资源标示符，可以唯一标识一个资源。
// url 在于Locater，是统一资源定位符，提供找到该资源的确切路径

// 日期验证  1月2号下午3点4分5秒在2006年
datetime=2006-01-02

自定义验证器

自定义验证的错误消息

当我们验证参数出现错误的时候，原生的错误信息有时候并不是很友好，我们可以自己去定义返回的错误消息,示例如下：

package main

import (
	"github.com/gin-gonic/gin"
	"github.com/go-playground/validator/v10"
	"reflect"
)

type UserInfo struct {
	Username string `json:"username" binding:"required" msg:"用户名不能为空"`
	Password string `json:"password" binding:"min=3,max=6" msg:"密码长度不能小于3大于6"`
}

// GetValidMsg 返回结构体中的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() {
	r := gin.Default()
	r.POST("/user", func(c *gin.Context) {
		var user UserInfo
		err := c.ShouldBindJSON(&user)
		if err != nil {
			c.JSON(400, gin.H{"msg": _GetValidMsg(err, &user)})
			return
		}
		c.JSON(200, user)
	})
	r.Run(":8080")
}

运行测试:
在这里插入图片描述

自定义验证器

  • 注册验证器函数
//注册验证器函数
	if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
		v.RegisterValidation("sign", signValid)
	}
	r.Run(":8080")
  • 验证器函数的躯体实现:
func signValid(fl validator.FieldLevel) bool {
	// 获取字段值
	value := fl.Field().Interface().(string)
	// 验证规则
	if value == "fengxu" {
		return false
	}
	return true
}
  • 调用函数
type UserInfo struct {
	Username string `json:"username" binding:"sign" msg:"用户名设置错误"`
	Password string `json:"password" binding:"min=3,max=6" msg:"密码长度不能小于3大于6"`
}

完整代码：

package main

import (
	"github.com/gin-gonic/gin"
	"github.com/gin-gonic/gin/binding"
	"github.com/go-playground/validator/v10"
	"reflect"
)

type UserInfo struct {
	Username string `json:"username" binding:"sign" msg:"用户名设置错误"`
	Password string `json:"password" binding:"min=3,max=6" msg:"密码长度不能小于3大于6"`
}

// GetValidMsg 返回结构体中的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 signValid(fl validator.FieldLevel) bool {
	// 获取字段值
	value := fl.Field().Interface().(string)
	// 验证规则
	if value == "fengxu" {
		return false
	}
	return true
}

func main() {
	r := gin.Default()
	r.POST("/user", func(c *gin.Context) {
		var user UserInfo
		err := c.ShouldBindJSON(&user)
		if err != nil {
			c.JSON(400, gin.H{"msg": _GetValidMsg(err, &user)})
			return
		}
		c.JSON(200, user)
	})

	//注册验证器函数
	if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
		v.RegisterValidation("sign", signValid)
	}
	r.Run(":8080")
}

运行测试:
在这里插入图片描述

落雨便归尘
关注
  • 5
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Golang笔记
怨行客
10-18 401
协程是用户态轻量级线程协程是线程调度的基本单位通常在函数前加上go关键字就能实现并发。一个Goroutine会以一个很小的栈启动2KB或4KB，当遇到栈空间不足时，栈会自动伸缩， 因此可以轻易实现成千上万个goroutine同时启动。
Go语言中的gin框架之GET/POST请求参数接收传值（五）
06-15
本次请求类型基本都包含了，仅供参考研究。
go语言gin框架数据绑定常用api
11-03
go语言gin框架可以让开发者更快的开发web运用，结合go语言自带的并发优势，运行速度，让用户运用体验飞一般的感觉，go语言也成为游戏服务器的首选开发语言。不管你是go小白，还是其他开发语言的大佬，gin框架可以让你快速的实现运用的开发与部署，其跨操作系统的特点，可以让你省掉不少麻烦；同时，gin成了很多初创公司敏捷开发的首选；快速开发，快速测试，快速迭代。go语言的严谨性，也为后期的维护提供了帮助，其代码风格的一致性，也让开发者接手别人项目的时候没那么大的压力；go语言的gorouting和channel的组合，让并发更为简单，通过简单的api的调用，让锁定，开锁，解锁变得轻而易举，有了那么简单的锁的配合，让并发变得像上厕所那样简单了。gin提供快速数据绑定api，可以通过ShouldBind映射的方式绑定请求数据，其中ShouldBindQuery用于GET请求数据的绑定，ShouldBind方法用于POST请求的数据绑定；gin提供的多项式渲染，让返回到客户端的数据处理变得简单无比，JSON，XML，HTML，YAML，ParseJSON没有比这些ap更i简单好用的了
golang封装mysql涉及到的包以及sqlx和gorm的区别
铁柱的博客
07-25 2764
刚用golang的时候，看到mysql这些包之间都有什么区别呢？到底哪些才是我们封装mysql需要用到的关键包？
Go-Gin中优雅的实现参数校验，自定义错误消息提示
m0_47195133的博客
04-02 556
Go-Gin中优雅的实现参数校验，自定义错误消息提示
golang入门笔记——Gin
热门推荐
qq_43716830的博客
04-27 1万+
Gin简介： Gin是一个golang的微框架，基于httprouter，封装比较优雅，API友好，源码注释比较明确，具有快速灵活，容错方便等特点 Gin特征： 1.速度快：基于基数树的路由，内存占用少。没有反射。可预测的API性能。 中间件支持：传入的HTTP请求可以由中间件链和最终操作处理。 2。Crash—free Gin可以捕获HTTP请求期间发生的panic并恢复它。这样，你的服务器将始终可用。 3.JSON验证 Gin可以解析和验证请求的JSON-例如，检查所需值的存在 4.路由分组 更好地组织
个人博客详细文章目录索引(持续更新)
每个人都是独一无二的，把握好自己的节奏，跟着自己的心走。
01-26 6556
本索引目录会一直不断进行更新…最近更新时间：2022.6.7 16:38物联网：2020后半段时间学习的javaweb学习笔记可见语雀(当时记录在那里就不搬过来了)：语雀-Javaweb对应尚硅谷的Spring5学习笔记：语雀-框架/Spring5对应黑马SpringMVC教程学习笔记：语雀-框架/SpringMVC对应黑马SpringMVC教程学习笔记：语雀-框架/MybatisMyBatis插件：...................................................
Go语言中的gin框架之【GET/POST】请求参数接收传值（五）
A_LWIEUI_Learn的博客
06-15 4452
在Gin中，可以使用Param或Query方法获取URL中的查询参数。Param方法可以获取路径参数，而Query方法可以获取查询参数。 在 Gin 框架中，我们可以使用 ShouldBind 方法将请求中的数据绑定到结构体对象上。该方法可以自动推断数据的类型，并根据 Content-Type 的不同进行不同类型的绑定，支持 JSON、XML、Form、FormPost 四种数据类型。
Go学习第十五章——Gin参数绑定bind与验证器
Hai_Helloyou的博客
10-28 2808
当验证不通过时，会给出错误的信息，但是原始的错误信息不太友好，不利于用户查看只需要给结构体加一个msg 的tagUsername string `json:"username" binding:"required" msg:"用户名不能为空"`Password string `json:"password" binding:"min=3,max=6" msg:"密码长度不能小于3大于6"`
Go Gin框架请求自动验证和数据绑定，看完这篇就会用了
Seekload
10-22 1070
之前做项目基本上公司是用 gRPC 和 echo 这两个框架的组合，后来 Gin 框架在Go圈越来越流行，陆续我在公司接触到的项目也开始有人用 Gin 框架开发了。因为我也是偶尔开发，像Gin框架里边参数的模型验证和绑定这些没有系统去学习，都是粘贴一下其他人的代码，改成我要的参数和模型，这里说的模型就是保存请求数据的 Struct。慢慢我发现每个人写的风格都不一样，有直接一个个接收参数再赋值到模型...
Gin获取请求参数
.
12-19 1061
Gin获取参数 Gin获取参数 表单提交，json提交以及Restful参数提交 package main import ( "encoding/json" "fmt" "github.com/gin-gonic/gin" "net/http" ) func main() { r := gin.Default() r.GET("/ping", func(c *gin.Context) { c.JSON(200, gin.H{ "message": "pong",
gin框架安装以及gin的请求路由
01-20
window 上安装gin，需要先安装git ,go 环境，然后打开git，在你想要的地方安装go就可以 比如在 /e/golang/gin 安装gin 在git命令行中输入mkdir -p $GOPATH/gin1 然后没有报错的话就说明创建成功了，然后进入该文件下...
Nginx学习笔记之事件驱动框架处理流程
01-10
ngx_event_core_module模块的ngx_event_process_init方法对事件模块做了一些初始化。其中包括将“请求连接”这样一个读事件对应的处理方法（handler）设置为ngx_event_accept函数，并将此事件添加到epoll模块中。...
nginx 基本配置与参数说明详细介绍
01-10
运行用户 user nobody; #启动进程,通常设置成和cpu的数量相等 worker_processes 1;  #全局错误日志及PID文件 #error_log logs/error.log; #error_log logs/error.log notice; #error_log logs/error.log ... u
Golang教程笔记
S_ZaiJiangHu的博客
03-21 776
第一个go程序 package main import "fmt" func main() { // notice { 不能在单独的行上 fmt.Println("Hello," + " World!") //当语句不在一行时 不需要行分隔符； go语言连接符为+ } 运行和编译 方法1：编译二进制文件执行 $ go build hello.go //命令行 $ ./hello //命令行 Hello, World! //结果 方法2： $ go run hello.go 第一行代码
Gin和Gorm常见面试题及解答
Mr_XiMu的博客
10-23 706
Gin和Gorm常见面试题及解答
后端学习笔记——后端细碎知识点（不断更新......）
weixin_43363236的博客
01-26 782
主要是go后端，也会设计到python、java的知识，懒得分类整理，所以都写在一篇文章里面了，方便自己查看笔记。
Gin的快速入门和搭建
最新发布
weixin_51971817的博客
06-02 448
Gin的快速入门和搭建
gin框架绑定数组参数
06-07
在gin框架中，可以使用`Bind`方法来绑定数组参数，具体步骤如下： 1. 定义一个结构体，用于接收数组参数： ```go type ArrayParam struct { Values []string `form:"values[]"` } ``` 2. 在路由处理函数中，使用`Bind`方法将请求中的参数绑定到结构体中： ```go func handler(c *gin.Context) { var param ArrayParam if err := c.Bind(&param); err != nil { // 绑定出错，处理错误 return } // 处理数组参数 values := param.Values // ... } ``` 3. 在请求中，以`values[]`作为参数名，将多个值传递给数组参数： ``` GET /path?values[]=value1&values[]=value2&values[]=value3 ``` 这样就可以在gin框架中绑定数组参数了。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

落雨便归尘

你的鼓励将是我创作的最大动力

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

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

打赏作者

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

抵扣说明：

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

余额充值