Gin框架基础

1、一个简单的Gin示例

下载并安装Gin:

go get -u github.com/gin-gonic/gin

1.1 一个简单的例子

package mainimport ("net/http""github.com/gin-gonic/gin"
)func main() {// 创建一个默认的路由引擎r := gin.Default()// 当客户端以GET方式访问 /hello 时,会执行后面的匿名函数,返回Hello Worldr.GET("/hello", func(ctx *gin.Context) {ctx.String(http.StatusOK, "Hello World")})r.GET("/json", func(ctx *gin.Context) {ctx.JSON(http.StatusOK, gin.H{"message": "Hello World",})})// 在8080端口监听r.Run(":8080")
}

使用浏览器打开127.0.0.1:8080/hello就能看到一串字符串,打开127.0.0.1:8080/json就能看到一串JSON字符串。
在这里插入图片描述

1.2 RESTful API

Gin 如何处理 GET, POST, PUT, PATCH, DELETE 和 OPTIONS 请求
Gin 处理各种 HTTP 请求是非常简单的,只要使用 router.XXX 方法即可注册处理器。其中 XXX 是 HTTP 请求方法的大写模式。

也就是说,Gin框架支持开发RESTful API的开发。
在这里插入图片描述

package mainimport ("net/http""github.com/gin-gonic/gin"
)func main() {// 创建一个默认的路由引擎r := gin.Default()//r.GET("/book", func(ctx *gin.Context) {ctx.JSON(http.StatusOK, gin.H{"message": "GET",})})r.POST("/book", func(ctx *gin.Context) {ctx.JSON(http.StatusOK, gin.H{"message": "POST",})})r.PUT("/book", func(ctx *gin.Context) {ctx.JSON(http.StatusOK, gin.H{"message": "PUT",})})r.DELETE("/book", func(ctx *gin.Context) {ctx.JSON(http.StatusOK, gin.H{"message": "DELETE",})})// 在8080端口监听r.Run(":8080")
}

开发RESTful API的时候我们通常使用Postman来作为客户端的测试工具。

在这里插入图片描述

2、获取参数

2.1、如何获取 GET 查询字符串参数?

查询字符串参数就是 URL 中 ? 后面 # 之前的参数,比如下面的 URL,
https://www.xxxxx.cn/user/search?username=金克斯&address=艾欧尼亚#reply0
查询字符串参数特指 username=金克斯&address=艾欧尼亚

Gin 的 Handler 提供了 以下几种方式

方法说明
ctx.Query()获取查询参数,如果参数不存在或值为空则返回空字符串 “”
ctx.DefaultQuery()获取查询参数,如果参数不存在或值为空则返回第二个参数做为值
ctx.GetQuery()类似于 c.Query(),但同时返回第二个 bool 参数用于判断该参数到底存不存在
  1. ctx.Query()
ctx.Query("username")	// 返回"金克斯"
ctx.Query("address")	// 返回"艾欧尼亚"
ctx.Query("gender")		// 返回""
  1. ctx.DefaultQuery()
ctx.DefaultQuery("username", "none")	// 返回"金克斯"
ctx.DefaultQuery("address", "none")		// 返回"艾欧尼亚"
ctx.DefaultQuery("gender", "none")		// 返回"none"
  1. ctx.GetQuery()
ctx.GetQuery("username")	// 返回("金克斯", true)
ctx.GetQuery("address") 	// 返回("艾欧尼亚", true)
ctx.GetQuery("gender")		// 返回("", false)

例子

package mainimport ("net/http""github.com/gin-gonic/gin"
)func main() {// 创建一个默认的路由引擎router := gin.Default()// 解析/user/search?username=金克斯&address=艾欧尼亚#reply0router.GET("/user/search", func(ctx *gin.Context) {username := ctx.Query("username")address, _ := ctx.GetQuery("address")gender := ctx.DefaultQuery("gender", "none")ctx.JSON(http.StatusOK, gin.H{"username": username,"address": address,"gender": gender,})})// 在8080端口监听router.Run(":8080")
}

浏览器返回http://127.0.0.1:8080/user/search?username=金克斯&address=艾欧尼亚#reply0,返回

{"address":"艾欧尼亚","gender":"none","username":"金克斯"}

2.2、如何获取 POST 表单form数据

Gin 提供了三个类似的方法用于获取 POST 请求提交的参数

