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 UserInfo
       err := 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 UserInfo
       err := 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 UserInfo
       err := 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 UserInfo
       err := 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 UserInfo
		err := 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 main

import (
	"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 UserInfo
		err := 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~~

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

数据结构Demo——简单计算器

数据结构Demo——简单计算器

简单计算器 一、项目介绍二、技术使用三、具体代码实现1.前端部分2.后端部分 一、项目介绍 本项目实现了一个通过网页访问的简单计算器，它可以对带括号的加减乘除表达式进行计算并将计算结果返回给用户，并且可以对用户输入的表达式进行合法性判断&#…
阅读更多...
Maven第二章：Maven基本概念与生命周期

Maven第二章：Maven基本概念与生命周期

Maven第二章：Maven基本概念与生命周期 前言 本章主要内容，介绍Maven基本概念，包括maven坐标含义，命名规则，继承与聚合、了解与理解生命周期，如何通过Maven进行依赖和版本管理。 什么是Maven的坐标&#xf…
阅读更多...
【第25例】IPD体系进阶：需求分析团队RAT

【第25例】IPD体系进阶：需求分析团队RAT

目录 简介 RAT CSDN学院相关内容推荐 作者简介 简介 RAT是英文Requirement Analysis Team英文首字母的简称，也即需求分析团队，每个产品线都需要设定对应的一个RAT的组织。 RAT主要负责产品领域内需求的分析活动，是RMT的支撑团队： 这个时候可以将RAT细化为PL-RAT团队，…
阅读更多...
Ansible的安装和部署

Ansible的安装和部署

目录 1.Ansible的安装 2.构建Ansible清单 直接书写受管主机名或ip 设定受管主机的组[组名称] 主机规格的范围化操作 指定其他清单文件 ansible命令指定清单的正则表达式 3.Ansible配置文件参数详解 配置文件的分类与优先级 常用配置参数 4.构建用户级Ansible操作环…
阅读更多...
Mysql数据库 4.SQL语言 DQL数据查询语言 查询

Mysql数据库 4.SQL语言 DQL数据查询语言 查询

DQL数据查询语言 从数据表中提取满足特定条件的记录 1.单表查询 2.多表查询 查询基础语法 select 关键字后指定要查询到的记录的哪些列 语法：select 列名（字段名）/某几列/全部列 from 表名 [具体条件]； select colnumName…
阅读更多...
linux进程概念

linux进程概念

文章目录 1、冯诺依曼体系结构2、操作系统(Operator System)2.1、概念2.2、设计OS的目的2.3、定位2.4、如何理解 "管理"2.5、总结 3、系统调用和库函数概念4、进程4.1、基本概念4.2、描述进程-PCB4.2.1、task_struct-PCB的一种4.2.2、task_ struct内容分类 4.3、组织…
阅读更多...
【Linux】第六站：Centos系统如何安装软件？

【Linux】第六站：Centos系统如何安装软件？

文章目录 1.Linux安装软件的方式2.Linux的软件生态3. yum4. rzsz软件的安装与卸载5.yum如何知道去哪里下载软件？ 1.Linux安装软件的方式 在linux中安装软件常用的有三种方式 源代码安装（我们还需要进行编译运行后才可以，很麻烦） …
阅读更多...
H5游戏源码分享-跳得更高

H5游戏源码分享-跳得更高

H5游戏源码分享-跳得更高 控制跳动踩到云朵上 <!DOCTYPE html> <html> <head><meta http-equiv"Content-Type" content"text/html; charsetUTF-8"><meta http-equiv"Content-Type" content"text/html;"&g…
阅读更多...
基于SSM的养老院管理系统

基于SSM的养老院管理系统

基于SSM的养老院管理系统的设计与实现~ 开发语言&#xff1a;Java数据库&#xff1a;MySQL技术&#xff1a;SpringSpringMVCMyBatisVUE工具&#xff1a;IDEA/Ecilpse、Navicat、Maven 系统展示 摘要 养老院管理系统是一个基于SSM&#xff08;Spring、Spring MVC、MyBatis&…
阅读更多...
[量化投资-学习笔记002]Python+TDengine从零开始搭建量化分析平台-MA均线的多种实现方式

[量化投资-学习笔记002]Python+TDengine从零开始搭建量化分析平台-MA均线的多种实现方式

MA 均线时最基本的技术指标&#xff0c;也是最简单&#xff0c;最不常用的&#xff08;通常使用EMA、SMA&#xff09;。 以下用两种不同的计算方法和两种不同的画图方法进行展示和说明。 MA 均线指标公式 MA (N)(C1 C2 C3 …C N )/N目录 方式一1.SQL 直接查询均值2.使用 pyp…
阅读更多...
java八股文(基础篇)

java八股文(基础篇)

面向过程和面向对象的区别 面向过程&#xff1a;在解决问题时&#xff0c;特别自定义函数编写一步一步的步骤解决问题。 面向对象&#xff1a;其特点就是 继承&#xff0c;多态&#xff0c;继承&#xff0c;在解决问题时&#xff0c;不再注重函数的编写&#xff0c;而在于注重…
阅读更多...
这么理解矩阵乘法，让你吊打面试官

这么理解矩阵乘法，让你吊打面试官

大家好啊&#xff0c;我是董董灿。 很多与深度学习算法相关的面试&#xff0c;面试官可能都会问一个问题&#xff0c;那就是你是如何理解矩阵乘算法的。 更有甚者&#xff0c;会让你当场手写矩阵乘算法&#xff0c;然后问细节&#xff0c;问如何优化&#xff0c;面试现场&…
阅读更多...
治疗红斑性肢痛症的【Chromocell】申请870万美元纳斯达克IPO上市

治疗红斑性肢痛症的【Chromocell】申请870万美元纳斯达克IPO上市

来源&#xff1a;猛兽财经 作者&#xff1a;猛兽财经 猛兽财经获悉&#xff0c;总部位于美国的生物制药公司Chromocell Therapeutics Corporation&#xff08;简称&#xff1a;Chromocell&#xff09;近期已向美国证券交易委员会&#xff08;SEC&#xff09;提交招股书&#x…
阅读更多...
VM搭建虚拟机2（自定义安装）

VM搭建虚拟机2（自定义安装）

文章目录 自定义安装选择你的centos下载目录设置用户名密码自定义安装目录注意&#xff0c;尽量别再同一位置安装虚拟机设置处理器数量内存根据所需配置&#xff08;默认1G&#xff09;NAT按需设置磁盘大小点击完成即可等待安装即可 VMware、centos、典型安装 自定义安装 选择你…
阅读更多...
【机器学习（二） 线性代数基础I（Linear Algebra Foundations）】

【机器学习（二） 线性代数基础I（Linear Algebra Foundations）】

机器学习&#xff08;二&#xff09; 线性代数基础I&#xff08;Linear Algebra Foundations) 这一节主要介绍一些线性代数的基础。 目录 机器学习&#xff08;二&#xff09; 线性代数基础I&#xff08;Linear Algebra Foundations)1. 向量 Vectors2. 复杂度 Complexity3.线…
阅读更多...
【Linux】第七站：vim的使用以及配置

【Linux】第七站：vim的使用以及配置

文章目录 一、vim1.vim的介绍2.vim基本使用3.vim的命令模式常用命令4.底行模式 二、vim的配置 一、vim 1.vim的介绍 vim编辑器&#xff0c;用来文本编写&#xff0c;可以写代码 它是一个多模式的编辑器 它有很多的模&#xff0c;不过我们暂时先只考虑这三种模式 命令模式插入模…
阅读更多...
2023年阿里云双11有什么优惠活动？详细攻略来了！

2023年阿里云双11有什么优惠活动？详细攻略来了！

随着双十一的临近&#xff0c;阿里云也正式开启了双11大促&#xff0c;推出了“金秋云创季”活动&#xff0c;那么&#xff0c;2023年阿里云双11的优惠活动究竟有哪些呢&#xff1f;本文将为大家详细介绍。 一、阿里云双11活动时间 1、2023年10月27日-2023年10月31日&#xff…
阅读更多...
洛谷 B2009 计算 (a+b)/c 的值 C++代码

洛谷 B2009 计算 (a+b)/c 的值 C++代码

目录 题目描述 AC Code 切记 题目描述 题目网址&#xff1a;计算 (ab)/c 的值 - 洛谷 AC Code #include<bits/stdc.h> using namespace std; int main() {int a,b,c;cin>>a>>b>>c;cout<<(ab)/c<<endl;return 0; } 切记 不要复制题…
阅读更多...
[论文阅读]Ghost-free High Dynamic Range Imaging with Context-aware Transformer

[论文阅读]Ghost-free High Dynamic Range Imaging with Context-aware Transformer

Ghost-free HDRI with Context-aware Transformer 背景介绍已有算法本文算法实验对比 背景介绍 高动态范围成像&#xff08;HDR&#xff09;是一种图像技术&#xff0c;它能够捕捉到比传统图像更广泛的亮度范围。1997年&#xff0c;Paul Debevec在他的论文《Recovering High D…
阅读更多...
Netty复习：（2）IdleStateHandler的用法

Netty复习：（2）IdleStateHandler的用法

一、handler定义&#xff1a; package handler;import io.netty.channel.ChannelHandlerContext; import io.netty.channel.ChannelInboundHandlerAdapter;public class MyChatServerHandler3 extends ChannelInboundHandlerAdapter {Overridepublic void userEventTriggered(…
阅读更多...
最新文章

Copyright @ 2022~2023