快捷導(dǎo)航

Go類型安全的HTTP請(qǐng)求示例詳解

更新時(shí)間：2022年06月21日 10:22:21 作者：萬(wàn)俊峰Kevin

這篇文章主要為大家介紹了Go類型安全的HTTP請(qǐng)求示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

前言

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

比如，我們要發(fā)起類似這樣一個(gè)請(qǐng)求，看起來(lái)很簡(jiǎn)單，實(shí)際寫起來(lái)還是比較繁瑣的。

POST /articles/5/update?device=ios HTTP/1.1
Host: go-zero.dev
Authorization: Bearer <jwt-token>
{"author":"kevin","body":"this is not important!","title":"my title","type":6}

Go 原生寫法

這個(gè) API 其實(shí)是蠻簡(jiǎn)單的，我們直接上手就可以寫出來(lái)。

func main() {
    var buf bytes.Buffer
    encoder := json.NewEncoder(&buf)
    params := map[string]interface{}{
        "title":  "my title",
        "body":   "this is not important!",
        "author": "kevin",
        "type":   6,
    }
    if err := encoder.Encode(params); err != nil {
        fmt.Fprintln(os.Stderr, err)
        return
    }
    url := fmt.Sprintf("http://localhost:3333/articles/%d/update?device=%s", 5, "ios")
    req, err := http.NewRequest(http.MethodPost, url, &buf)
    if err != nil {
        fmt.Fprintln(os.Stderr, err)
        return
    }
    req.Header.Add("Authorization", "Bearer <jwt-token>")
    cli := http.Client{}
    resp, err := cli.Do(req)
    if err != nil {
        fmt.Fprintln(os.Stderr, err)
        return
    }
    io.Copy(os.Stdout, resp.Body)
}

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

POST /articles/5/update?device=ios HTTP/1.1
Host: go-zero.dev
User-Agent: Go-http-client/1.1
Content-Length: 79
Authorization: Bearer <jwt-token>
Accept-Encoding: gzip
{"author":"kevin","body":"this is not important!","title":"my title","type":6}

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

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

httpc 實(shí)現(xiàn)

我們看看用 httpc 包來(lái)請(qǐng)求的代碼怎么寫。

const url = "http://go-zero.dev/articles/:id/update"
type UpdateArticle struct {
    ID            int    `path:"id"`
    Device        string `form:"device,options=ios,android,web,desktop"`
    Authorization string `header:"Authorization"`
    Title         string `json:"title"`
    Body          string `json:"body"`
    Author        string `json:"author"`
    Type          int    `json:"type"`
}
func main() {
    data := &UpdateArticle{
        ID:            5,
        Device:        "ios",
        Authorization: "Bearer <jwt-token>",
        Title:         "my title",
        Body:          "this is not important!",
        Author:        "kevin",
        Type:          6,
    }
    resp, err := httpc.Do(context.Background(), http.MethodPost, url, data)
    if err != nil {
        fmt.Fprintln(os.Stderr, err)
        return
    }
    io.Copy(os.Stdout, resp.Body)
}

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

POST /articles/5/update?device=ios HTTP/1.1
Host: go-zero.dev
User-Agent: Go-http-client/1.1
Content-Length: 79
Content-Type: application/json; charset=utf-8
Authorization: Bearer <jwt-token>
Accept-Encoding: gzip
{"author":"kevin","body":"this is not important!","title":"my title","type":6}

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

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