方法说明
ctx.PostForm()获取 POST 表单参数,如果参数不存在或值为空则返回空字符串 “”
ctx.DefaultPostForm()获取 POST 表单参数,如果参数不存在或值为空则返回第二个参数做为值
ctx.GetPostForm()类似于 c.PostForm(),但同时返回第二个 bool 参数用于判断该参数到底存不存在
package mainimport ("net/http""github.com/gin-gonic/gin"
)func main() {// 创建一个默认的路由引擎router := gin.Default()// 解析/user/search?username=金克斯&address=艾欧尼亚#reply0router.POST("/user/search", func(ctx *gin.Context) {username := ctx.PostForm("username")address, _ := ctx.GetPostForm("address")gender := ctx.DefaultPostForm("gender", "none")ctx.JSON(http.StatusOK, gin.H{"username": username,"address": address,"gender": gender,})})// 在8080端口监听router.Run(":8080")
}

使用postman发送表单请求
在这里插入图片描述

2.3、如何同时获取 GET 数据和 POST 数据

package mainimport ("net/http""github.com/gin-gonic/gin"
)func main() {router := gin.Default()router.POST("user/search", func(ctx *gin.Context) {query_name := ctx.Query("name")query_address := ctx.Query("address")post_name := ctx.PostForm("name")post_address := ctx.PostForm("address")ctx.JSON(http.StatusOK, gin.H{"query_name": query_name,"query_address": query_address,"post_name": post_name,"post_address": post_address,})})router.Run(":8080")}

在这里插入图片描述

2.4、如何获取路由参数

在没有路由参数之前,如果我们想获取/user/1/user/2的用户数据,我们需要注册多个路由器

router.GET("/user/1", func(c *gin.Context) {})
router.GET("/user/2", func(c *gin.Context) {})

如果用户量大了,这个注册显然不靠谱。

Gin 允许我们使用 :[参数名] *[参数名] 来注册一个路由参数,比如上面的用户详情就可以注册为 /user/:user_id。然后我们就可以在路由 Handler 中通过 c.Param("user_id")获取到这个参数。

  • :[参数名] :路由参数能够匹配任何字符串,除了路径分隔符 /。 也就是说 /user/:user_id 可以匹配 /user/1 但不能匹配 /user/1/message
	router.GET("/user/:name", func(ctx *gin.Context) {name := ctx.Param("name")ctx.JSON(http.StatusOK, gin.H{"message": name,})})/*127.0.0.1:8080/user/金克斯, 返回 {"message":"金克斯"}127.0.0.1:8080/user/金克斯/艾欧尼亚, 返回 404 page not found*/
  • *[参数名] :路由参数可以匹配任意字符,包括/,也就是说 /user/:user_id 可以匹配 /user/1 也可以能匹配 /user/1/message ,还能匹配 /user/1/message/a/b/c/d/e
	router.GET("/user/:name/*address", func(ctx *gin.Context) {name := ctx.Param("name")address := ctx.Param("address")ctx.JSON(http.StatusOK, gin.H{"message": name,"address": address,})})/*127.0.0.1:8080/user/金克斯, 返回 {"address":"/","message":"金克斯"}127.0.0.1:8080/user/金克斯/艾欧尼亚, 返回 {"address":"/艾欧尼亚","message":"金克斯"}*/

Gin 的路由定义遵循几个规范

  • 和访问路径一样的路由定义(精确路由) 将会被优先匹配。 比如
	router.GET("/user/:name", func(ctx *gin.Context) {name := ctx.Param("name")ctx.JSON(http.StatusOK, gin.H{"message": name,})})// 精确路由(相对于有路由参数的路由)会被优先匹配,而无论他们在哪里定义router.GET("/user/groups", func(c *gin.Context) {c.String(http.StatusOK, "The available groups are [...]")})
  • 默认情况下,如果先定义的路由匹配了,那么后续定义的路由就不会被匹配。

2.5、如何接受表单中的字典(Map)参数

Gin 提供了 ctx.QueryMap() 用于获取字典形式的查询字符串参数,提供了ctx.PostFormMap()用于获取字典形式的 POST 表单参数。

package mainimport ("net/http""github.com/gin-gonic/gin"
)func main() {router := gin.Default()router.POST("/post", func(ctx *gin.Context) {ids := ctx.QueryMap("ids")names := ctx.PostFormMap("names")ctx.JSON(http.StatusOK, gin.H{"ids": ids,"names": names,})})router.Run(":8080")}

在这里插入图片描述

2.6、如何对请求参数模型绑定和验证

为了能够更方便的获取请求相关参数,提高开发效率,我们可以基于请求的Content-Type识别请求数据类型并利用反射机制自动提取请求中QueryStringform表单JSONXML等参数到结构体中。
原理都是一样的: 需要在要绑定的所有字段上,设置相应的 tag。例如,使用 JSON 绑定时,设置字段标签为 json:"fieldname"

