探索Gin框架：Golang Gin框架请求参数的获取

news2024/10/6 16:27:48

前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到网站https://www.captainbed.cn/kitie。

前言

我们在专栏的前面几篇文章内讲解了Gin框架的路由配置，服务启动等内容。

专栏地址：https://blog.csdn.net/qq_35716689/category_12575301.html

在我们平常添加路由处理函数之后，就可以在路由处理函数中编写业务处理代码了，但在此之前我们往往需要获取请求参数，本文就详细的讲解下gin获取请求参数常见的几种方式。

目录

前言

传递参数的方式

Header

URL

HTTP Body

直接获取请求参数

获取URL Path中的参数

获取URL Query中的参数

获取HTTP Body中的参数

绑定请求参数

绑定Header参数

绑定URL Path参数

绑定URL Query参数

绑定HTTP Body参数

数据校验

两种方式的对比

小结

传递参数的方式

在一个HTTP请求中，一般可以把上传参数分为以下三个部分：

Header是HTTP请求中一个键值对集合，HTTP规范定义了很多的Headeer，比如Content-Type，Accept等，不过也可以自定义请求头部或者响应头部。

URL

URL指的是请求路径，在请求路径上可以通过两种方式携带请求参数，一种是直接写在请求路径上的，称为URL Path：

http://localhost:8080/user/add

在URL上传递参数的另外一种方式就是URL Query，URL Query参数是指跟在?后面的键值对集合，多个参数之间以&分隔的：

http://localhost:8080/user/add?name=小明&gender=男

HTTP Body

HTTP Body参数是指HTTP请求的请求体所携带的参数，这部分参数会因为Content-Type不同而不同，比如当Content-Type为application/json时，HTTO Body携带的是一串JSON字符串。

那么，在Gin框架中，要如何获取这些请求参数呢？主要有以下两种方式：

  • 直接用Gin封装的方法获取请求参数
  • 通过绑定的方式来获取请求参数

直接获取请求参数

Gin框架在net/http包的基础上封装了获取参数的方式。

获取URL Path中的参数

在路由中使用通配符时，对应的通配符就会成为URL Path参数，调用gin.Context的Param()方法可以获取Path参数：

 package main
 ​
 func main(){
   engine := gin.Default()
   engine.GET("/user/:id", func(ctx *gin.Context) {
     id := ctx.Param("id")
     fmt.Fprintf(ctx.Writer, "你的请求id:%s", id)
   })
     engine.Run()
 }

运行后发起请求：

 $ curl http://localhost:8080/user/100
 你的请求id:100

获取URL Query中的参数

gin.Context对象提供了以下几个主要方法用于获取Query参数：

 package main
 ​
 import (
   "fmt"
 ​
   "github.com/gin-gonic/gin"
 )
 ​
 func main() {
   engine := gin.New()
   engine.GET("/user/list", func(ctx *gin.Context) {
     //获取单个值
     name := ctx.Query("name")
     //带默认值
     gender := ctx.DefaultQuery("gender", "男")
     //数组
     habits := ctx.QueryArray("habits")
     //map
     works := ctx.QueryMap("works")
     fmt.Printf("%s,%s,%s,%s\n", name, gender, habits, works)
   })
 ​
   engine.Run()
 }

运行后发起请求：

curl -X GET "http://localhost:8080/user/list?name=John&gender=男&habits[]=reading&habits[]=sports&works[teacher]=math&works[engineer]=computer"
John,男,[reading sports],map[engineer:computer teacher:math]

获取HTTP Body中的参数

对于通过HTTP Body传上来的参数，gin.Context也提供了几种主要方法用于获取：

 package main
 ​
 import (
   "fmt"
 ​
   "github.com/gin-gonic/gin"
 )
 ​
 func main() {
   engine := gin.New()
   engine.POST("/user/add", func(ctx *gin.Context) {
     //获取单个值
     name := ctx.PostForm("name")
     //带默认值
     gender := ctx.DefaultPostForm("gender", "男")
     //数组
     habits := ctx.PostFormArray("habits")
     //map
     works := ctx.PostFormMap("works")
     fmt.Printf("%s,%s,%s,%s\n", name, gender, habits, works)
   })
 ​
   engine.Run()
 }

