【备忘录】Gin框架

Gin框架

        Gin是一个轻量级、高性能的Go语言Web框架，其设计灵感来源于Martini，但相较于Martini，其性能提升了约40倍。Gin基于HTTP路由构建，并提供了丰富的中间件支持，非常适合用于构建高并发、低延迟的Web应用程序。

1. Gin框架的核心特点

• 极简的API设计
  Gin提供了直观易用的API，可以快速上手开发Web应用程序。例如，以下代码展示了一个基本的HTTP服务器：

package main

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

func main() {
    r := gin.Default()
    r.GET("/ping", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "message": "pong",
        })
    })
    r.Run() // 默认监听 :8080
}

• 内置中间件
  Gin内置了丰富的中间件，如日志、恢复（防止程序崩溃）、跨域处理（CORS）等，同时支持用户自定义中间件以满足特定需求。

• 高性能路由
  Gin的路由采用基于前缀树的匹配方式，能够快速处理高并发请求。

• 丰富的开发工具
  支持数据绑定、JSON验证、参数校验等功能，大大提高了开发效率。

• 插件生态
  Gin社区提供了许多第三方插件和扩展，方便开发者集成数据库、缓存等功能。

2. 常用方法

2.1. Abort 和 AbortWithStatus

Abort 方法用于中止当前请求的处理流程。当调用该方法时，后续的中间件或路由处理函数将不会被执行。通常用于权限校验或错误处理。

Abort 示例：

func AuthMiddleware() gin.HandlerFunc {
    return func(c *gin.Context) {
        token := c.GetHeader("Authorization")
        if token == "" {
            c.JSON(401, gin.H{"error": "unauthorized"})
            c.Abort() // 中止请求处理
            return
        }
        // 继续执行其他逻辑
        c.Next()
    }
}

AbortWithStatus 结合了 Abort 和设置 HTTP 状态码的功能，示例：

func CheckAccess() gin.HandlerFunc {
    return func(c *gin.Context) {
        if !hasPermission(c) {
            c.AbortWithStatus(403) // 直接返回 403 状态码
        }
    }
}

2.2. Param 和 Query

用于获取 URL 中的参数和查询字符串的值。

路径参数通常用于表示唯一的资源标识符，比如用户 ID、产品编号等，Param 获取路径参数示例：

func GetUser(c *gin.Context) {
    userID := c.Param("id") // 获取路径中的 id 参数
    c.JSON(200, gin.H{"user_id": userID})
}
// 路由配置：GET /user/:id
r.GET("/user/:id", GetUser)

查询字符串参数位于 URL 的 ? 之后，通过键值对的形式传递数据，每对之间用 & 分隔，适用于过滤条件、分页信息、排序方式等动态数据。Query 获取查询字符串参数示例：

func Search(c *gin.Context) {
    keyword := c.Query("q") // 获取查询字符串中的 q 参数
    c.JSON(200, gin.H{"keyword": keyword})
}

// 访问示例：GET /search?q=gin

2.3. ShouldBind 和 BindJSON

用于将请求体中的数据绑定到结构体中。

ShouldBind 可以自动根据请求的 Content-Type（如 JSON、表单）解析并绑定数据，示例：

type LoginRequest struct {
    Username string `json:"username" binding:"required"`
    Password string `json:"password" binding:"required"`
}

func Login(c *gin.Context) {
    var req LoginRequest
    if err := c.ShouldBind(&req); err != nil {
        c.JSON(400, gin.H{"error": err.Error()})
        return
    }
    c.JSON(200, gin.H{"message": "login successful"})
}

BindJSON 则专门用于解析 JSON 数据，示例：

func CreatePost(c *gin.Context) {
    var post map[string]interface{}
    if err := c.BindJSON(&post); err != nil {
        c.JSON(400, gin.H{"error": err.Error()})
        return
    }
    c.JSON(200, post)
}

2.4. Next 和 Set/Get

Next通常用于在中间件中继续调用后续的处理函数：

func Logger() gin.HandlerFunc {
    return func(c *gin.Context) {
        start := time.Now()
        c.Next() // 执行下一个处理函数
        latency := time.Since(start)
        fmt.Printf("Request processed in %v\n", latency)
    }
}

Set 和 Get用于在请求上下文中存储和获取数据，其涉及的数据都被存储在Context对象的内存中，数据的生命周期与该HTTP请求相关，无法跨请求存储数据。

func Middleware() gin.HandlerFunc {
    return func(c *gin.Context) {
        c.Set("user", "Alice") // 设置数据
        c.Next()
    }
}

func GetUser(c *gin.Context) {
    user, exists := c.Get("user") // 获取数据
    if exists {
        c.JSON(200, gin.H{"user": user})
    }
}

2.5. Redirect

用于重定向请求。

func RedirectToGoogle(c *gin.Context) {
    c.Redirect(302, "https://www.google.com") // 302 临时重定向
}

2.6. JSON 和 String

JSON用于返回 JSON 格式响应：

func JSONResponse(c *gin.Context) {
    c.JSON(200, gin.H{"message": "Hello, Gin!"})
}

String用来返回纯文本响应：

func StringResponse(c *gin.Context) {
    c.String(200, "Hello, Gin!")
}

2.7. File 和 FileAttachment

用于返回文件内容。

调用File会直接返回文件。

func DownloadFile(c *gin.Context) {
    c.File("example.txt")
}

调用FileAttachment则会返回文件并指定下载时的文件名。

func DownloadAsAttachment(c *gin.Context) {
    c.FileAttachment("example.txt", "download.txt")
}

2.8. Status

用于仅设置 HTTP 状态码，而不返回任何内容。

func SetStatus(c *gin.Context) {
    c.Status(204) // 设置状态码为 204，无内容返回
}

原文地址：https://blog.csdn.net/qq_42638506/article/details/143837950

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！