Go学习第十五章——Gin参数绑定bind与验证器

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:"name"`Age  int    `json:"age"`Sex  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":"男"
}

这样响应的数据是与我们提交的参数是一样的

image-20231028164848246

1.2 Query参数

type UserInfo struct {Name string `json:"name" form:"name"`Age  int    `json:"age" form:"age"`Sex  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参数,响应的结果跟上面一样

image-20231028165408750

1.3 Uri绑定动态参数

tag对应为uri

type UserInfo struct {Name string `json:"name" form:"name" uri:"name"`Age  int    `json:"age" form:"age" uri:"age"`Sex  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

image-20231028170730113

1.4 ShouldBind自动绑定

会根据请求头中的content-type去自动绑定,form-data的参数也用这个,tag用form

默认的tag就是form

绑定form-data、x-www-form-urlencode

type UserInfo struct {Name string `form:"name"`Age  int    `form:"age"`Sex  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")
}

传的数据和响应如下:

image-20231028171520670

2 验证器

需要使用参数验证功能,需要加binding tag

2.1 常用验证器

// 不能为空,并且不能没有这个字段
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:"-"

2.2 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

2.3 自定义验证的错误信息

当验证不通过时,会给出错误的信息,但是原始的错误信息不太友好,不利于用户查看

只需要给结构体加一个msg 的tag

type UserInfo struct {Username string `json:"username" binding:"required" msg:"用户名不能为空"`Password string `json:"password" binding:"min=3,max=6" msg:"密码长度不能小于3大于6"`Email    string `json:"email" binding:"email" msg:"邮箱地址格式不正确"`
}

当出现错误时,就可以来获取出错字段上的msg。

  • err:这个参数为ShouldBindJSON返回的错误信息
  • obj:这个参数为绑定的结构体
  • 还有一点要注意的是,validator这个包要引用v10这个版本的,否则会出错

完整的代码如下:

import ("fmt""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"`Email    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")
}

image-20231028173238176

2.4 自定义验证器

  1. 注册验证器函数
// github.com/go-playground/validator/v10
// 注意这个版本得是v10的if v, ok := binding.Validator.Engine().(*validator.Validate); ok {v.RegisterValidation("sign", signValid)
}
  1. 编写函数
// 如果用户名不等于"张三"就校验失败
func signValid(fl validator.FieldLevel) bool {name := fl.Field().Interface().(string)if name != "张三" {return false}return true
}
  1. 使用
package mainimport ("github.com/gin-gonic/gin""github.com/gin-gonic/gin/binding""github.com/go-playground/validator/v10""reflect"
)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")
}

下面我们实验一下:

image-20231028174025296

Over~~

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/124213.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Vue 路由指南:畅游单页应用的地图(Vue Router 和 <router-view>)

🤍 前端开发工程师(主业)、技术博主(副业)、已过CET6 🍨 阿珊和她的猫_CSDN个人主页 🕠 牛客高级专题作者、在牛客打造高质量专栏《前端面试必备》 🍚 蓝桥云课签约作者、已在蓝桥云…

【时间复杂度和空间复杂度】

前言: 首先介绍一下算法(Algorithm) 算法是对特定问题求解步骤的一种描述。一个“好”的算法应该达到以下目标:正确性、可读性、健壮性、高效率与低存储量需求 算法的效率的度量 是通过 时间复杂度 和 空间复杂度 来描述的 一、时间复杂度 时间复杂度…

【数据结构】Map和Set

Map和Set 1. 搜索树 1.1 概念 二叉搜索树是左子树比根节点小,右子树比根节点大的二叉树。(如果左右子树不为空的话是这样,但是左右子树也可以为空) 1.2 操作——查找 查找的思想与二分查找类似。 如果根节点的值和所要查找的…

JavaScript对象数组根据某个属性值筛选分类