绑定请求参数

Gin支持绑定Header，URL Path，URL Query以及HTTP Body等不同位置数据。

绑定Header参数

绑定Header参数可以使用BindHeader()或者ShouldBindHeader()方法：

 package main
 ​
 import (
   "fmt"
   "net/http"
 ​
   "github.com/gin-gonic/gin"
 )
 ​
 type testHeader struct {
   Rate   int    `header:"Rate"`
   Domain string `header:"Domain"`
 }
 ​
 func main() {
   r := gin.Default()
   r.GET("/", func(c *gin.Context) {
     h := testHeader{}
 ​
     if err := c.ShouldBindHeader(&h); err != nil {
       c.JSON(http.StatusBadRequest, err)
       return
     }
 ​
     fmt.Printf("%#v\n", h)
     c.JSON(http.StatusOK, gin.H{"Rate": h.Rate, "Domain": h.Domain})
   })
 ​
   r.Run()
 }

运行后的请求结果：

$ curl -H "rate:300" -H "test:123" http://localhost:8080/
{"Test":"123","Rate":300}

绑定URL Path参数

绑定URL Path参数可以使用BindUri()或者ShouldBindUri()方法：

package main

import (
	"fmt"
	"net/http"

	"github.com/gin-gonic/gin"
)

type User struct {
	Name  string `uri:"name"`
  Email string `uri:"email"`
}

func main() {
	engine := gin.New()
	engine.GET("/user/list/:email/:name", func(ctx *gin.Context) {
		var u User
		if err := ctx.BindUri(&u);err != nil {
			ctx.JSON(http.StatusBadRequest, err)
			return
		}
		fmt.Fprintf(ctx.Writer, "你输入的用户名为：%s,邮箱为：%s\n", u.Name, u.Email)
	})
	engine.Run()
}

运行后的请求结果： 

curl -X GET "http://localhost:8080/user/list/john@163.com/john
你输入的用户名为：john,邮箱为：john@163.com

绑定URL Query参数

绑定URL Query参数可以使用BindQuery()、ShouldBindQury()、Bind()或者ShouldBind()方法：

package main

import (
	"fmt"
	"net/http"

	"github.com/gin-gonic/gin"
)

type User struct {
	Name  string `form:"name"`
  Email string `form:"email"`
}

func main() {
	engine := gin.New()
	engine.GET("/user/list", func(ctx *gin.Context) {
		var u User
		if err := ctx.BindQuery(&u);err != nil {
			ctx.JSON(http.StatusBadRequest, err)
			return
		}
		fmt.Fprintf(ctx.Writer, "你输入的用户名为：%s,邮箱为：%s\n", u.Name, u.Email)
	})

	engine.Run()
}

运行后的请求结果：

curl -X GET "http://localhost:8080/user/list?email=john@163.com&name=john
你输入的用户名为：john,邮箱为：john@163.com

绑定HTTP Body参数

我们知道HTTP Body的参数会根据不同Content-Type传不同格式的数据，Gin支持以下几种Content-Type类型的绑定：

  • JSON
  • XML
  • TOML
  • YAML
  • x-www-form-urlencoded
  • multipart/form-data

注意HTTP Body的数据只在POST请求时才会进行绑定。

绑定HTTP Body参数可以用Bind()和ShouldBind()方法，这两个方法会根据当前请求的Content-Type类型自动判断请求的类型。

package main

import (
	"fmt"
	"net/http"

	"github.com/gin-gonic/gin"
)

type User struct {
	Name  string
	Email string
}

func main() {
	engine := gin.New()
	engine.POST("/user/add", func(ctx *gin.Context) {
		var u User
		if err := ctx.Bind(&u); err != nil {
			ctx.JSON(http.StatusBadRequest, err.Error())
			return
		}
		fmt.Fprintf(ctx.Writer, "你输入的用户名为：%s,邮箱为：%s\n", u.Name, u.Email)
	})
	engine.Run()
}

