Go常用框架 - Gin Web框架详解

介绍

Gin是一个用Go语言编写的Web框架。它是一个轻量级框架，但功能强大，性能优异，特别适合构建API服务。Gin的特点是速度快、内存占用小，并且提供了很多实用的功能，如路由、中间件、错误管理等。本文将详细介绍Gin框架的使用方法和常见应用场景。

Gin 官方文档地址

安装

使用Gin非常简单，只需要使用go get命令安装即可：

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

基本使用

下面是一个使用Gin创建简单Web服务的例子：

package main

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

func main() {
    // 创建一个默认的路由引擎
    r := gin.Default()
    
    // GET请求
    r.GET("/ping", func(c *gin.Context) {
        c.JSON(http.StatusOK, gin.H{
            "message": "pong",
        })
    })
    
    // 启动服务
    r.Run(":8080") // 监听并在0.0.0.0:8080上启动服务
}

上面的代码中，我们首先创建了一个默认的Gin路由引擎，然后定义了一个GET路由，最后启动了服务器。当访问/ping路径时，服务器会返回一个JSON响应，内容为{"message": "pong"}。

路由

Gin提供了丰富的路由功能，支持GET、POST、PUT、DELETE等常见的HTTP方法。下面是一些常见的路由示例：

基本路由

r.GET("/someGet", getting)
r.POST("/somePost", posting)
r.PUT("/somePut", putting)
r.DELETE("/someDelete", deleting)
r.PATCH("/somePatch", patching)
r.HEAD("/someHead", head)
r.OPTIONS("/someOptions", options)

路由参数

// 路径参数
r.GET("/user/:name", func(c *gin.Context) {
    name := c.Param("name")
    c.String(http.StatusOK, "Hello %s", name)
})

// 查询参数
r.GET("/welcome", func(c *gin.Context) {
    firstname := c.DefaultQuery("firstname", "Guest")
    lastname := c.Query("lastname") // 等价于 c.Request.URL.Query().Get("lastname")
    
    c.String(http.StatusOK, "Hello %s %s", firstname, lastname)
})

路由组

// 简单的路由组: v1
v1 := r.Group("/v1")
{
    v1.POST("/login", loginEndpoint)
    v1.POST("/submit", submitEndpoint)
    v1.POST("/read", readEndpoint)
}

// 简单的路由组: v2
v2 := r.Group("/v2")
{
    v2.POST("/login", loginEndpoint)
    v2.POST("/submit", submitEndpoint)
    v2.POST("/read", readEndpoint)
}

请求和响应

Gin提供了丰富的请求和响应处理功能，下面是一些常见的示例：

请求参数获取

// 获取POST表单数据
r.POST("/form_post", func(c *gin.Context) {
    message := c.PostForm("message")
    nick := c.DefaultPostForm("nick", "anonymous")
    
    c.JSON(http.StatusOK, gin.H{
        "status":  "posted",
        "message": message,
        "nick":    nick,
    })
})

// 获取上传的文件
r.POST("/upload", func(c *gin.Context) {
    file, _ := c.FormFile("file")
    
    // 上传文件到指定的路径
    c.SaveUploadedFile(file, dst)
    
    c.String(http.StatusOK, fmt.Sprintf("'%s' uploaded!", file.Filename))
})

响应数据格式

// JSON响应
r.GET("/someJSON", func(c *gin.Context) {
    c.JSON(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK})
})

// 结构体响应
r.GET("/someStruct", func(c *gin.Context) {
    var msg struct {
        Name    string `json:"user"`
        Message string
        Number  int
    }
    msg.Name = "Lena"
    msg.Message = "hey"
    msg.Number = 123
    
    c.JSON(http.StatusOK, msg)
})

// XML响应
r.GET("/someXML", func(c *gin.Context) {
    c.XML(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK})
})

// YAML响应
r.GET("/someYAML", func(c *gin.Context) {
    c.YAML(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK})
})

中间件

Gin的中间件功能非常强大，可以用于日志记录、错误处理、认证等场景。下面是一些常见的中间件示例：

全局中间件

r := gin.New()

// 全局中间件
r.Use(gin.Logger())
r.Use(gin.Recovery())

// 路由
r.GET("/", func(c *gin.Context) {
    c.String(http.StatusOK, "Hello World")
})

自定义中间件

func Logger() gin.HandlerFunc {
    return func(c *gin.Context) {
        t := time.Now()
        
        // 设置变量
        c.Set("example", "12345")
        
        // 请求前
        
        c.Next()
        
        // 请求后
        latency := time.Since(t)
        log.Print(latency)
        
        // 获取发送的状态
        status := c.Writer.Status()
        log.Println(status)
    }
}

func main() {
    r := gin.New()
    r.Use(Logger())
    
    r.GET("/test", func(c *gin.Context) {
        example := c.MustGet("example").(string)
        
        // 打印："12345"
        log.Println(example)
    })
    
    r.Run(":8080")
}