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

前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到网站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()
}

两种方式的对比

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

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

小结

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

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

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

相关文章

为什么有的人渐渐不点外卖了？

为什么有的人渐渐不点外卖了？

​随着互联网的发展和普及，外卖行业也在近几年内得到了迅猛的发展，它方便快捷、节省时间的特点使得外卖成为了很多人生活的一部分。但是，随着时间的推移，越来越多的人开始减少点外卖的频率，这是为什么呢？ 首…
阅读更多...
npm修改镜像源

npm修改镜像源

背景：切换npm镜像源是经常遇到的事，下面记录下具体操作命令 1. 打开终端运行"npm config get registry"命令来查看当前配置的镜像源 npm config get registry2. 修改成淘宝镜像源"https://registry.npmjs.org/" npm config set re…
阅读更多...
编译原理与技术（三）——语法分析（二）自顶向下-递归下降

编译原理与技术（三）——语法分析（二）自顶向下-递归下降

一、语法分析的两种方法 自顶向下（Top-down）： 针对输入串，从文法的开始符号出发，尝试根据产生式规则推导（derive）出该输入串。 从根部开始构造语法树。 自底向上（Bottom-up&#…
阅读更多...
鸿蒙踩坑合集

鸿蒙踩坑合集

各位网络中的小伙们，关于鸿蒙的踩坑陆陆续续收集中，本文章会持续更新，希望对您有所帮助 1、预览视图无法正常加载 重新编译项目，点击刷新按钮，控制台提示Build task failed. Open the Run window to view details. 解…
阅读更多...
图书借阅管理系统

图书借阅管理系统

文章目录 图书借阅管理系统一、项目演示二、项目介绍三、万字文档参考四、系统部分功能截图五、部分代码展示六、底部获取项目和万字文档（9.9￥带走） 图书借阅管理系统 一、项目演示 图书借阅管理系统 二、项目介绍 基于Springbootvue的前后…
阅读更多...
二、SSM 整合配置实战

二、SSM 整合配置实战

