当前位置：首页 > news >正文

【Go】面向萌新的Gin框架知识梳理学习笔记

news 文章来源：https://blog.csdn.net/uuzeray/article/details/137203920 2024/11/16 22:48:23

Gin框架简介

路由&路由组

1. 定义基本路由

2. 参数传递

3. 查询字符串参数

4. 路由组

5. 路由中间件

模板渲染

1. 加载模板

2. 定义模板

3. 渲染模板

4. 自定义模板函数

返回json

1. 导入 Gin 包

2. 创建 Gin 引擎

3. 定义路由和处理器函数

4. 运行服务器

获取参数

1.获取 QueryString 参数

2.获取 Form 参数

3.获取 URL 路径参数

参数绑定

1. 绑定 JSON 数据

2. 绑定 Form 表单数据

3. 绑定 Query 参数

请求重定向

1. 重定向到指定 URL

2. 重定向到命名路由

3. 重定向到相对路径

4. 重定向的状态码

中间件

1. 中间件的基本概念

2. 注册中间件

3. 在特定路由或路由组中使用中间件

4. 中间件链

5. 中间件的顺序

文件上传

1. 单个文件上传

2. 多个文件上传

3. 限制文件大小

Gin框架简介

Gin 是一个用 Go 语言编写的 Web 框架，它提供了一组强大的工具和功能，用于快速构建高性能的 Web 应用程序和 API。

路由&路由组

在 Gin 框架中，路由（Routes）用于定义客户端请求的 URL 和处理器函数之间的映射关系。通过路由，可以将特定的 URL 请求映射到相应的处理器函数，从而实现 Web 应用的功能。Gin 框架提供了灵活而强大的路由功能，同时支持路由组（Route Groups），可以方便地对多个相关的路由进行分组管理。下面详细介绍 Gin 框架的路由和路由组：

1. 定义基本路由

在 Gin 中，通过调用 GET、POST、PUT、DELETE 等方法可以定义不同 HTTP 方法的路由，并指定相应的处理器函数。

import "github.com/gin-gonic/gin"func main() {router := gin.Default()// GET 请求router.GET("/hello", func(c *gin.Context) {c.String(200, "Hello, Gin!")})// POST 请求router.POST("/user", func(c *gin.Context) {// 处理 POST 请求})router.Run(":8080")
}

2. 参数传递

通过路由可以传递 URL 参数，参数可以通过 gin.Context 对象的方法来获取。

router.GET("/hello/:name", func(c *gin.Context) {name := c.Param("name")c.String(200, "Hello, %s!", name)
})

3. 查询字符串参数

可以使用 Query 方法获取查询字符串参数。

router.GET("/user", func(c *gin.Context) {name := c.Query("name")age := c.Query("age")c.String(200, "Name: %s, Age: %s", name, age)
})

4. 路由组

路由组允许将一组相关的路由进行分组管理，提高代码的可读性和维护性。

