Go類型安全的HTTP請求示例詳解

第Go類型安全的HTTP請求示例詳解目錄前言Go原生寫法httpc實現(xiàn)更多能力

前言

對Gopher來說，雖然我們基本都是在寫代碼讓別人來請求，但是有時候，我們也需要去請求第三方提供的RESTful接口，這個時候，我們才能感受到前端同學(xué)拼接HTTP請求參數(shù)的痛苦。

比如，我們要發(fā)起類似這樣一個請求，看起來很簡單，實際寫起來還是比較繁瑣的。

POST/articles/5/updatedevice=iosHTTP/1.1

Host:go-zero.dev

Authorization:Bearerjwt-token

{"author":"kevin","body":"thisisnotimportant!","title":"mytitle","type":6}

Go原生寫法

這個API其實是蠻簡單的，我們直接上手就可以寫出來。

funcmain(){

varbufbytes.Buffer

encoder:=json.NewEncoder(buf)

params:=map[string]interface{}{

"title":"mytitle",

"body":"thisisnotimportant!",

"author":"kevin",

"type":6,

iferr:=encoder.Encode(params);err!=nil{

fmt.Fprintln(os.Stderr,err)

return

url:=fmt.Sprintf("http://localhost:3333/articles/%d/updatedevice=%s",5,"ios")

req,err:=http.NewRequest(http.MethodPost,url,buf)

iferr!=nil{

fmt.Fprintln(os.Stderr,err)

return

req.Header.Add("Authorization","Bearerjwt-token")

cli:=http.Client{}

resp,err:=cli.Do(req)

iferr!=nil{

fmt.Fprintln(os.Stderr,err)

return

io.Copy(os.Stdout,resp.Body)

我們跑了測試一下，發(fā)現(xiàn)沒有得到200OK，抓包看一下，請求如下。各位不要往下看，你能想到失敗的原因嗎？

POST/articles/5/updatedevice=iosHTTP/1.1

Host:go-zero.dev

User-Agent:Go-http-client/1.1

Content-Length:79

Authorization:Bearerjwt-token

Accept-Encoding:gzip

{"author":"kevin","body":"thisisnotimportant!","title":"mytitle","type":6}

具體失敗原因這里就不細(xì)講了，我們先來分析這段代碼?？梢钥吹狡渲袨榱似唇訁?shù)使用了map[string]interface{}，對于其中每個字段我們是不能校驗類型是否匹配的，只有發(fā)送出去了，收到了服務(wù)端的200OK，我們才能確認(rèn)傳對了。比如其中的type參數(shù)，這里是使用了int類型，我們可能順手寫成string類型，但是不請求我們還是很難發(fā)現(xiàn)這個參數(shù)寫錯了的。

那么讓我們看看go-zero里httpc包是怎么使用并保證類型安全的。

httpc實現(xiàn)

我們看看用httpc包來請求的代碼怎么寫。

consturl="http://go-zero.dev/articles/:id/update"

typeUpdateArticlestruct{

IDint`path:"id"`

Devicestring`form:"device,options=ios,android,web,desktop"`

Authorizationstring`header:"Authorization"`

Titlestring`json:"title"`

Bodystring`json:"body"`

Authorstring`json:"author"`

Typeint`json:"type"`

funcmain(){

data:=UpdateArticle{

ID:5,

Device:"ios",

Authorization:"Bearerjwt-token",

Title:"mytitle",

Body:"thisisnotimportant!",

Author:"kevin",

Type:6,

resp,err:=httpc.Do(context.Background(),http.MethodPost,url,data)

iferr!=nil{

fmt.Fprintln(os.Stderr,err)

return

io.Copy(os.Stdout,resp.Body)

寫完測試一下，結(jié)果正如預(yù)期：

POST/articles/5/updatedevice=iosHTTP/1.1

Host:go-zero.dev

User-Agent:Go-http-client/1.1

Content-Length:79

Content-Type:application/json;charset=utf-8

Authorization:Bearerjwt-token

Accept-Encoding:gzip

{"author":"kevin","body":"thisisnotimportant!","title":"mytitle","type":6}

你發(fā)現(xiàn)了沒有，跟前面的對比，其中多了Content-Type:application/json;charset=utf-8，而我們之前寫法里忘記設(shè)置Content-Type了。

而httpc的寫法只要定義好請求的類型，然后通過httpc.Do就可以做到類型安全，并且代碼非常精簡。支持了如我們代碼所示的path、form、header和json，可以非常方便且類型安全的發(fā)送HTTP請求。

更多能力

除了上面展示的簡單易用和類型安全以外，httpc包還有以下特點：

context的超時控制OpenTelemetry自動集成，服務(wù)端返回的trace-id,span-id都會自動被記錄到日志