Golang?Gin框架獲取請求參數(shù)的幾種常見方式
傳遞參數(shù)的方式
在一個HTTP請求中，一般可以把上傳參數(shù)分為以下三個部分：
Header
Header是HTTP請求中一個鍵值對集合，HTTP規(guī)范定義了很多的Headeer，比如Content-Type，Accept等，不過也可以自定義請求頭部或者響應(yīng)頭部。
URL
URL指的是請求路徑，在請求路徑上可以通過兩種方式攜帶請求參數(shù)，一種是直接寫在請求路徑上的，稱為URL Path：
http://localhost:8080/user/add
在URL上傳遞參數(shù)的另外一種方式就是URL Query，URL Query參數(shù)是指跟在?后面的鍵值對集合，多個參數(shù)之間以&分隔的：
http://localhost:8080/user/add?name=小明&gender=男
HTTP Body
HTTP Body參數(shù)是指HTTP請求的請求體所攜帶的參數(shù)，這部分參數(shù)會因為Content-Type不同而不同，比如當(dāng)Content-Type為application/json時，HTTO Body攜帶的是一串JSON字符串。
那么，在Gin框架中，要如何獲取這些請求參數(shù)呢？主要有以下兩種方式：
- 直接用Gin封裝的方法獲取請求參數(shù)
- 通過綁定的方式來獲取請求參數(shù)
直接獲取請求參數(shù)
Gin框架在net/http包的基礎(chǔ)上封裝了獲取參數(shù)的方式。
獲取URL Path中的參數(shù)
在路由中使用通配符時，對應(yīng)的通配符就會成為URL Path參數(shù)，調(diào)用gin.Context的Param()方法可以獲取Path參數(shù)：
package main
?
func main(){
engine := gin.Default()
engine.GET("/user/:id", func(ctx *gin.Context) {
id := ctx.Param("id")
fmt.Fprintf(ctx.Writer, "你的請求id:%s", id)
})
engine.Run()
}運行后發(fā)起請求：
$ curl http://localhost:8080/user/100 你的請求id:100
獲取URL Query中的參數(shù)
gin.Context對象提供了以下幾個主要方法用于獲取Query參數(shù)：
package main
?
import (
"fmt"
?
"github.com/gin-gonic/gin"
)
?
func main() {
engine := gin.New()
engine.GET("/user/list", func(ctx *gin.Context) {
//獲取單個值
name := ctx.Query("name")
//帶默認(rèn)值
gender := ctx.DefaultQuery("gender", "男")
//數(shù)組
habits := ctx.QueryArray("habits")
//map
works := ctx.QueryMap("works")
fmt.Printf("%s,%s,%s,%s\n", name, gender, habits, works)
})
?
engine.Run()
}行后發(fā)起請求：
curl -X GET "http://localhost:8080/user/list?name=John&gender=男&habits[]=reading&habits[]=sports&works[teacher]=math&works[engineer]=computer" John,男,[reading sports],map[engineer:computer teacher:math]
獲取HTTP Body中的參數(shù)
對于通過HTTP Body傳上來的參數(shù)，gin.Context也提供了幾種主要方法用于獲取：
package main
?
import (
"fmt"
?
"github.com/gin-gonic/gin"
)
?
func main() {
engine := gin.New()
engine.POST("/user/add", func(ctx *gin.Context) {
//獲取單個值
name := ctx.PostForm("name")
//帶默認(rèn)值
gender := ctx.DefaultPostForm("gender", "男")
//數(shù)組
habits := ctx.PostFormArray("habits")
//map
works := ctx.PostFormMap("works")
fmt.Printf("%s,%s,%s,%s\n", name, gender, habits, works)
})
?
engine.Run()
}綁定請求參數(shù)
Gin支持綁定Header，URL Path，URL Query以及HTTP Body等不同位置數(shù)據(jù)。
綁定Header參數(shù)
綁定Header參數(shù)可以使用BindHeader()或者ShouldBindHeader()方法：
package main
?
import (
"fmt"
"net/http"
?
"github.com/gin-gonic/gin"
)
?
type testHeader struct {
Rate int `header:"Rate"`
Domain string `header:"Domain"`
}
?
func main() {
r := gin.Default()
r.GET("/", func(c *gin.Context) {
h := testHeader{}
?
if err := c.ShouldBindHeader(&h); err != nil {
c.JSON(http.StatusBadRequest, err)
return
}
?
fmt.Printf("%#v\n", h)
c.JSON(http.StatusOK, gin.H{"Rate": h.Rate, "Domain": h.Domain})
})
?
r.Run()
}運行后的請求結(jié)果：
$ curl -H "rate:300" -H "test:123" http://localhost:8080/
{"Test":"123","Rate":300}綁定URL Path參數(shù)
綁定URL Path參數(shù)可以使用BindUri()或者ShouldBindUri()方法：
package main
import (
"fmt"
"net/http"
"github.com/gin-gonic/gin"
)
type User struct {
Name string `uri:"name"`
Email string `uri:"email"`
}
func main() {
engine := gin.New()
engine.GET("/user/list/:email/:name", func(ctx *gin.Context) {
var u User
if err := ctx.BindUri(&u);err != nil {
ctx.JSON(http.StatusBadRequest, err)
return
}
fmt.Fprintf(ctx.Writer, "你輸入的用戶名為：%s,郵箱為：%s\n", u.Name, u.Email)
})
engine.Run()
}運行后的請求結(jié)果：
curl -X GET "http://localhost:8080/user/list/john@163.com/john 你輸入的用戶名為：john,郵箱為：john@163.com
綁定URL Query參數(shù)
綁定URL Query參數(shù)可以使用BindQuery()、ShouldBindQury()、Bind()或者ShouldBind()方法：
package main
import (
"fmt"
"net/http"
"github.com/gin-gonic/gin"
)
type User struct {
Name string `form:"name"`
Email string `form:"email"`
}
func main() {
engine := gin.New()
engine.GET("/user/list", func(ctx *gin.Context) {
var u User
if err := ctx.BindQuery(&u);err != nil {
ctx.JSON(http.StatusBadRequest, err)
return
}
fmt.Fprintf(ctx.Writer, "你輸入的用戶名為：%s,郵箱為：%s\n", u.Name, u.Email)
})
engine.Run()
}運行后的請求結(jié)果：
curl -X GET "http://localhost:8080/user/list?email=john@163.com&name=john 你輸入的用戶名為：john,郵箱為：john@163.com
綁定HTTP Body參數(shù)
我們知道HTTP Body的參數(shù)會根據(jù)不同Content-Type傳不同格式的數(shù)據(jù)，Gin支持以下幾種Content-Type類型的綁定：
- JSON
- XML
- TOML
- YAML
- x-www-form-urlencoded
- multipart/form-data
注意HTTP Body的數(shù)據(jù)只在POST請求時才會進(jìn)行綁定。
綁定HTTP Body參數(shù)可以用Bind()和ShouldBind()方法，這兩個方法會根據(jù)當(dāng)前請求的Content-Type類型自動判斷請求的類型。
package main
import (
"fmt"
"net/http"
"github.com/gin-gonic/gin"
)
type User struct {
Name string
Email string
}
func main() {
engine := gin.New()
engine.POST("/user/add", func(ctx *gin.Context) {
var u User
if err := ctx.Bind(&u); err != nil {
ctx.JSON(http.StatusBadRequest, err.Error())
return
}
fmt.Fprintf(ctx.Writer, "你輸入的用戶名為：%s,郵箱為：%s\n", u.Name, u.Email)
})
engine.Run()
}如果明確請求數(shù)據(jù)的類型，也可以直接調(diào)用對應(yīng)類型綁定的方法，比如確定是JSON格式數(shù)據(jù)的話，可以調(diào)用BindJSON()或者ShouldBindJSON()：
package main
import (
"fmt"
"net/http"
"github.com/gin-gonic/gin"
)
type User struct {
Name string
Email string
}
func main() {
engine := gin.New()
engine.POST("/user/add", func(ctx *gin.Context) {
var u User
if err := ctx.BindJSON(&u); err != nil {
ctx.JSON(http.StatusBadRequest, err.Error())
return
}
fmt.Fprintf(ctx.Writer, "你輸入的用戶名為：%s,郵箱為：%s\n", u.Name, u.Email)
})
engine.Run()
}對于x-www-form-urlencoded和multipart/form-data，與Qurey參數(shù)一樣，結(jié)構(gòu)體需要添加form的tag：
package main
import (
"fmt"
"net/http"
"github.com/gin-gonic/gin"
)
type User struct {
Name string `form:"name"`
Email string `form:"email"`
}
func main() {
engine := gin.New()
engine.POST("/user/add", func(ctx *gin.Context) {
var u User
if err := ctx.Bind(&u); err != nil {
ctx.JSON(http.StatusBadRequest, err.Error())
return
}
fmt.Fprintf(ctx.Writer, "你輸入的用戶名為：%s,郵箱為：%s\n", u.Name, u.Email)
})
engine.Run()
}數(shù)據(jù)校驗
在數(shù)據(jù)綁定的時候，也可以進(jìn)行數(shù)據(jù)校驗，這里我們?yōu)閁ser結(jié)構(gòu)體的標(biāo)簽添加了required屬性，要求這個字段必須要有：
package main
import (
"fmt"
"net/http"
"github.com/gin-gonic/gin"
)
type User struct {
Name string `binding:"required"`
Email string `binding:"required"`
}
func main() {
engine := gin.New()
engine.POST("/user/add", func(ctx *gin.Context) {
var u User
if err := ctx.Bind(&u); err != nil {
ctx.JSON(http.StatusBadRequest, err.Error())
return
}
fmt.Fprintf(ctx.Writer, "你輸入的用戶名為：%s,郵箱為：%s\n", u.Name, u.Email)
})
engine.Run()
}兩種方式的對比
相較于直接獲取請求參數(shù)，請求數(shù)據(jù)綁定是一種更強大且優(yōu)雅的參數(shù)獲取方式，使用這種方式獲取參數(shù)有以下幾個好處：
- 直接將所有參數(shù)綁定到一個結(jié)構(gòu)體中，不需要手動一個個地獲取參數(shù)。
- 綁定后的參數(shù)會自動轉(zhuǎn)換為結(jié)構(gòu)體對應(yīng)字段的類型，不需要手動對每個參數(shù)進(jìn)行數(shù)據(jù)類型轉(zhuǎn)換。
- 在進(jìn)行數(shù)據(jù)綁定的同時還可以進(jìn)行數(shù)據(jù)校驗。
小結(jié)
直接獲取請求參數(shù)雖然沒有綁定參數(shù)那么強大，但對于簡單的請求來說，也是夠用的，因此，我們可以根據(jù)自己的需求，選擇對應(yīng)的方式來獲取請求參數(shù)。
以上就是Golang Gin框架獲取請求參數(shù)的幾種常見方式的詳細(xì)內(nèi)容，更多關(guān)于Golang Gin獲取請求參數(shù)的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
Go實現(xiàn)List、Set、Stack、Deque等數(shù)據(jù)結(jié)構(gòu)的操作方法
Go語言團隊的一個核心目標(biāo)是保持語言的簡單性,他們認(rèn)為,如果一個功能可以用簡單的組合來實現(xiàn),那就沒有必要把它放進(jìn)標(biāo)準(zhǔn)庫里,本文給大家介紹Go實現(xiàn)List、Set、Stack、Deque等數(shù)據(jù)結(jié)構(gòu)的操作方法,感興趣的朋友跟隨小編一起看看吧2024-12-12
遵循著“學(xué)一門語言最好的方式是使用它”的理念，想著用Go來實現(xiàn)些什么，剛好有一個比較讓我煩惱的問題，于是用Go解決一下，即使不在生產(chǎn)環(huán)境使用，也可以作為Go語言學(xué)習(xí)的一種方式。2021-05-05
本文主要介紹了golang中如何保證精度的方法，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-04-04
本文主要介紹了GO中Json解析的幾種方式,詳細(xì)的介紹了幾種方法,?文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2024-01-01
這篇文章主要介紹了Go語言掃描目錄并獲取相關(guān)信息的方法,實例分析了Go語言操作目錄及文件的技巧,需要的朋友可以參考下2015-03-03
Golang之casbin權(quán)限管理的實現(xiàn)
這篇文章主要介紹了Golang之casbin權(quán)限管理的實現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-10-10
Type關(guān)鍵字在Go語言中作用很重要,比如定義結(jié)構(gòu)體,接口,還可以自定義類型,定義類型別名等,具有一定的參考價值,感興趣的可以了解一下2023-11-11
這篇文章主要為大家介紹了golang組件swagger生成接口文檔實踐示例，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步早日升職加薪2022-04-04
select是Go中的一個控制結(jié)構(gòu),類似于switch語句,本文主要介紹了深入剖析Go語言中的Select語句,具有一定的參考價值,感興趣的可以了解一下2023-12-12
在安裝和使用Go時,必須要正確地配置環(huán)境變量,本文主要介紹了go env環(huán)境變量配置的使用,具有一定的參考價值,感興趣的可以了解一下2023-11-11