Gin 框架提供了两类绑定方法:

  • 第一类: 必须绑定 (Must Bind),BindXXX() 方法,如果绑定出错则会直接抛出 400 错误:
    方法有: Bind(), BindJSON(), BindXML(), BindQuery(), BindYAML(), BindHeader(), BindTOML()。

  • 第二类: 应该绑定 (Should bind),ShouldBindXXX() 等方法,如果绑定出错则会抛出异常
    方法有: ShouldBind(), ShouldBindJSON(), ShouldBindXML(), ShouldBindQuery(), ShouldBindYAML(), ShouldBindHeader(), ShouldBindTOML(),

这些方法具体的实现调用了 ShouldBindWith()。 如果发生绑定错误,Gin 会返回错误并由开发者处理错误和请求。

package mainimport ("net/http""github.com/gin-gonic/gin"
)type Login struct {Username string `form:"username" json:"username" binding:"required"`Password string `form:"password" json:"password" binding:"required"`
}func main() {router := gin.Default()// 绑定JSON的示例 ({"username": "admin", "password": "123456"})router.POST("/loginJson", func(ctx *gin.Context) {var login Login// ShouldBind()会根据请求的Content-Type自行选择绑定器if err := ctx.ShouldBind(&login); err != nil {ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})return}if login.Username == "admin" && login.Password == "123456" {ctx.JSON(http.StatusOK, gin.H{"status":   "you are logged in","username": login.Username,"password": login.Password,})} else {ctx.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})}})// 绑定form表单示例router.POST("/loginForm", func(ctx *gin.Context) {var login Login// ShouldBind()会根据请求的Content-Type自行选择绑定器if err := ctx.ShouldBind(&login); err != nil {ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})return}if login.Username == "admin" && login.Password == "123456" {ctx.JSON(http.StatusOK, gin.H{"status":   "you are logged in","username": login.Username,"password": login.Password,})} else {ctx.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})}})// 绑定QueryString示例router.GET("loginQuery", func(ctx *gin.Context) {var login Login// ShouldBind()会根据请求的Content-Type自行选择绑定器if err := ctx.ShouldBind(&login); err != nil {ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})return}if login.Username == "admin" && login.Password == "123456" {ctx.JSON(http.StatusOK, gin.H{"status":   "you are logged in","username": login.Username,"password": login.Password,})} else {ctx.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})}})router.Run(":8080")}

绑定JSON
在这里插入图片描述
绑定form表单
在这里插入图片描述
绑定QueryString
在这里插入图片描述
需要注意的是,如果没有输入password,是会报错的。是因为tag中的binding:"required"进行了限制。如果将 Password 改为 binding:"-", 再次运行上面的示例就不会返回错误。

Password string `form:"password" json:"password" binding:"required"`

参考资料

李文周的博客
Gin 框架中文文档

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

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

相关文章

常见Web认证方式对比

认证是一个在用户或者设备在访问一个受限的系统时,鉴定用户凭据的过程,即确认“你是谁”的问题。最常见的认证用户的方式是通过用户名和密码的形式进行校验,目前存在多种校验方式,本文将对其进行一个简单的对比,使得大…

flutter项目中不能使用在ios样式组件下的组件有哪些

InkWell 未完待续,也请大家补充,评论区见

TensorFlow 的原理与使用

文章目录 TensorFlow 的基本原理1. 计算图(Computation Graph)2. 张量(Tensor)3. 会话(Session)4. 自动微分(Automatic Differentiation) TensorFlow 的使用安装 TensorFlow基本使用…

DDR3自刷新问题

DDR3 内存中的自刷新和手动刷新是两种不同的刷新机制,它们在目的、操作方式和使用场景上有所不同。让我们来比较这两种刷新方式: 自刷新): 目的:在系统低功耗模式下保持数据完整性。操作:由 DRAM 内部的电路…

160相交链表

