Gin框架

已于 2024-09-04 19:10:43 修改
阅读量332 收藏
点赞数
分类专栏： golang学习 文章标签： golang gin
于 2023-10-11 23:09:01 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_64403619/article/details/133722751
版权

Gin框架

一、准备

1.下载依赖

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

2.引入依赖

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

3. （可选）如果使用诸如 http.StatusOK 之类的常量，则需要引入 net/http 包

import "net/http"

二、基本使用

1. 配置路由

package main

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

func main() {
	// 创建一个默认的路由引擎
	r := gin.Default()
	// 配置路由
	r.GET("/getInfo", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"msg": "成功",
		})
	})
	//启动 HTTP 服务,在8088端口监听
	r.Run(":8088")
}

在这里插入图片描述

三、Gin中的路由

1.路由概述

在 RESTful 架构中，每个网址代表一种资源，不同的请求方式表示执行不同的操作：

请求方式一般对应操作
GET（SELECT）从服务器取出资源（一项或多项）
POST（CREATE））在服务器新建一个资源
PUT（UPDATE）在服务器更新资源（客户端提供改变后的完整资源）
DELETE（DELETE））从服务器删除资源

2.简单路由

GET请求
r.GET("网址", func(c *gin.Context) {
c.String(200, "Get")
})
POST请求
r.POST("网址", func(c *gin.Context) {
c.String(200, "POST")
})
PUT请求
r.PUT("网址", func(c *gin.Context) {
c.String(200, "PUT")
})
DELETE请求
r.DELETE("网址", func(c *gin.Context) {
c.String(200, "DELETE")
})
动态路由
	r.GET("/getUser/:id", func(c *gin.Context) {
		id := c.Param("id")
		c.JSON(200, gin.H{
			"id":  id,
			"msg": "成功",
		})
	})

在这里插入图片描述

四、 响应格式

这里主要介绍使用比较多的字符串格式和json格式

c.String()

	r.GET("/getStr", func(c *gin.Context) {
		c.String(200, "成功")

	})

响应结果为字符串
在这里插入图片描述

c.JSON()

	r.GET("/getInfo", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"msg": "成功",
		})
	})

响应结果为json格式
在这里插入图片描述

五、路由传参

1.GET请求传值

请求路径： /user?uid=20&page=1

后端接收

router.GET("/user", func(c *gin.Context) {
//c.Query()接收请求GET请求路径参数
uid := c.Query("uid")
//c.DefaultQuery()接收请求GET请求路径参数，接收不到时，采用默认参数
page := c.DefaultQuery("page", "0")
c.String(200, "uid=%v page=%v", uid, page)
})

2.Post 请求传值(获取 form 表单)

请求路径：

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
</head>
<body>
<form action="/doAddUser" method="post">
用户名：<input type="text" name="username" />
密码: <input type="password" name="password" />
<input type="submit" value="提交">
</form>
</body>
</html>

后端接收

router.POST("/doAddUser", func(c *gin.Context) {
//c.PostForm()接收form表单数据，key要与form表单name属性对应
username := c.PostForm("username")
password := c.PostForm("password")
//c.PostForm()接收form表单数据，接收不到采用默认值，key要与form表单name属性对应
age := c.DefaultPostForm("age", "20")
c.JSON(200, gin.H{ "usernmae": username, "password": password, "age": age, })
})

3.动态路由传值

请求路径：/user/20

后端接收

r.GET("/user/:uid", func(c *gin.Context) {
//c.Param()接收动态路由参数
uid := c.Param("uid")
c.String(200, "userID=%s", uid)
})

4.GET，POST 传递的结构体数据

Get 传值绑定到结构体

请求路径: /?username=zhangsan&password=123456

后端接收

//注意首字母大写
type Userinfo struct {
Username string `form:"username" json:"user"`
Password string `form:"password" json:"password"` }


router.GET("/", func(c *gin.Context) {
var userinfo Userinfo
if err := c.ShouldBind(&userinfo); err == nil {
c.JSON(http.StatusOK, userinfo)
} else {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
}
})
Post 传值绑定到结构体

请求路径：
在这里插入图片描述

后端接收

router.POST("/doLogin", func(c *gin.Context) {
var userinfo Userinfo
if err := c.ShouldBind(&userinfo); err == nil {
c.JSON(http.StatusOK, userinfo)
} else {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
}
})

.ShouldBind()能够基于请求自动提
取 JSON、form 表单和 QueryString 类型的数据，并把值绑定到指定的结构体对象

六、路由组