本章概要 依赖整合和添加控制层配置编写(SpringMVC 整合)业务配置编写(AOP/TX 整合)持久层配置编写(MyBatis 整合)容器初始化配置类整合测试 2.1 依赖整合和添加 数据库准备 数据库脚本 CREATE DATABASE mybatis-example;USE mybatis-example;CREATE TABLE t_emp(emp_id INT…
阅读更多...
HarmonyOS远程真机调试方法

HarmonyOS远程真机调试方法

生成密钥库文件 打开DevEco Studio，点击菜单栏上的build， 填一些信息点击，没有key的话点击new一个新的key。 生成profile文件 AppGallery Connect (huawei.com) 进入该链接网站，点击用户与访问将刚生成的csr证书提交上去其中需…
阅读更多...
【蓝桥杯选拔赛真题91】Scratch筛选数据 第十五届蓝桥杯scratch图形化编程 少儿编程创意编程选拔赛真题解析

【蓝桥杯选拔赛真题91】Scratch筛选数据 第十五届蓝桥杯scratch图形化编程 少儿编程创意编程选拔赛真题解析

目录 scratch筛选数据 一、题目要求 编程实现 二、案例分析 1、角色分析
阅读更多...
2024版细致idea解读（包含下载，安装，破解，讲解怎么使用）

2024版细致idea解读（包含下载，安装，破解，讲解怎么使用）

前言 我们历经了对应的javase开发，使用的软件从eclipse也逐步升级到了idea，IntelliJ旗下的产品之一 内部复函很大的集成平台插件供大家使用 下载介绍 IntelliJ IDEA – 领先的 Java 和 Kotlin IDE 这个是他的网站地址 进入之后我们可以看到对应的界面…
阅读更多...
【经典例子】Java实现2048小游戏（附带源码）

【经典例子】Java实现2048小游戏（附带源码）

一、游戏回顾 2048游戏是一款数字益智游戏，目标是通过合并相同数字的方块来达到2048这个目标。游戏在一个4x4的方格上进行，每个方格上都有一个数字（初始时为2或4）。玩家可以通过滑动方向键（上、下、左、右）…
阅读更多...
SpringBoot 事务管理Transactional 数据回滚 数据一致性

SpringBoot 事务管理Transactional 数据回滚 数据一致性

介绍 SpringBoot当中的事物他保证了一致性，要么全部一起成功（提交），要么一起失败，失败（回滚）后数据会回到当初的样子，是一组操作的集合。 事物类型 开启事物提交事物回滚事物 案…
阅读更多...
银河麒麟 aarch64 Mysql环境安装

银河麒麟 aarch64 Mysql环境安装

一、操作系统版本信息 组件版本操作系统Kylin V10 (SP3) /(Lance)-aarch64-Build23/20230324Kernel4.19.90-52.22.v2207.ky10.aarch64MySQLmysql-8.3.0JDK1.8.0_312 二、MySQL下载 官网下载地址：https://dev.mysql.com/downloads/mysql/ 三、MySQL 安装 3.1 删…
阅读更多...
图数据库neo4j入门

图数据库neo4j入门

neo4j 一、安装二、简单操作<一>、创建<二>、查询<三>、关系<四>、修改<五>、删除 三、常见报错<一>、默认的数据库密码是neo4j,打开浏览器http://localhost:7474登录不上,报错: Neo.ClientError.Security.Unauthorized: The client is un…
阅读更多...
Mac利用brew安装mysql并设置初始密码

Mac利用brew安装mysql并设置初始密码

前言 之前一直是在windows上开发后段程序&#xff0c;所以只在windows上装mysql。(我记得linux只需要适应yum之类的命令即可) 另外, linux的移步 linux安装mysql (详细步骤,初次初始化,sql小例子,可视化操作客户端推荐) 好家伙&#xff0c;我佛了&#xff0c;写完当天网上发…
阅读更多...
【十】【C++】string类的模拟实现

【十】【C++】string类的模拟实现

浅拷贝 浅拷贝&#xff08;Shallow Copy&#xff09;是对象复制的一种方式&#xff0c;其中复制对象的过程仅仅复制对象的值&#xff0c;而不复制引用所指向的实际对象或数据。这意味着原始对象和拷贝对象会共享相同的引用或指针指向的数据。 浅拷贝的特点&#xff1a; 共享…
阅读更多...
深入解析Elasticsearch的内部数据结构和机制：行存储、列存储与倒排索引之行存（一）

深入解析Elasticsearch的内部数据结构和机制：行存储、列存储与倒排索引之行存（一）

在当今的大数据时代&#xff0c;高效的数据检索和分析能力已成为许多应用程序的核心需求。Elasticsearch&#xff0c;作为一款强大的分布式搜索和分析引擎&#xff0c;正是为了满足这些需求而诞生的。它之所以能够在海量数据中实现毫秒级的搜索响应&#xff0c;以及灵活的数据分…
阅读更多...
2024/02/06

2024/02/06

画出TCP三次握手和四次挥手的示意图 三次握手 四次挥手 并且总结TCP和UDP的区别 TCP: TCP提供面向连接的&#xff0c;可靠的数据传输服务传输过程中&#xff0c;数据无误、数据无丢失、数据无失序、数据无重复 TCP会给每个数据包编上编号&#xff0c;该编号称之为序列号每个序…
阅读更多...
Minio Linux 安装

Minio Linux 安装

1.下载地址 MinIO | Code and downloads to create high performance object storage 2.创建文件相关文件夹 mkdir 3.赋权 chomd x minio 4.创建用户组和租户 groupadd minio ### useradd minio -g minio ### 验证 cat /etc/passwd5.创建配置文件 vi minio.confMINIO_VOLU…
阅读更多...
带着问题阅读源码——Spring MVC是如何在Spring Boot中注入的？

带着问题阅读源码——Spring MVC是如何在Spring Boot中注入的？

Spring MVC简介 Spring Web的MVC框架旨在全面处理HTTP请求&#xff0c;它具备以下特性&#xff1a; 可配置的处理程序映射&#xff1a;允许开发者根据需要将特定的URL路径映射到相应的处理程序上。 视图解析&#xff1a;框架能够根据处理程序返回的逻辑视图名&#xff0c;解析…
阅读更多...
微软.NET6开发中解决方案和项目的概念

微软.NET6开发中解决方案和项目的概念

我是荔园微风&#xff0c;作为一名在IT界整整25年的老兵&#xff0c;看到不少初学者在学习编程语言的过程中如此的痛苦&#xff0c;我决定做点什么&#xff0c;下面我就重点讲讲微软.NET6开发中解决方案和项目的概念。我将介绍 Visual Studio 2022的解决方案和项目的结构及组成…
阅读更多...
最新文章

Copyright @ 2022~2023