解法1: public class Solution {public ListNode getIntersectionNode(ListNode headA, ListNode headB) {// 定义两个指针。// 获得两个链表的长度,将较长的链表先用指针移动到和短链表一样的长度。// 再一个个比较ListNode l1 headA, l2 headB;int …

Scala访问修饰符全解析:掌握类与成员的可见性

🔒 Scala访问修饰符全解析:掌握类与成员的可见性 在面向对象编程中,控制类成员的可见性是封装性的核心。Scala作为一门强类型的面向对象编程语言,提供了一套丰富的访问修饰符来实现这一点。本文将深入探讨Scala中的访问修饰符&am…

在我们的大数据平台(XSailbaot)上进行企业级数据建模的思路

1. 背景 笔者所在的公司是差不多二十年前搞CIM(公共信息模型的)起家的。当时公司的前辈搞了基于CIS协议的模型服务器、数据服务器、模式编辑器等,形成了一套基于公共信息模型建模的平台系统。其中可视化建模,建好了模式类以后&am…

Kotlin中对空的很多处理

代码图片直观效果 逐行解释Kotlin中对空的各种情况的使用 private fun testNull() {val flag 1var name: String? nullvar user: User? // 有警告, 因为下面的赋值可以和这一行定义合并var zhangUser: User? User()var wangUser: User User() // 提示Explicitly given t…

AttGAN实验复现 2024

AttnGAN 代码复现 2024 文章目录 AttnGAN 代码复现 2024简介环境python 依赖数据集TrainingPre-train DAMSMTrain AttnGAN SamplingB_VALIDATION 为 False (默认)B_VALIDATION 为 True 参考博客 简介 论文地址: https://arxiv.org/pdf/1711.10485.pdf 代码 python…

C++: 如何用C语言实现C++的虚函数机制?

前言 在 googletest的源码中,看到gtest-matchers.h 中实现的MatcherBase 类自定义了一个 VTable,这种设计实现了一种类似于C虚函数的机制。C中的虚函数机制实质上就是通过这种方式实现的,本文用c语言自定义虚函数表VTable实现了一下virtual的…

Workerman在线客服系统源码,附搭建教程

源码介绍: Workerman在线客服系统源码。 workerman是一个高性能的PHP socket 服务器框架,workerman基于PHP多进程以及libevent事件轮询库,PHP开发者只要实现一两个接口,便可以开发出自己的网络应用,例如Rpc服务、聊天…

微服务架构中的调试难题与分布式事务解决方案

微服务架构作为现代软件开发的一种主要趋势,因其灵活性、高可维护性和易于扩展的特点,得到了广泛的应用。然而,在享受微服务架构带来的诸多优点的同时,开发者也面临着一些新的挑战。调试的复杂性和分布式事务的处理是其中两个较为…

我的创作纪念日2024/07/01

机缘 最初成为创作者的初心,源于对知识的渴望和对分享的热爱。在多年的学习和工作过程中,我积累了大量的知识和经验,而这些经验和知识往往是通过实战项目和日常学习得来的。我发现,通过写作的方式将这些经验和知识记录下来&#…

掌握这五大要诀,轻松实现卓越管理

卓越的管理是团队取得成功的关键,要实现卓越管理,管理者需要明白卓越管理的秘诀。 一、定目标:明确方向,激发动力 卓越的管理必须有明确的目标。 一个清晰、具体、可衡量的目标能够为团队指明方向,激发成员的动力。…

240630_昇思学习打卡-Day12-Transformer中的Multiple-Head Attention

240630_昇思学习打卡-Day12-Transformer中的Multiple-Head Attention 以下为观看大佬课程及查阅资料总结所得,附大佬视频链接:Transformer中Self-Attention以及Multi-Head Attention详解_哔哩哔哩_bilibili,强烈建议先去看大佬视频&#xff…

【JavaScript脚本宇宙】从新手到专家:掌握主流JavaScript图表库的精髓

数据之美:探索六款不可错过的JavaScript图表库 前言 随着Web技术的快速发展,动画在网页设计中扮演着越来越重要的角色。不仅能够提升用户体验,还能使网站更加生动和吸引人。为了帮助开发者更轻松地实现各种动画效果,市面上出现了…

python解锁图片相似度的神奇力量

在这个信息爆炸的时代,图片成为了我们传递信息、表达情感和记录生活的重要方式。然而,面对海量的图片资源,如何快速准确地找到相似的图片,成为了一个亟待解决的问题。现在,让我们为您揭开图片相似度的神秘面纱,带您领略这一创新技术的魅力! 图片相似度技术,就像是一位…

修改uniapp中 input 的 placeholder 样式

使用placeholder-class增加类名&#xff08;这个可以&#xff09; <input type"text" class"search-input" placeholder-class"search-input-placeholder" placeholder"输入关键词搜索" /><style scoped> /deep/ .search…

docker harbor仓库搭建,主从库复制

背景&#xff1a;需要主机安装docker-ce和docer-compose #1.安装相关依赖. yum install -y yum-utils device-mapper-persistent-data lvm2 #2.下载官方的docker yum源文件 yum-config-manager --add-repo https://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo …

10款好用不火的PC软件,真的超好用!

AI视频生成&#xff1a;小说文案智能分镜智能识别角色和场景批量Ai绘图自动配音添加音乐一键合成视频https://aitools.jurilu.com/市场上有很多软件&#xff0c;除了那些常见的大众化软件&#xff0c;还有很多不为人知的小众软件&#xff0c;它们的作用非常强大&#xff0c;简洁…