func main() {
	router := gin.Default()
	// 简单的路由组: v1
	v1 := router.Group("/v1")
	{
		v1.POST("/login", loginEndpoint)
		v1.POST("/submit", submitEndpoint)
		v1.POST("/read", readEndpoint)
	}
	// 简单的路由组: v2
	v2 := router.Group("/v2")
	{
		v2.POST("/login", loginEndpoint)
		v2.POST("/submit", submitEndpoint)
		v2.POST("/read", readEndpoint)
	}
	router.Run(":8080")
}

七、Gin路由文件分组

新建 routes 文件夹，routes 文件下面新建 adminRoutes.goapiRoutes.go、defaultRoutes.go

新建adminRoutes

package routes

import (
	"net/http"

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

func AdminRoutesInit(router *gin.Engine) {
	adminRouter := router.Group("/admin")
	{
		adminRouter.GET("/user", func(c *gin.Context) {
			c.String(http.StatusOK, "用户")
		})
		adminRouter.GET("/news", func(c *gin.Context) {
			c.String(http.StatusOK, "news")
		})
	}
}

新建apiRoutes.go

package routes

import (
	"net/http"

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

func ApiRoutesInit(router *gin.Engine) {
	apiRoute := router.Group("/api")
	{
		apiRoute.GET("/user", func(c *gin.Context) {
			c.JSON(http.StatusOK, gin.H{"username": "张三",
				"age": 20})
		})
		apiRoute.GET("/news", func(c *gin.Context) {
			c.JSON(http.StatusOK, gin.H{"title": "这是新闻"})
		})
	}
}

新建defaultRoutes.go

package routes

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

func DefaultRoutesInit(router *gin.Engine) {
	defaultRoute := router.Group("/")
	{
		defaultRoute.GET("/", func(c *gin.Context) {
			c.String(200, "首页")
		})
	}
}

配置main.go

package main

import (
	"gin_demo/routes"
	"github.com/gin-gonic/gin"

//注意首字母大写
type Userinfo struct {
	Username string `form:"username" json:"user"`
	Password string `form:"password" json:"password"`
}

func main() {
	r := gin.Default()
	routes.AdminRoutesInit(r)
	routes.ApiRoutesInit(r)
	routes.DefaultRoutesInit(r)
	r.Run(":8080")
}

八、Gin中自定义控制器

控制器分组

1.新建controller/admin/NewsController.go
package admin

import (
	"net/http"

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

type NewsController struct {
}

func (c NewsController) Index(ctx *gin.Context) {
	ctx.String(http.StatusOK, "新闻首页")
}
2.新建 controller/admin/UserController.go
package admin

import (
	"net/http"

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

type UserController struct {
}

func (c UserController) Index(ctx *gin.Context) {
	ctx.String(http.StatusOK, "这是用户首页")
}
func (c UserController) Add(ctx *gin.Context) {
	ctx.String(http.StatusOK, "增加用户")
}
3.在路由文件分组中配置控制器(将处理中间件改为控制器的方法)
package routes

import (
	"gin_demo/controller/admin"

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

func AdminRoutesInit(router *gin.Engine) {
	adminRouter := router.Group("/admin")
	{
		adminRouter.GET("/user", admin.UserController{}.Index)
		adminRouter.GET("/user/add", admin.UserController{}.Add)
		adminRouter.GET("/news", admin.NewsController{}.Add)
	}
}

九、路由中间件

通俗的讲：中间件就是匹配路由前和匹配路由完成后执行的一系列操作

Gin 中的中间件必须是一个 gin.HandlerFunc 类型，配置路由的时候可以传递多个 func 回调函
数，最后一个 func 回调函数前面触发的方法都可以称为中间件。

1.路由中间件基本使用

package main

import (
	"fmt"

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

func initMiddleware(ctx *gin.Context) {
	fmt.Println("我是一个中间件")
}
func main() {
	r := gin.Default()
	r.GET("/", initMiddleware, func(ctx *gin.Context) {
		ctx.String(200, "首页--中间件演示")
	})
	r.GET("/news", initMiddleware, func(ctx *gin.Context) {
		ctx.String(200, "新闻页面--中间件演示")
	})
	r.Run(":8080")
}

2.ctx.Next()调用该请求的剩余处理程序

中间件里面加上 ctx.Next()可以让我们在路由匹配完成后执行一些操作
比如我们统计一个请求的执行时间。

package main

import (
	"fmt"
	"time"

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

func initMiddleware(ctx *gin.Context) {
	fmt.Println("1-执行中中间件")
	start := time.Now().UnixNano()
	// 调用该请求的剩余处理程序
	ctx.Next()
	fmt.Println("3-程序执行完成 计算时间")
	// 计算耗时 Go 语言中的 Since()函数保留时间值，并用于评估与实际时间的差异
	end := time.Now().UnixNano()
	fmt.Println(end - start)
}
func main() {
	r := gin.Default()
	r.GET("/", initMiddleware, func(ctx *gin.Context) {
		fmt.Println("2-执行首页返回数据")
		ctx.String(200, "首页--中间件演示")
	})
	r.GET("/news", initMiddleware, func(ctx *gin.Context) {
		ctx.String(200, "新闻页面--中间件演示")
	})
	r.Run(":8080")
}

3.全局中间件

package main

import (
	"fmt"

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

func initMiddleware(ctx *gin.Context) {
	fmt.Println("全局中间件 通过 r.Use 配置")
	// 调用该请求的剩余处理程序
	ctx.Next()
}
func main() {
	r := gin.Default()
	//注册全局中间件
	r.Use(initMiddleware)
	r.GET("/", func(ctx *gin.Context) {
		ctx.String(200, "首页--中间件演示")
	})
	r.GET("/news", func(ctx *gin.Context) {
		ctx.String(200, "新闻页面--中间件演示")
	})
	r.Run(":8080")
}

4.在路由分组中配置中间件

写法一：

shopGroup := r.Group("/shop", StatCost())
{
shopGroup.GET("/index", func(c *gin.Context) {...})
... }

写法二：

shopGroup := r.Group("/shop")
shopGroup.Use(StatCost())
{
shopGroup.GET("/index", func(c *gin.Context) {...})
... }

十、中间件和对应控制器之间共享数据

1.设置值

func InitAdminMiddleware(ctx *gin.Context) {
	// 可以通过 ctx.Set 在请求上下文中设置值，后续的处理函数能够取到该值
	ctx.Set("username", "张三")
}

2.获取值

func (c UserController) Index(ctx *gin.Context) {
	username, _ := ctx.Get("username")
}

十一、中间件注意事项

gin 默认中间件
gin.Default()默认使用了 Logger 和 Recovery 中间件，其中：
• Logger 中间件将日志写入 gin.DefaultWriter，即使配置了 GIN_MODE=release。
• Recovery 中间件会 recover 任何 panic。如果有 panic 的话，会写入 500 响应码。
如果不想使用上面两个默认的中间件，可以使用 **gin.New()**新建一个没有任何默认中间件的路由

gin 中间件中使用 goroutine
当在中间件或 handler 中启动新的 goroutine 时，不能使用原始的上下文（c *gin.Context），
必须使用其只读副本（c.Copy()）

r.GET("/", func(c *gin.Context) {
	//拷贝副本
	cCp := c.Copy()
	go func() {
	// simulate a long task with time.Sleep(). 5 seconds
	time.Sleep(5 * time.Second)
	// 这里使用你创建的副本
	fmt.Println("Done! in path " + cCp.Request.URL.Path)
	}()
	c.String(200, "首页")
})

十二、Gin中的Cookie

设置cookie

c.SetCookie(name, value string, maxAge int, path, domain string, secure, httpOnly bool)

获取cookie

cookie, err := c.Cookie("name")

完整demo

package main

import (
	"gin_demo/models"
	"github.com/gin-gonic/gin"
	"html/template"
)

func main() {
	r := gin.Default()
	r.SetFuncMap(template.FuncMap{"unixToDate": models.UnixToDate})
	r.GET("/", func(c *gin.Context) {
		//设置cookie
		c.SetCookie("usrename", "张三", 3600, "/", "localhost", false, true)
		c.String(200, "首页")
	})
	r.GET("/user", func(c *gin.Context) {
		//获取cookie
		username, _ := c.Cookie("usrename")
		c.String(200, "用户-"+username)
	})
	r.Run(":8080")
}

十三、Gin中的Session

Gin 官方没有给我们提供 Session 相关的文档，这个时候我们可以使用第三方的 Session 中间件来实现
session

gin-contrib/sessions 中间件支持的存储引擎：
• cookie
• memstore
• redis
• memcached
• mongodb

1.安装session包

go get github.com/gin-contrib/sessions

2.基本session用法

package main

import (
	"github.com/gin-contrib/sessions"
	"github.com/gin-contrib/sessions/cookie"
	"github.com/gin-gonic/gin"
)

func main() {
	r := gin.Default()
	// 1.创建基于 cookie 的存储引擎，secret11111 参数是用于加密的秘钥
	store := cookie.NewStore([]byte("secret11111"))
	// 设置 session 中间件，参数 mysession，指的是 session 的名字，也是 cookie 的名字
	// 2.store 是前面创建的存储引擎，我们可以替换成其他存储引擎
	r.Use(sessions.Sessions("mysession", store))
	r.GET("/", func(c *gin.Context) {
		//初始化 session 对象
		session := sessions.Default(c)
		//设置过期时间
		session.Options(sessions.Options{
			MaxAge: 3600 * 6, // 6hrs
		})
		//设置 Session
		session.Set("username", "张三")
		session.Save()
		c.JSON(200, gin.H{"msg": session.Get("username")})
	})
	r.GET("/user", func(c *gin.Context) {
		// 初始化 session 对象
		session := sessions.Default(c)
		// 通过 session.Get 读取 session 值
		username := session.Get("username")
		c.JSON(200, gin.H{"username": username})
	})
	r.Run(":8000")
}
爱敲代码的林先生
关注
专栏目录
Golang-Gin框架示例二十多个源码
04-26
Golang-Gin框架是Go语言中一款非常流行的Web开发框架，以其高效、简洁和易用性受到广大开发者喜爱。Gin框架基于Martini框架设计，使用了 httprouter 库作为路由解析器，提供了高性能的路由处理能力。在这个“Golang-...
gin框架安装以及gin的请求路由
01-20
本文将介绍如何在Windows环境下安装Gin框架，并讲解如何使用Gin进行请求路由的设置。 首先，安装Gin框架前需要确保你已经安装了Git和Go语言环境。在Windows上，你可以访问官方网站下载并安装Git和Go。Go的安装路径...
探索Gin框架：快速构建高性能的Golang Web应用
热门推荐
qq_35716689的博客
01-23 50万+
Gin框架是一个轻量级的Web框架，基于Go语言开发，旨在提供高性能和简洁的API。作者：鼠鼠我捏，要死了捏
探索Gin框架：Golang Gin框架请求参数的获取
qq_35716689的博客
02-06 36万+
我们在专栏的前面几篇文章内讲解了Gin框架的路由配置，服务启动等内容。在我们平常添加路由处理函数之后，就可以在路由处理函数中编写业务处理代码了，但在此之前我们往往需要获取请求参数，本文就详细的讲解下gin获取请求参数常见的几种方式。目录前言传递参数的方式HeaderURLHTTP Body直接获取请求参数获取URL Path中的参数获取URL Query中的参数获取HTTP Body中的参数绑定请求参数绑定Header参数绑定URL Path参数绑定URL Query参数绑定HTTP Body参数。
探索Gin框架：Golang使用Gin完成文件上传
qq_35716689的博客
02-02 37万+
Go标准库net/http对文件上传已经提供了非常完善的支持，Gin框架在其基础做了封装，使用更加简单便捷。作者：鼠鼠我捏，要死了捏
Go语言Gin框架安全加固：全面解析SQL注入、XSS与CSRF的解决方案
qq_35716689的博客
02-04 37万+
在使用 Gin 框架处理前端请求数据时，必须关注安全性问题，以防范常见的攻击。作者： 鼠鼠我捏，要死了捏
gin框架
Nieweishan的博客
12-18 1141
Gin是一个快速而高效的Go框架，用于构建Web应用程序。它具有简单而强大的功能，如路由、中间件、模板引擎等。Gin提供了一个简单易用的API，使得开发者可以快速地构建Web应用程序。使用router.GET()、router.POST()等方法定义路由，")})在Gin框架中，路由钩子（Hook）是一种在请求处理之前或之后执行特定操作的方法。路由钩子可以用于设置请求头、记录日志、处理异常等。在Gin框架中，可以使用正则表达式或字符串来绑定URL参数，例如/user/:id。
Golang gin框架
book_longker的专栏
03-27 2万+
gin框架学习一、Gin 介绍二、Gin 环境搭建三、golang 程序的热加载四、Gin 框架中的路由五、Gin HTML 模板渲染六、静态文件服务七、路由详解八、Gin 中自定义控制器九、Gin 中间件十、Gin 中自定义Model十一、Gin 文件上传十二、Gin 中的Cookie十三、Gin 中的Session十四、Gin 中使用GORM 操作mysql 数据库十五、原生 SQL 和 SQL 生成器十六、Gin 中使用GORM 实现表关联查询十七、 GORM 中使用事务十八、Gin 中使用go
Gin框架 源码解析
S_ZaiJiangHu的博客
03-14 1043
接下来又回到了 gin.go ，可以看到上面的注册入口是通过group.engine 调用的，大家不用看 routerGroup 的结构也大致猜出来了吧，其实 engine 才是真正的路由树 router，而 gin 为了实现路由组的功能，所以在外面又包了一层 routerGroup，实现路由分组，路由路径组合隔离的功能。本系列 “拆轮子系列：gin 框架” 的第一篇就到这里了，这么通读下来，发现 gin 框架的设计和实现真的太棒了，简洁清晰，又不失巧妙，很适合大家也去阅读学习一下，墙裂推荐！
Gin框架原理
追求幸福，探索未知的博客
07-16 1171
Gin是Go语言写的一个web框架，它具有运行速度快，分组的路由器，良好的崩溃捕获和错误处理，非常好的支持中间件和json。Gin官网Gin是一个golang的微框架，封装比较优雅，API友好，源码注释比较明确，具有快速灵活，容错方便等特点。对于golang而言，web框架的依赖要远比Python，Java之类的要小。自身的net/http足够简单，性能也非常不错。借助框架开发，不仅可以省去很多常用的封装带来的时间，也有助于团队的编码风格和形成规范。.........
Gin 框架入门实战
weixin_43976267的博客
04-15 2493
gin框架入门到实战
Go语言中的gin框架之GET/POST请求参数接收传值（五）
06-15
在Go语言中，Gin框架是一个...总结，Gin框架在处理GET和POST请求参数时提供了多种方法，包括从URL查询字符串、JSON请求体以及Form数据中获取参数。这使得Gin成为构建Web服务的强大工具，特别是在Go语言的生态系统中。
GO语言gin框架实现管理员认证登陆接口
12-16
在本文中，我们将探讨如何使用Go语言的Gin框架实现后台管理员的登录验证接口。Gin是一个基于Golang的Web框架，它提供了快速、简洁的API开发方式。下面，我们将详细讲解实现这一功能的关键步骤。 首先，我们需要创建...
Go Web开发进阶实战（gin框架）
01-05
Go Web开发进阶实战（gin框架）课程，适用于Go语言初学者、掌握Go语言基础语法想学习进阶内容。 由在职程序员打造的Go语言实战课程体系，与你分享企业项目开发经验与技巧。真正做到课程有内容、有深度，并且老师讲...
【Go】-Context库的使用
knoci的博客
09-13 800
当截止日过期时，当调用返回的cancel函数时，或者当父上下文的Done通道关闭时，返回上下文的Done通道将被关闭，以最先发生的情况为准。取消此上下文将释放与其相关的资源，因此代码应该在此上下文中运行的操作完成后立即调用cancel，通常用于数据库或者网络连接的超时控制。用来处理一个请求的 goroutine 通常需要访问一些与请求特定的数据，比如终端用户的身份认证信息、验证相关的token、请求的截止时间。取消此上下文将释放与其关联的资源，因此代码应该在此上下文中运行的操作完成后立即调用cancel。
Golang | Leetcode Golang题解之第409题最长回文串
最新发布
weixin_66442839的博客
09-16 385
Golang | Leetcode Golang题解之第409题最长回文串
go语言的基本语法
Au_ust的博客
09-16 659
不加defer应为1111111222222233333334444444加了之后为1111111333333344444442222222因为defer置后了两个函数的调用，采用栈的结构打印先被defer的语句后执行，后被defer的语句先执行（后进先出）defer函数:在return之前，所有的defer函数会执行完毕当执行外围函数中的return语句时，只有其中所有的延迟函数都执行完毕后外围函数才会真正返回。
Go语言错误处理之道：优雅地应对程序中的问题
王中阳的博客
09-13 510
错误处理是Go语言编程中的一个重要概念。通过返回错误、检查错误、使用defer进行资源清理、包装和传播错误，Go开发者可以编写出健壮且可靠的代码。对于初学者来说，养成良好的错误处理习惯将有助于你成长为一名更专业的程序员。
Gin框架详解：v1.7.1版本的高效API设计与实现
Gin框架介绍(v1.7.1) 是一个轻量级、高效的API开发框架，专为构建高性能的Web服务而设计。以下是一些核心特点和工作原理的详细解析： 1. **快速路由与内存效率**: Gin采用基数树（Radix Tree）数据结构实现路由...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

爱敲代码的林先生

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

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

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

打赏作者

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

抵扣说明：

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

余额充值