快捷導(dǎo)航

Golang 關(guān)于Gin框架請求參數(shù)的獲取方法

更新時間：2024年10月21日 11:05:25 作者：景天科技苑

Gin是Go語言的Web框架,提供路由和中間件支持,本文介紹如何使用Gin獲取HTTP請求參數(shù),包括URLPath參數(shù)、URLQuery參數(shù)、HTTPBody參數(shù)和Header參數(shù),詳解直接獲取和綁定到結(jié)構(gòu)體兩種方法,幫助開發(fā)者高效處理Web請求

Gin框架請求參數(shù)的獲取

Gin是一個用Go語言編寫的Web框架，它提供了強大的路由和中間件功能，使得開發(fā)Web應(yīng)用變得更加簡單和高效。
在使用Gin框架開發(fā)Web應(yīng)用時，處理請求參數(shù)是一個非常重要的環(huán)節(jié)。本文將結(jié)合實際案例，詳細介紹在Go語言中如何使用Gin框架處理請求參數(shù)。

一、請求參數(shù)的類型和位置

在HTTP請求中，參數(shù)可以通過多種方式傳遞，常見的類型包括：

URL Path參數(shù)：參數(shù)直接寫在請求路徑中，例如/user/:id。
URL Query參數(shù)：參數(shù)跟在URL的?后面，以鍵值對的形式傳遞，多個參數(shù)之間用&分隔，例如/user/list?name=John&gender=男。
HTTP Body參數(shù)：參數(shù)在請求體中傳遞，通常用于POST、PUT等請求方法，內(nèi)容格式可以是JSON、XML等。
Header參數(shù)：參數(shù)在HTTP請求頭中傳遞，例如Content-Type、Accept等。

二、獲取請求參數(shù)的方法

Gin框架提供了多種方法來獲取請求參數(shù)，包括直接獲取和綁定到結(jié)構(gòu)體中兩種方式。

1. 直接獲取請求參數(shù)

（1）獲取URL Path參數(shù)

URL Path參數(shù)是指直接寫在請求路徑中的參數(shù)，可以通過Gin框架的Param方法獲取。
后臺獲取路徑請求參數(shù)通過ctx.Param(“參數(shù)名”) 來獲取

示例代碼：

package main
import (
    "github.com/gin-gonic/gin"
    "net/http"
)
func main() {
    engine := gin.Default()
    //請求參數(shù) 用:變量名 表示
    engine.GET("/user/:id", func(ctx *gin.Context) {
        //后臺獲取請求參數(shù)通過ctx.Param("參數(shù)名") 來獲取
        id := ctx.Param("id")
        //響應(yīng)到頁面
        //fmt.Fprintf(ctx.Writer, "你的請求id: %s", id)
        ctx.String(http.StatusOK, "您的id是%s", id)
    })
    engine.Run()
}

運行后，發(fā)起請求http://localhost:8080/user/100，會返回你的請求id: 100。

（2）獲取URL Query參數(shù)

URL Query參數(shù)是指跟在URL的?后面的鍵值對集合，可以通過Gin框架的Query、DefaultQuery、QueryArray、QueryMap等方法獲取。

示例代碼：

package main
import (
    "fmt"
    "github.com/gin-gonic/gin"
    "net/http"
)
func main() {
    engine := gin.Default()
    engine.GET("/user/list", func(ctx *gin.Context) {
        name := ctx.Query("name")
        gender := ctx.DefaultQuery("gender", "男")
        habits := ctx.QueryArray("habits")
        fmt.Printf("name: %s, gender: %s, habits: %v\n", name, gender, habits)
        works := ctx.QueryMap("works")
        //響應(yīng)到頁面
        ctx.String(http.StatusOK, "%s, %s, %v, %s\n", name, gender, habits, works)
    })
    engine.Run(":8080")
}

運行后，瀏覽器發(fā)起請求
http://127.0.0.1:8080/user/list?name=John&gender=男&habits=reading&habits=sports&works[teacher]=math&works[engineer]=computer
會返回 John, 男, [reading sports], map[engineer:computer teacher:math]

（3）獲取HTTP Body參數(shù)

HTTP Body參數(shù)是指請求體中的參數(shù)，通常用于POST、PUT等請求方法?？梢酝ㄟ^Gin框架的PostForm、DefaultPostForm、PostFormArray、PostFormMap等方法獲取。

