Gin框架基础

最新推荐文章于 2024-07-22 22:54:57 发布
最新推荐文章于 2024-07-22 22:54:57 发布
阅读量795 收藏 10
点赞数 16
分类专栏： go语言 文章标签： gin golang 微服务
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Ricardo2/article/details/135425976
版权

1、一个简单的Gin示例

下载并安装Gin:

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

1.1 一个简单的例子

package main

import (
    "net/http"
	"github.com/gin-gonic/gin"
)


func main() {
	// 创建一个默认的路由引擎
	r := gin.Default()

	// 当客户端以GET方式访问 /hello 时，会执行后面的匿名函数，返回Hello World
	r.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 main

import (
    "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 main

import (
    "net/http"
	"github.com/gin-gonic/gin"
)


func main() {
	// 创建一个默认的路由引擎
	router := gin.Default()

	// 解析/user/search?username=金克斯&address=艾欧尼亚#reply0
	router.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 main

import (
	"net/http"

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


func main() {
	// 创建一个默认的路由引擎
	router := gin.Default()

	// 解析/user/search?username=金克斯&address=艾欧尼亚#reply0
	router.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 main

import (
	"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 main

import (
	"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识别请求数据类型并利用反射机制自动提取请求中QueryString、form表单、JSON、XML等参数到结构体中。
原理都是一样的： 需要在要绑定的所有字段上，设置相应的 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 main

import (
	"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 框架中文文档

闲谈社
关注
  • 16
    点赞
  • 踩
  • 10
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Gin框架基础配置
2301_76609089的博客
10-19 146
Linux平台示例：full_bin = "APP_ENV=dev APP_USER=air ./tmp/main.exe"# Windows平台示例: cmd = "go build -o ./tmp/main.exe ."4.代码开发时需要不断的修改代码，然后重新编译启动程序，需要重复性的执行相关命令，如果使用。# 使用 . 或绝对路径，请注意 `tmp_dir` 目录必须在 `root` 目录下。# air的日志文件名，该日志文件放置在你的`tmp_dir`中。看到这里，我们的路刚刚开始！
gin框架基础
weixin_45176825的博客
07-20 384
gin框架基础
探索Gin框架：Golang Gin框架请求参数的获取
热门推荐
qq_35716689的博客
02-06 27万+
我们在专栏的前面几篇文章内讲解了Gin框架的路由配置，服务启动等内容。在我们平常添加路由处理函数之后，就可以在路由处理函数中编写业务处理代码了，但在此之前我们往往需要获取请求参数，本文就详细的讲解下gin获取请求参数常见的几种方式。目录前言传递参数的方式HeaderURLHTTP Body直接获取请求参数获取URL Path中的参数获取URL Query中的参数获取HTTP Body中的参数绑定请求参数绑定Header参数绑定URL Path参数绑定URL Query参数绑定HTTP Body参数。
gin 框架基础知识总结
qq_36261130的博客
11-06 969
gin 是什么 目前Github上Star最多的Go Web 框架 优势 简单原则 并发高 分配内存少 快速开始 package main // 声明包 /// 程序执行顺序 导入包 ( 导入包 (...) -> 变量/常量 ->init() ) --> 变量/常量初始化 --> init() --> main() // 导入包 import "github.com/gin-gonic/gin" // 程序入口, 主函数 func main() { // 快速开始
golang 的 gin 框架基础封装
05-11
无论个人、团队、企业都能拿来即用的gin框架基础封装，现在已经包含了gin框架类似mvc模式的封装、路由、数据库、中间件、动态读取配置文件等都已实现； 后续会开发包含基础注册等功能，包括很多公共方法的封装，目的...
golang gin简单基础框架
09-18
Gin 框架是 Go 语言中一个非常流行的、基于 HTTP 的 web 开发框架，它以其简洁的 API 设计和高性能而受到开发者们的青睐。本教程将带你深入理解 Golang Gin 的基本概念和使用方法。 ### Gin 框架简介 Gin 是由 ...
Go Web开发进阶实战（gin框架）
01-05
Go Web开发进阶实战（gin框架）课程，适用于Go语言初学者、掌握Go语言基础语法想学习进阶内容。 由在职程序员打造的Go语言实战课程体系，与你分享企业项目开发经验与技巧。真正做到课程有内容、有深度，并且老师讲...
Go Gin MVC框架脚手架
12-17
Go Gin MVC框架脚手架是基于Gin框架构建的一个高效且结构化的Web开发框架，它为开发者提供了一种快速启动项目的方式。Gin框架本身是一个轻量级的库，使用了Martini-like API，旨在提高开发速度，同时保持代码的清晰...
go语言,gin框架的基础模块封装
03-03
go,配置文件，控制器，路由，数据库的封装demo，开箱即用超简洁版本。
Go之Web急速入门Gin+Gorm框架
Meta39的博客
07-20 413
Go之Web急速入门Gin+Gorm框架
【Gin】精准应用：Gin框架中工厂模式的现代软件开发策略与实施技巧(下)
寸铁的博客
07-22 632
在现代软件开发中，设计模式是提高代码质量和可维护性的重要工具之一。特别是对于像Gin这样的高性能、轻量级的Web框架，如何合理运用设计模式显得尤为重要。工厂模式作为其中一种经典的创建型模式，能够帮助开发者有效地解耦对象的创建过程，并提供更大的灵活性和可扩展性。本文将深入探讨在Gin框架中工厂模式的具体应用场景、实施技巧以及现代软件开发中的最佳实践。
[沫忘录]Golang基础类型与语法
m0_73027268的博客
07-18 359
golang基础
protoc-gen-go-http: program not found or is not executable
lemonth的博客
07-19 326
1 先升级到最新版 sudo kratos upgrade #3 安装 protoc-gen-go-errors。
go-zero框架入门
qq_63728673的博客
07-18 634
使用 Raft 共识算法**，确保了在分布式环境中的强一致性**。再举个例子：正常项目中配置文件写在代码中，若配置文件修改，项目就该重新启动，但是若使用了etcd，每次去查看对应RPC的配置信息时都是从etcd中实时获取。并且etcd本身为分布式系统设计，提供了原生的服务发现和配置管理功能，支持 Watch 机制，可以。之后打开一个命令行窗口，输入：etcd就可以启动了，然后再打开一个黑窗口（上一个不要关）这就是go-zero使用前的前置工作了，下一步就是去写简单的项目。1.在根目录下创建一个user包。
Golang | Leetcode Golang题解之第241题为运算表达式设计优先级
weixin_66442839的博客
07-18 549
Golang | Leetcode Golang题解之第241题为运算表达式设计优先级
Go基础编程 - 11 - 函数（func）
07-22 492
Go语言函数详解，匿名函数、闭包、递归、延迟调用、高阶函数等。
go语言Gin框架的学习路线(八)
最新发布
juzihuaile的博客
07-22 639
期末放假在家自学go语言Gin框架,希望我们可以一起学习!
go recover
bonfirelit的博客
07-17 206
在second中发生panic，second中没有defer，故立即退出，panic沿着调用栈传递到first中，first因为调用的second函数发生panic，也应该退出，但是由于first中有recover，故执行defer的recover，捕获了这个panic，使得它不会再沿着调用栈传到main中。但是main随后调用second，又发生panic，panic沿着调用栈传递到main中，导致main退出，不会输出”End of main“
Gin框架详解：Golang web开发利器
"Golang gin 中文文档" Golang Gin 是一个轻量级的Web框架，以其高效、简洁的API设计受到许多开发者的欢迎。... **Gin路由** Gin的路由系统是其...通过学习和使用Gin，开发者可以更专注于业务逻辑，而不是基础架构。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

闲谈社

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值