如果明确请求数据的类型，也可以直接调用对应类型绑定的方法，比如确定是JSON格式数据的话，可以调用BindJSON()或者ShouldBindJSON()：

package main

import (
	"fmt"
	"net/http"

	"github.com/gin-gonic/gin"
)

type User struct {
	Name  string
	Email string
}

func main() {
	engine := gin.New()
	engine.POST("/user/add", func(ctx *gin.Context) {
		var u User
		if err := ctx.BindJSON(&u); err != nil {
			ctx.JSON(http.StatusBadRequest, err.Error())
			return
		}
		fmt.Fprintf(ctx.Writer, "你输入的用户名为：%s,邮箱为：%s\n", u.Name, u.Email)
	})
	engine.Run()
}

对于x-www-form-urlencoded和multipart/form-data，与Qurey参数一样，结构体需要添加form的tag：

package main

import (
	"fmt"
	"net/http"

	"github.com/gin-gonic/gin"
)

type User struct {
	Name  string `form:"name"`
	Email string `form:"email"`
}

func main() {
	engine := gin.New()
	engine.POST("/user/add", func(ctx *gin.Context) {
		var u User
		if err := ctx.Bind(&u); err != nil {
			ctx.JSON(http.StatusBadRequest, err.Error())
			return
		}
		fmt.Fprintf(ctx.Writer, "你输入的用户名为：%s,邮箱为：%s\n", u.Name, u.Email)
	})
	engine.Run()
}

数据校验

在数据绑定的时候，也可以进行数据校验，这里我们为User结构体的标签添加了required属性，要求这个字段必须要有：

package main

import (
	"fmt"
	"net/http"

	"github.com/gin-gonic/gin"
)

type User struct {
	Name  string `binding:"required"`
	Email string `binding:"required"`
}

func main() {
	engine := gin.New()
	engine.POST("/user/add", func(ctx *gin.Context) {
		var u User
		if err := ctx.Bind(&u); err != nil {
			ctx.JSON(http.StatusBadRequest, err.Error())
			return
		}
		fmt.Fprintf(ctx.Writer, "你输入的用户名为：%s,邮箱为：%s\n", u.Name, u.Email)
	})
	engine.Run()
}

两种方式的对比

相较于直接获取请求参数，请求数据绑定是一种更强大且优雅的参数获取方式，使用这种方式获取参数有以下几个好处：

  • 直接将所有参数绑定到一个结构体中，不需要手动一个个地获取参数。
  • 绑定后的参数会自动转换为结构体对应字段的类型，不需要手动对每个参数进行数据类型转换。
  • 在进行数据绑定的同时还可以进行数据校验。

小结

直接获取请求参数虽然没有绑定参数那么强大，但对于简单的请求来说，也是够用的，因此，我们可以根据自己的需求，选择对应的方式来获取请求参数。

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

TS项目实战二：网页计算器

TS项目实战二：网页计算器

使用ts实现网页计算器工具，实现计算器相关功能，使用tsify进行项目编译，引入Browserify实现web界面中直接使用模块加载服务。   源码下载：点击下载 讲解视频 TS实战项目四：计算器项目创建 TS实战项目五：B…
阅读更多...
Unity3D判断屏幕中某个坐标点的位置是否在指定UI区域内

Unity3D判断屏幕中某个坐标点的位置是否在指定UI区域内

系列文章目录 unity工具 文章目录 系列文章目录前言一、使用rect.Contains()判断1-1、转换坐标1-2、代码如下：1-3、注意事项1-3、测试效果如下 二、使用坐标计算在不在区域内2-1、方法如下：2-2、注意事项 三、使用RectTransformUtility.ScreenPointToLo…
阅读更多...
[每日一题] 02.06 - ABC

[每日一题] 02.06 - ABC

