gin請求參數處理

本章介紹Gin框架獲取請求參數的方式

1.獲取Get 請求參數

Get請求url例子：/path?id=1234&name=Manu&value=111

獲取Get請求參數的經常使用函數：

• func (c *Context) Query(key string) string
• func (c *Context) DefaultQuery(key, defaultValue string) string
• func (c *Context) GetQuery(key string) (string, bool)

例子：

func Handler(c *gin.Context) {
    //獲取name參數, 經過Query獲取的參數值是String類型。
    name := c.Query("name")

        //獲取name參數, 跟Query函數的區別是，能夠經過第二個參數設置默認值。
        name := c.DefaultQuery("name", "sockstack")

    //獲取id參數, 經過GetQuery獲取的參數值也是String類型, 
    // 區別是GetQuery返回兩個參數，第一個是參數值，第二個參數是參數是否存在的bool值，能夠用來判斷參數是否存在。
    id, ok := c.GetQuery("id")
        if !ok {
       // 參數不存在
    }
}

提示：GetQuery函數，判斷參數是否存在的邏輯是，參數值爲空，參數也算存在，只有沒有提交參數，纔算參數不存在。

2.獲取Post請求參數

獲取Post請求參數的經常使用函數：

• func (c *Context) PostForm(key string) string
• func (c *Context) DefaultPostForm(key, defaultValue string) string
• func (c *Context) GetPostForm(key string) (string, bool)

例子：

func Handler(c *gin.Context) {
    //獲取name參數, 經過PostForm獲取的參數值是String類型。
    name := c.PostForm("name")

    // 跟PostForm的區別是能夠經過第二個參數設置參數默認值
    name := c.DefaultPostForm("name", "sockstack")

    //獲取id參數, 經過GetPostForm獲取的參數值也是String類型,
    // 區別是GetPostForm返回兩個參數，第一個是參數值，第二個參數是參數是否存在的bool值，能夠用來判斷參數是否存在。
    id, ok := c.GetPostForm("id")
    if !ok {
        // 參數不存在
    }
}

3.獲取URL路徑參數

獲取URL路徑參數，指的是獲取 /user/:id 這類型路由綁定的參數，這個例子綁定了一個參數id。

獲取url路徑參數經常使用函數：

• func (c *Context) Param(key string) string

例子：

r := gin.Default()
    
r.GET("/user/:id", func(c *gin.Context) {
    // 獲取url參數id
    id := c.Param("id")
})

4.將請求參數綁定到struct對象

前面獲取參數的方式都是一個個參數的讀取，比較麻煩，Gin框架支持將請求參數自動綁定到一個struct對象，這種方式支持Get/Post請求，也支持http請求body內容爲json/xml格式的參數。

例子：

下面例子是將請求參數綁定到User struct對象。

// User 結構體定義
type User struct {
  Name  string `json:"name" form:"name"`
  Email string `json:"email" form:"email"`
}

經過定義struct字段的標籤，定義請求參數和struct字段的關係。
下面對User的Name字段的標籤進行說明。

struct標籤說明：

標籤	說明
json:"name"	數據格式爲json格式，而且json字段名爲name
form:"name"	表單參數名爲name

提示：你能夠根據本身的須要選擇支持的數據類型，例如須要支持json數據格式，能夠這樣定義字段標籤: json:"name"

下面看下控制器代碼：

r.POST("/user/:id", func(c *gin.Context) {
   // 初始化user struct
   u := User{}
   // 經過ShouldBind函數，將請求參數綁定到struct對象， 處理json請求代碼是同樣的。
   // 若是是post請求則根據Content-Type判斷，接收的是json數據，仍是普通的http請求參數
   if c.ShouldBind(&u) == nil {
     // 綁定成功， 打印請求參數
     log.Println(u.Name)
     log.Println(u.Email)

    }
    // http 請求返回一個字符串 
    c.String(200, "Success")
})

ShouldBind有一系列函數，大體就是把前面的方式綁定到結構體的方式，如：ShouldBindUri()、ShouldBindQuery()等等，用法和ShouldBind相似，這裏就不展開介紹了

提示：若是你經過http請求body傳遞json格式的請求參數，而且經過post請求的方式提交參數，則須要將 Content-Type設置爲 application/json, 若是是xml格式的數據，則設置爲 application/xml

5.獲取請求頭信息

獲取請求頭的經常使用函數：

• func (c *Context) GetHeader(key string) string

例子：

func Handler(c *gin.Context) {
    //獲取請求頭Host的值
    host := c.GetHeader("Host")
    //控制檯輸出host的值
    fmt.Println(host)
}

6.獲取客戶IP

r := gin.Default()
    
r.GET("/ip", func(c *gin.Context) {
    // 獲取用戶IP
    ip := c.ClientIP()
})

出處 gin從入門到實踐更多精彩文章，請關注個人博客 SOCKSTACK，分享個人工做經驗。