api := router.Group("/api")
{api.GET("/users", func(c *gin.Context) {// 处理获取用户列表的请求})api.POST("/users", func(c *gin.Context) {// 处理创建用户的请求})
}

5. 路由中间件

可以为路由或路由组添加中间件，以实现对特定路由的预处理或后处理操作。

router.GET("/admin", AuthMiddleware, func(c *gin.Context) {// 处理需要身份验证的请求
})func AuthMiddleware(c *gin.Context) {// 身份验证逻辑
}

模板渲染

Gin 框架提供了强大的模板渲染功能，允许开发者将动态数据嵌入到 HTML 模板中，从而生成响应客户端请求的动态网页。以下是如何在 Gin 中使用模板渲染的详细介绍：

1. 加载模板

在使用 Gin 渲染模板之前，首先需要加载模板文件。Gin 提供了多种加载模板的方法，可以加载单个文件、加载指定目录下的所有文件等。

加载单个模板文件：

router.LoadHTMLFiles("templates/index.html")

router.LoadHTMLGlob("templates/*")

2. 定义模板

模板文件通常是 .html 文件，里面可以包含静态的 HTML 标签，也可以包含用于动态数据绑定的模板语法。Gin 使用 Go 标准库的 html/template 包作为模板引擎，支持所有 html/template 的功能。

假设我们有一个模板文件 templates/index.html，内容如下：

<html>
<body><h1>Hello, {{ .Name }}!</h1>
</body>
</html>

这里 {{ .Name }} 是一个模板动作，它会在模板渲染时被替换成具体的值。

3. 渲染模板

在定义了模板文件之后，就可以在处理器函数中使用 HTML 方法来渲染模板了。这个方法接受 HTTP 状态码、模板文件名和传递给模板的数据作为参数。

router.GET("/", func(c *gin.Context) {c.HTML(200, "index.html", gin.H{"Name": "Gin",})
})

在这个例子中，我们渲染了之前定义的 index.html 模板，并传递了一个包含 Name 字段的数据。在模板中，{{ .Name }} 会被替换成 "Gin"。

4. 自定义模板函数

Gin 允许开发者定义自己的模板函数，以便在模板中执行更复杂的操作。可以通过 FuncMap 类型来定义模板函数，并在加载模板之前使用 SetFuncMap 方法将其注册到模板引擎。

func formatAsDate(t time.Time) string {year, month, day := t.Date()return fmt.Sprintf("%d/%02d/%02d", year, month, day)
}router := gin.Default()
router.SetFuncMap(template.FuncMap{"formatAsDate": formatAsDate,
})
router.LoadHTMLGlob("templates/*")

在模板中使用自定义函数：

<div>Date: {{ .Date | formatAsDate }}</div>

返回json

在 Gin 框架中，返回 JSON 数据非常简单。Gin 提供了方便的方法来渲染和返回 JSON 响应。以下是详细介绍如何在 Gin 中返回 JSON 数据的步骤：

1. 导入 Gin 包

首先，确保你已经安装了 Gin 框架，并导入 Gin 包到你的 Go 项目中：

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

2. 创建 Gin 引擎

接着，创建一个 Gin 引擎，通常可以选择 gin.Default() 来创建一个默认的引擎：

router := gin.Default()

3. 定义路由和处理器函数

在 Gin 中，你可以使用不同的 HTTP 方法来定义路由，并指定处理该路由的函数。对于返回 JSON 数据的处理器函数，通常会使用 c.JSON() 方法来渲染 JSON 数据并发送响应。

router.GET("/user/:id", func(c *gin.Context) {id := c.Param("id")// 从数据库或其他地方获取用户信息user := getUserByID(id)// 返回 JSON 响应c.JSON(http.StatusOK, gin.H{"id":   user.ID,"name": user.Name,"age":  user.Age,})
})

在这个例子中，我们定义了一个 GET 请求的路由 /user/:id，并指定了一个处理函数。该处理函数首先从 URL 参数中获取用户的 ID，然后根据该 ID 获取用户信息。最后，使用 c.JSON() 方法将用户信息以 JSON 格式返回给客户端。

4. 运行服务器

最后，使用 router.Run() 方法启动 Gin 服务器，指定监听的端口：

router.Run(":8080")

获取参数

在 Gin 框架中，获取参数可以通过不同的方式，包括获取 QueryString 参数、Form 参数以及 URL 路径参数。

1.获取 QueryString 参数

QueryString 参数是附加在 URL 后面的键值对，形如 ?key1=value1&key2=value2。在 Gin 中，可以使用 c.Query() 方法来获取 QueryString 参数。

router.GET("/query", func(c *gin.Context) {// 获取名为 "key" 的 QueryString 参数的值key := c.Query("key")c.JSON(http.StatusOK, gin.H{"key": key,})
})

2.获取 Form 参数

Form 参数通常是通过 POST 请求发送的表单数据。在 Gin 中，可以使用 c.PostForm() 方法来获取 Form 参数。

router.POST("/form", func(c *gin.Context) {// 获取名为 "key" 的 Form 参数的值key := c.PostForm("key")c.JSON(http.StatusOK, gin.H{"key": key,})
})

3.获取 URL 路径参数

URL 路径参数是在路由中定义的参数，例如 /user/:id 中的 :id 就是一个 URL 路径参数。在 Gin 中，可以使用 c.Param() 方法来获取 URL 路径参数。

router.GET("/user/:id", func(c *gin.Context) {// 获取名为 "id" 的 URL 路径参数的值id := c.Param("id")c.JSON(http.StatusOK, gin.H{"id": id,})
})

参数绑定

在 Gin 框架中，参数绑定是指将请求中的数据绑定到结构体或其他数据类型的过程。这样可以简化处理请求数据的过程，并提高代码的可读性和可维护性。Gin 框架提供了丰富的参数绑定功能，包括绑定 JSON 数据、Form 表单数据、Query 参数等。

1. 绑定 JSON 数据

在 Gin 中，可以使用 BindJSON 方法将请求中的 JSON 数据绑定到结构体中。

type User struct {Name string `json:"name"`Age  int    `json:"age"`
}router.POST("/json", func(c *gin.Context) {var user Userif err := c.BindJSON(&user); err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})return}c.JSON(http.StatusOK, user)
})