ABC lis list(map(int,input().split())) ABC list(input()) lis.sort() dic {A:lis[0],B:lis[1],C:lis[2]} res print(dic) for i in ABC:print(dic[i],end )我感觉没问题，但提交就是出问题了，应该不是最后多了个空格（试过去除还是错…
阅读更多...
股票投资指南！石家庄开通股票账户佣金最低是多少？怎么开低佣金账户？

股票投资指南！石家庄开通股票账户佣金最低是多少？怎么开低佣金账户？

股票投资指南可以帮助您更好地了解股票投资的基本知识和技巧，以便您可以做出明智的投资决策。以下是一些股票投资的基本指南： 了解股票市场：学习股票市场的基本概念和运作方式，包括股票交易所、股票指数和股票价格等。 定义投资目…
阅读更多...
技术是你的安身立命之本

技术是你的安身立命之本

技术是你的安身立命之本 技术是你的安身立命之本，这句话是我父亲说的，我也一直把这句话奉为圭臬。这句话让我受用至今。 我父亲是一个两面派人士，一面是农民，一直在耕种着五亩薄田，没有像别的人家一样把田租赁出去，另一面是银行职员，勤勤恳恳在小县城的网点干了一辈子…
阅读更多...
【AI】告别繁琐阅读，阿里通义智文阅读助手带您轻松畅游知识海洋！

【AI】告别繁琐阅读，阿里通义智文阅读助手带您轻松畅游知识海洋！

哈喽，大家好，我是木头左，致力于程序服务生活！ 一、阿里通义智文阅读助手简介 阿里通义智文阅读助手是一款基于人工智能技术的阅读辅助工具，可以帮助用户更高效地阅读和理解各种类型的文档，如PPT、图片和PD…
阅读更多...
【多模态MLLMs+图像编辑】MGIE：苹果开源基于指令和大语言模型的图片编辑神器（24.02.03开源）

【多模态MLLMs+图像编辑】MGIE：苹果开源基于指令和大语言模型的图片编辑神器（24.02.03开源）

项目主页：https://mllm-ie.github.io/ 论文 :基于指令和多模态大语言模型图片编辑 2309.Guiding Instruction-based Image Editing via Multimodal Large Language Models （加州大学圣巴拉分校苹果） 代码：https://github.com/appl…
阅读更多...
LeetCode-第2769题-找出最大的可达成数字

LeetCode-第2769题-找出最大的可达成数字

1.题目描述 给你两个整数 num 和 t 。 如果整数 x 可以在执行下述操作不超过 t 次的情况下变为与 num 相等，则称其为 可达成数字 ： 每次操作将 x 的值增加或减少 1 ，同时可以选择将 num 的值增加或减少 1 。 2.样例描述 3.思路描述 当 x…
阅读更多...
第五讲 二维费用的背包问题

第五讲 二维费用的背包问题

【题目来源】AcWing 8. 二维费用的背包问题 【题意分析】 本题在前面背包问题的基础上，增加了一个维度——质量，背包拥有了容积、承重两个限制，物品也有了体积、质量两种属性。 【参考资料】第一讲 0/1背包问题 与0/1背包类似，加…
阅读更多...
PDF文件格式（一）：交叉引用流

PDF文件格式（一）：交叉引用流

在PDF-1.5版本之前，对象的交叉引用信息是存储在交叉引用表(cross-reference table)中的。在PDF-1.5版本之后，引进了交叉引用流(cross-reference stream)对象，可以用它来存储对象的交叉引用信息，就像交叉引用表的功能一样。 采用交…
阅读更多...
C语言第十九弹---指针(三)

C语言第十九弹---指针(三)

✨个人主页： 熬夜学编程的小林 💗系列专栏： 【C语言详解】 【数据结构详解】 指针 1、数组名的理解 2、使用指针访问数组 3、⼀维数组传参的本质 4、冒泡排序 5、二级指针 6、指针数组 7、指针数组模拟二维数组 总结 1、数组名的理解…
阅读更多...
C++学习Day04之常函数和常对象

C++学习Day04之常函数和常对象