🤵 作者:coderYYY 🧑 个人简介:前端程序媛,目前主攻web前端,后端辅助,其他技术知识也会偶尔分享🍀欢迎和我一起交流!🚀(评论和私信一般会回&#…

wangEditor富文本编辑器的使用

文章目录 🟢 wangeditor 富文本⭐️安装 wangeditor⭐️demo 模板⭐️效果图 ✒️总结 🟢 wangeditor 富文本 一款开源 Web 富文本编辑器,开箱即用,配置简单 wangedito 官网 简洁易用、功能强大、文档教程丰富支持 JS、Vue、Rea…

VScode 调试go程序报错,需要更改glaunch.json文件

{// 使用 IntelliSense 了解相关属性。 // 悬停以查看现有属性的描述。// 欲了解更多信息,请访问: https://go.microsoft.com/fwlink/?linkid830387"version": "0.2.0","go.toolsEnvVars": {"GOOS": "js","…

【Note详细图解】中缀表达式如何转为后缀表达式?数据结构

中缀表达式 中缀表达式(中缀记法)是一个通用的算术或逻辑公式表示方法,操作符是以中缀形式处于操作数的中间(例:3 4),中缀表达式是人们常用的算术表示方法。 前缀或后缀记法不同的是&#xf…

【JVM】类加载器

【JVM】类加载器 文章目录 【JVM】类加载器0. 类加载器概述1. 类加载器的分类1.1 启动类加载器1.2 Java中的默认类加载器1.2.1 扩展类加载器1.2.2 应用程序类加载器 2. 双亲委派机制2.1 类的双亲委派机制是什么?2.2 打破双亲委派机制2.2.1 自定义类加载器2.2.2 线程…

并行和并发有什么区别?

并行和并发 并行和并发最早其实描述的是 Java 并发编程里面的概念。他们强调的是 CPU 处理任务的能力。简单来说: 并发,就是同一个时刻,CPU 能够处理的任务数量,并且对于应用程序来说,不会出现卡顿现象。并行&#x…

【Linux】冯诺依曼体系结构以及初始操作系统

文章目录 冯诺依曼体系结构操作系统概念设计OS的目的定位如何理解管理 总结系统调用和库函数概念 冯诺依曼体系结构 我们常见的计算机,如笔记本。我们不常见的计算机,如服务器,大部分都遵守冯诺依曼体系。 截至目前,我们所认识…

Ubuntu GCC切换源

Ubuntu GCC切换源 sudo apt-get install gcc-9 g-9将安装的 gcc-9和g9更新到gcc选项中 sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-9 100 sudo update-alternatives --install /usr/bin/g g /usr/bin/g-9 100将系统的gcc-11和g11更新到gcc选项中&…

HDFS 基本 shell 操作

HDFS 基本 shell 操作 1.1 创建目录1.2 上传指令1.3 创建空文件1.4 向分布式文件系统中的文件里追加内容1.5 查看指令1.6 下载指令1.7 合并下载1.8 移动hdfs中的文件1.9 复制hdfs中的文件到hdfs的另一个目录1.10 删除命令1.11 查看磁盘利用率和文件大小1.12 修改权限1.13 修改文…

366周赛

2897. 对数组执行操作使平方和最大 位运算技巧 2896. 执行操作使两个字符串相等 动规技巧太巧妙,可以多看几遍理解。

专门解决数学问题的大模型

01 项目介绍 LLEMMA:一个专门解决数学问题的开源大语言模型,能力超过所有已知的开源模型 LLEMMA由多个大学和Eleuther AI公司共同研发,模型能够理解和生成数学表达式、解决数学问题,并与其他计算工具(如Python解释器…

ESP32网络开发实例-Web页面控制舵机

Web页面控制舵机 文章目录 Web页面控制舵机1、ESP32驱动舵机介绍2、软件准备3、硬件准备4、代码实现4.1 舵机基本控制实例4.2 使用电位计控制舵机实例4.3 Web页面控制舵机本文将介绍如何在ESP32的Web服务器页面中控制伺服电机。 1、ESP32驱动舵机介绍 在本节中,我们将回顾伺服…

修改el-date-picker宽度

<div style"width: 100%"><el-date-pickerstyle"width:100%"v-model"value"type"datetimerange"start-placeholder"开始日期"end-placeholder"结束日期":default-time"[12:00:00]"value-forma…

pytorch 入门 (五)案例三:乳腺癌识别-VGG16实现

本文为&#x1f517;小白入门Pytorch内部限免文章 &#x1f368; 本文为&#x1f517;小白入门Pytorch中的学习记录博客&#x1f366; 参考文章&#xff1a;【小白入门Pytorch】乳腺癌识别&#x1f356; 原作者&#xff1a;K同学啊 在本案例中&#xff0c;我将带大家探索一下深…

面向对象设计——原型模式

原型设计模式是一种创建型设计模式,其主要目标是创建对象的新实例,同时尽量减少与使用者的交互,以降低对象创建的复杂性。这通过复制(或克隆)现有对象的实例来实现,以获得新对象,而不是通过实例化类来创建。 以下是原型设计模式的关键概念: 原型接口(Prototype Inter…

Response Header中不暴露Server(IIS)版本、ASP.NET及相关版本等信息

ASP MVC开发的Web默认情况下会在请求的回应中暴露Server、X-AspNet-Version、X-AspNetMvc-Version、X-Powered-By等相关服务端信息&#xff0c;公开这些敏感信息会存在一定的安全风险。 X-SourceFiles标头用于被IIS / IIS Express中某些调试模块理解&#xff0c;它包含到磁盘上…

LangChain+LLM实战---BERT主要的创新之处和注意力机制中的QKV

BERT主要的创新之处 BERT&#xff08;Bidirectional Encoder Representations from Transformers&#xff09;是一种基于Transformer架构的预训练语言模型&#xff0c;由Google在2018年提出。它的创新之处主要包括以下几个方面&#xff1a; 双向性&#xff08;Bidirectional&…