2. 绑定 Form 表单数据

可以使用 Bind 或 BindWith 方法将请求中的 Form 表单数据绑定到结构体中。

type LoginForm struct {Username string `form:"username"`Password string `form:"password"`
}router.POST("/form", func(c *gin.Context) {var form LoginFormif err := c.Bind(&form); err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})return}c.JSON(http.StatusOK, gin.H{"username": form.Username, "password": form.Password})
})

3. 绑定 Query 参数

可以使用 Query 方法将请求中的 Query 参数绑定到结构体中。

type Pagination struct {Page  int `form:"page"`Limit int `form:"limit"`
}router.GET("/query", func(c *gin.Context) {var pagination Paginationif err := c.BindQuery(&pagination); err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})return}c.JSON(http.StatusOK, gin.H{"page": pagination.Page, "limit": pagination.Limit})
})

请求重定向

在 Gin 框架中，可以使用 Redirect 方法进行请求重定向。重定向是指服务器返回一个特定的 HTTP 状态码和一个新的 URL，告诉客户端要重定向到该 URL。下面是在 Gin 框架中进行请求重定向的详细介绍：

1. 重定向到指定 URL

使用 Redirect 方法可以将请求重定向到指定的 URL。例如，将请求重定向到 https://www.example.com/new：

router.GET("/redirect", func(c *gin.Context) {c.Redirect(http.StatusFound, "https://www.example.com/new")
})

2. 重定向到命名路由

如果你在 Gin 路由中定义了命名路由，你可以使用命名路由来进行重定向。

首先，定义一个命名路由：

router.GET("/hello", func(c *gin.Context) {c.String(http.StatusOK, "Hello, Gin!")
}).Name = "helloRoute"

然后，通过命名路由进行重定向：

router.GET("/redirect", func(c *gin.Context) {// 重定向到名为 "helloRoute" 的路由c.Redirect(http.StatusFound, router.GetRoute("helloRoute").Path)
})

3. 重定向到相对路径

可以将请求重定向到相对于当前路径的另一个路径。例如，将请求重定向到相对路径 /new：

router.GET("/redirect", func(c *gin.Context) {c.Redirect(http.StatusFound, "/new")
})

4. 重定向的状态码

在调用 Redirect 方法时，需要指定重定向的状态码。常用的状态码包括：

http.StatusMovedPermanently (301): 永久重定向，客户端应该使用新的 URL 重新发起请求。
http.StatusFound (302): 临时重定向，客户端应该使用新的 URL 重新发起请求。

中间件

在 Gin 框架中，中间件（Middleware）是一种特殊的函数，用于在请求到达处理器之前或之后执行一些预处理或后处理操作。Gin 框架的中间件设计非常灵活，可以用于实现诸如日志记录、身份验证、跨域请求处理等各种功能。下面详细介绍 Gin 框架中的中间件设计：

1. 中间件的基本概念

在 Gin 中，中间件是一个接收 gin.Context 对象作为参数的函数，它可以在处理器函数之前、之后或者两者之间执行一些操作。中间件函数可以调用 c.Next() 方法来将控制权传递给下一个中间件或者处理器函数。

2. 注册中间件

可以通过 Use 方法来注册一个全局中间件，该中间件会对所有的请求生效。

import "github.com/gin-gonic/gin"func main() {router := gin.Default()// 注册全局中间件router.Use(LoggerMiddleware)router.GET("/hello", func(c *gin.Context) {c.String(200, "Hello, Gin!")})router.Run(":8080")
}// 全局中间件函数
func LoggerMiddleware(c *gin.Context) {// 在处理器函数之前执行一些操作，例如记录请求日志fmt.Println("Request received:", c.Request.URL.Path)// 将控制权传递给下一个中间件或者处理器函数c.Next()// 在处理器函数之后执行一些操作fmt.Println("Request handled:", c.Request.URL.Path)
}

3. 在特定路由或路由组中使用中间件

除了注册全局中间件外，还可以在特定的路由或路由组中使用中间件。

func main() {router := gin.Default()// 在特定路由中使用中间件router.GET("/hello", AuthMiddleware, func(c *gin.Context) {c.String(200, "Hello, Gin!")})// 在路由组中使用中间件api := router.Group("/api")api.Use(AuthMiddleware){api.GET("/users", func(c *gin.Context) {c.String(200, "List of users")})}router.Run(":8080")
}// 中间件函数
func AuthMiddleware(c *gin.Context) {// 在这里进行身份验证等操作// 如果验证失败，可以调用 c.Abort() 终止请求处理流程
}