目录 一、程序及输出1.1 常函数1.1.1 不能修改对象的成员变量1.1.2 常函数可以被常对象和非常对象调用 1.2 常对象1.2.1 对象的成员变量不能被修改1.2.2 只能调用常函数，不能调用非常函数1.2.3 const_cast 调用非常函数 1.3 常函数中或常对象修改成员变量 二、分析与…
阅读更多...
070：vue+cesium: 利用canvas设置线性渐变色材质

070：vue+cesium: 利用canvas设置线性渐变色材质

第070个 点击查看专栏目录 本示例的目的是介绍如何在vue+cesium中设置线性渐变色的材质，这里使用canvas的辅助方法。 直接复制下面的 vue+cesium源代码，操作2分钟即可运行实现效果. 文章目录 示例效果配置方式示例源代码（共104行）专栏目标示例效果 配置方式 1）查看基础…
阅读更多...
WPF控件-ItemsControl

WPF控件-ItemsControl

介绍 ItemsControl是用于展示一组项的控件。我们常见的列表&#xff08;ListBox&#xff09;、数据表格&#xff08;DataGrid&#xff09;等都是继承自ItemsControl。可用于自定义样式展示各种批量的数据集合。 常见使用示例&#xff1a; <ItemsControl ItemsSource"…
阅读更多...
浅谈交换原理（2）——交换单元

浅谈交换原理（2）——交换单元

目录 一、交换网络的构成 二、交换单元 2.1 基本模型 2.2 分类 2.2.1 按照信息传送方向分类 2.2.2 按入出线的数量分类 2.2.3 按入出线之间是否共享单一通路分类 2.2.3.1 空分交换单元 2.2.3.2 时分交换单元 2.3 连接方式 2.4 性能 三、总结 一、交换网络的构成 交…
阅读更多...
Figma怎么设置中文，Figma有中文版吗？

Figma怎么设置中文，Figma有中文版吗？

不是很多人不想用 Figma&#xff0c;真是因为纯英文界面而头疼。这就是为什么有人会到处搜索 Figma 如何设置中文这样的问题。 然后我们直接快刀斩乱麻&#xff0c;Figma 没有中文版&#xff0c;但是我们还有其他的方法&#xff1a;例如&#xff0c; Figma 添加一个插件来解决…
阅读更多...
155基于matlab 的形态学权重自适应图像去噪

155基于matlab 的形态学权重自适应图像去噪

基于matlab 的形态学权重自适应图像去噪&#xff1b;通过串并联的滤波降噪对比图&#xff0c;说明并联降噪的优越性。输出降噪前后图像和不同方法的降噪情况的信噪比。程序已调通&#xff0c;可直接运行。 155matlab 自适应图像降噪 串并联降噪 (xiaohongshu.com)
阅读更多...
linux下 Make 和 Makefile构建你的项目

linux下 Make 和 Makefile构建你的项目

Make 和 Makefile构建你的项目 介绍 在软件开发中&#xff0c;构建项目是一个必不可少的步骤。make 是一个强大的自动化构建工具&#xff0c;而 Makefile 是 make 工具使用的配置文件&#xff0c;用于描述项目的构建规则和依赖关系。本篇博客将介绍 make 和 Makefile 的基本概…
阅读更多...
【机器学习】基于集成学习的 Amazon 用户评论质量预测

【机器学习】基于集成学习的 Amazon 用户评论质量预测

实验六: 基于集成学习的 Amazon 用户评论质量预测 1 案例简介 ​ 随着电商平台的兴起&#xff0c;以及疫情的持续影响&#xff0c;线上购物在我们的日常生活中扮演着越来越重要的角色。在进行线上商品挑选时&#xff0c;评论往往是我们十分关注的一个方面。然而目前电商网站的…
阅读更多...
《MySQL》超详细笔记

《MySQL》超详细笔记

目录 基本知识 主流数据库 数据库基本概念 MySQL启动 数据库基本命令 数据库 启动数据库 显示数据库 创建数据库 删除数据库 使用数据库 查询当前数据库信息 显示数据库中的表 导入数据库脚本 表 查看表的结构 查看创建某个表的SQL语句 数据库的查询命令 查询…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023