示例代碼：

package main
import (
    "fmt"
    "github.com/gin-gonic/gin"
)
func main() {
    engine := gin.Default()
    //使用post請求
    engine.POST("/user/add", func(ctx *gin.Context) {
        name := ctx.PostForm("name")
        gender := ctx.DefaultPostForm("gender", "男")
        //獲取切片數(shù)據(jù)
        habits := ctx.PostFormArray("habits")
        //獲取map數(shù)據(jù)
        works := ctx.PostFormMap("works")
        fmt.Printf("%s, %s, %v, %s\n", name, gender, habits, works)
    })
    engine.Run()
}

postman發(fā)請求

（4）獲取Header參數(shù)

Header參數(shù)是指HTTP請求頭中的參數(shù)，可以通過Gin框架的GetHeader方法獲取。

示例代碼：

package main
import (
    "github.com/gin-gonic/gin"
    "net/http"
)
func main() {
    engine := gin.Default()
    engine.POST("/getHeader", func(ctx *gin.Context) {
        //拿到請求頭參數(shù)數(shù)據(jù)
        userAgent := ctx.GetHeader("User-Agent")
        ctx.String(http.StatusOK, "User-Agent: %s", userAgent)
    })
    engine.Run()
}

2. 綁定請求參數(shù)到結(jié)構(gòu)體

Gin框架支持將請求參數(shù)自動綁定到結(jié)構(gòu)體中，這樣可以更方便地進行參數(shù)驗證和處理。綁定參數(shù)的方法包括Bind、ShouldBind、BindJSON、BindQuery等。

（1）綁定URL Query參數(shù)到結(jié)構(gòu)體

示例代碼：

package main
import (
    "github.com/gin-gonic/gin"
    "net/http"
)
// User 定義結(jié)構(gòu)體，使用form標簽指定參數(shù)名，以便正確地綁定參數(shù) get請求使用功能form標簽
type User struct {
    Id    int64  `form:"id"`
    Name  string `form:"name"`
    Age   int    `form:"age"`
    Email string `form:"email"`
}
func main() {
    engine := gin.Default()
    engine.GET("/user/info", func(ctx *gin.Context) {
        var user User
        //將結(jié)構(gòu)體對象指針傳進去
        if err := ctx.ShouldBindQuery(&user); err != nil {
            ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
            return
        }
        //以json字符串的方式響應(yīng)給客戶端這個結(jié)構(gòu)體對象
        ctx.JSON(http.StatusOK, user)
    })
    engine.Run()
}

（2）綁定HTTP Body參數(shù)到結(jié)構(gòu)體（JSON格式）

當前端請求的數(shù)據(jù)通過JSON提交時，例如向/json發(fā)送一個POST請求

示例代碼：

package main
import (
    "github.com/gin-gonic/gin"
    "net/http"
)
// User 綁定HTTP Body參數(shù)到結(jié)構(gòu)體 ，創(chuàng)建結(jié)構(gòu)體時需要用json標簽
type User struct {
    Id    int64  `json:"id"`
    Name  string `json:"name"`
    Age   int    `json:"age"`
    Email string `json:"email"`
}
func main() {
    engine := gin.Default()
    engine.POST("/user/add", func(ctx *gin.Context) {
        var user User
        // ctx.ShouldBindJSON(&user) 將結(jié)構(gòu)體指針傳進去
        if err := ctx.ShouldBindJSON(&user); err != nil {
            ctx.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
            return
        }
        //響應(yīng)給客戶端結(jié)構(gòu)體
        ctx.JSON(http.StatusOK, user)
    })
    engine.Run()
}

也可以直接獲取原生json數(shù)據(jù)處理

package main
import (
    "encoding/json"
    "github.com/gin-gonic/gin"
    "net/http"
)
func main() {
    engine := gin.Default()
    engine.POST("/json", func(ctx *gin.Context) {
        // GetRawData : 從c.Request.Body讀取請求數(shù)據(jù), 返回 []byte
        // func (c *Context) GetRawData() ([]byte, error)
        b, _ := ctx.GetRawData()
        // 定義map或結(jié)構(gòu)體接收
        var m map[string]interface{}
        // 將接收的b json反序列化為map數(shù)據(jù)
        _ = json.Unmarshal(b, &m)
        ctx.JSON(http.StatusOK, m)
    })
    engine.Run()
}