在上述示例中，AuthMiddleware 中间件被应用于 /hello 路由以及 /api 路由组中的所有路由。

4. 中间件链

可以通过多次调用 Use 方法来创建一个中间件链，每个中间件按照注册的顺序依次执行。

func main() {router := gin.Default()// 创建中间件链router.Use(Middleware1, Middleware2, Middleware3)router.GET("/hello", func(c *gin.Context) {c.String(200, "Hello, Gin!")})router.Run(":8080")
}

在这个示例中，Middleware1、Middleware2 和 Middleware3 将按照注册顺序依次执行。

5. 中间件的顺序

中间件的注册顺序很重要，它决定了中间件的执行顺序。一般情况下，应该将在处理器函数之前执行的操作放在中间件链的前面，而将在处理器函数之后执行的操作放在中间件链的后面。

文件上传

在 Gin 框架中，文件上传是一项常见的任务，通常用于处理用户上传的文件，例如图片、视频、文档等。Gin 框架提供了简单而强大的功能来处理文件上传，下面是 Gin 框架中文件上传的详细介绍：

1. 单个文件上传

单个文件上传是最常见的文件上传方式，可以通过 Gin 框架提供的 SaveUploadedFile 方法来处理单个文件的上传。

router.POST("/upload", func(c *gin.Context) {file, err := c.FormFile("file")if err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})return}// 保存文件到指定路径err = c.SaveUploadedFile(file, "uploads/"+file.Filename)if err != nil {c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})return}c.JSON(http.StatusOK, gin.H{"message": "File uploaded successfully"})
})

在这个示例中，我们通过 FormFile 方法从请求中获取上传的文件，然后使用 SaveUploadedFile 方法将文件保存到指定的路径。

2. 多个文件上传

Gin 框架也支持同时上传多个文件，可以通过 MultipartForm 方法来处理多个文件的上传。

router.POST("/upload", func(c *gin.Context) {// 解析多个表单字段err := c.Request.ParseMultipartForm(10 << 20) // 10 MBif err != nil {c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})return}// 获取所有上传的文件files := c.Request.MultipartForm.File["files"]for _, file := range files {// 保存文件到指定路径err := c.SaveUploadedFile(file, "uploads/"+file.Filename)if err != nil {c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})return}}c.JSON(http.StatusOK, gin.H{"message": "Files uploaded successfully"})
})

在这个示例中，我们通过 MultipartForm 方法解析多个表单字段，然后使用 Request.MultipartForm.File["files"] 获取所有上传的文件，并循环遍历保存到指定路径。

3. 限制文件大小

为了防止恶意上传或者占用过多服务器资源，可以在处理文件上传之前进行文件大小的限制。

router.POST("/upload", func(c *gin.Context) {file, err := c.FormFile("file")if err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})return}// 限制文件大小为 10 MBif file.Size > 10<<20 {c.JSON(http.StatusBadRequest, gin.H{"error": "File size exceeds 10 MB"})return}// 保存文件到指定路径err = c.SaveUploadedFile(file, "uploads/"+file.Filename)if err != nil {c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})return}c.JSON(http.StatusOK, gin.H{"message": "File uploaded successfully"})
})

在这个示例中，我们通过 file.Size 来获取文件的大小，并判断是否超过指定大小限制。

Gin框架简介

路由&路由组

1. 定义基本路由

2. 参数传递

3. 查询字符串参数

4. 路由组

5. 路由中间件

模板渲染

1. 加载模板

2. 定义模板

3. 渲染模板

4. 自定义模板函数

返回json

1. 导入 Gin 包

2. 创建 Gin 引擎

3. 定义路由和处理器函数

4. 运行服务器

获取参数

1.获取 QueryString 参数

2.获取 Form 参数

3.获取 URL 路径参数

参数绑定

1. 绑定 JSON 数据

2. 绑定 Form 表单数据

3. 绑定 Query 参数

请求重定向

1. 重定向到指定 URL

2. 重定向到命名路由

3. 重定向到相对路径

4. 重定向的状态码

中间件

1. 中间件的基本概念

2. 注册中间件

3. 在特定路由或路由组中使用中间件

4. 中间件链

5. 中间件的顺序

文件上传

1. 单个文件上传

2. 多个文件上传

3. 限制文件大小

相关文章：