[[429410]]

1介紹

GoRequest 是一個極簡的 HTTP 客戶端，作者靈感來源于 Node.js 庫 SuperAgent。相比 Golang 標(biāo)準(zhǔn)庫 net/http，GoRequest 使用起來更加簡單。GoRequest 官方的口號是 “像機槍一樣發(fā)送請求”。

GoRequest 包含以下功能：

• 支持 HTTP 請求方式：Get/Post/Put/Head/Delete/Patch/Options
• 支持設(shè)置 header 請求頭
• 支持使用 JSON 字符串作為請求參數(shù)
• 支持將多路請求的方式發(fā)送數(shù)據(jù)和文件
• 支持通過代理發(fā)送請求
• 支持為請求設(shè)置超時
• 支持 TLS 客戶端設(shè)置
• 支持設(shè)置重定向策略
• 支持為請求設(shè)置 cookie
• CookieJar - automatic in-memory cookiejar
• 支持請求頭設(shè)置基本身份認(rèn)證

安裝方式：

go get github.com/parnurzeal/gorequest 

2HTTP 請求方式

Golang 發(fā)送一個簡單的 Get 請求，使用 net/http 標(biāo)準(zhǔn)庫和使用 GoRequst 庫，兩種發(fā)送 Get 請求的方式都比較簡單。

示例代碼如下：

標(biāo)準(zhǔn)庫方式：

resp, err := http.Get("http://example.com/") 

GoRequest 庫方式：

request := gorequest.New() 
resp, body, errs := request.Get("http://example.com/").End() 

或(該 GoRequest 方式無法復(fù)用對象)

resp, body, errs := gorequest.New().Get("http://example.com/").End() 

閱讀上面這兩段代碼，我們可以發(fā)現(xiàn)，使用標(biāo)準(zhǔn)庫的方式發(fā)送 Get 請求，甚至比使用 GoRequest 庫的方式發(fā)送 Get 請求更加簡單。

但是，當(dāng)我們需求稍作修改，比如我們需要為 Get 請求，設(shè)置 header 頭和設(shè)置重定向策略。我們再來看一下分別使用標(biāo)準(zhǔn)庫和 GoRequest 庫兩種實現(xiàn)方式。

標(biāo)準(zhǔn)庫方式：

client := &http.Client{ 
  CheckRedirect: redirectPolicyFunc, 
} 
 
req, err := http.NewRequest("GET", "http://example.com", nil) 
 
req.Header.Add("If-None-Match", `W/"wyzzy"`) 
resp, err := client.Do(req) 

GoRequest 庫方式(其它 HTTP 請求方式與 Get 使用方式相同)：

request := gorequest.New() 
resp, body, errs := request.Get("http://example.com"). 
  RedirectPolicy(redirectPolicyFunc). 
  Set("If-None-Match", `W/"wyzzy"`). 
  End() 

閱讀上面兩段代碼，很容易發(fā)現(xiàn)使用 GoRequest 方式使實現(xiàn)更加簡單。使用標(biāo)準(zhǔn)庫方式，首先需要創(chuàng)建一個 Client，然后使用不同的命令設(shè)置 header 頭等操作，這僅僅是為了實現(xiàn)一個 HTTP 請求。而使用 GoRequest 方式，僅需鏈?zhǔn)秸{(diào)用兩個方法即可輕松實現(xiàn)。

3JSON 格式請求參數(shù)

在 Golang 語言中，如果使用標(biāo)準(zhǔn)庫 net/http 發(fā)送請求參數(shù)為 JSON 格式的 POST 請求，首先需要先將 map 或 struct 類型的數(shù)據(jù)，使用標(biāo)準(zhǔn)庫 encoding/json 的 Marshal 方法，將數(shù)據(jù)轉(zhuǎn)換為 JSON 格式的數(shù)據(jù)，并且設(shè)置 header 頭參數(shù) Content-Type 的值為 application/json，然后創(chuàng)建一個 Client，最終你的代碼變得越來越長，越來越難維護。

標(biāo)準(zhǔn)庫方式：

m := map[string]interface{}{ 
  "name": "backy", 
  "species": "dog", 
} 
mJson, _ := json.Marshal(m) 
contentReader := bytes.NewReader(mJson) 
req, _ := http.NewRequest("POST", "http://example.com", contentReader) 
req.Header.Set("Content-Type", "application/json") 
req.Header.Set("Notes","GoRequest is coming!") 
client := &http.Client{} 
resp, _ := client.Do(req) 

如果使用 GoRequest 庫發(fā)送請求參數(shù)為 JSON 格式的 POST 請求，因為它默認(rèn)支持 JSON 格式的請求參數(shù)，所以它只需要一行代碼就可以實現(xiàn)。

GoRequest 庫方式：

request := gorequest.New() 
resp, body, errs := request.Post("http://example.com"). 
  Set("Notes","gorequst is coming!"). 
  Send(`{"name":"backy", "species":"dog"}`). 
  End() 

4支持回調(diào)函數(shù) Callback

GoRequest 庫還支持回調(diào)函數(shù)，你可以根據(jù)自己的項目需求靈活使用它，回調(diào)函數(shù)示例代碼如下：

func printStatus(resp gorequest.Response, body string, errs []error){ 
  fmt.Println(resp.Status) 
} 
gorequest.New().Get("http://example.com").End(printStatus) 

5請求控制

在 Golang 項目開發(fā)中，有時我們可能需要對請求做一些額外控制，比如超時處理，重試請求 N 次，重定向處理等。GoRequest 庫都可以為我們提供簡單的實現(xiàn)方式。

超時處理：

request := gorequest.New().Timeout(2*time.Millisecond) 
resp, body, errs:= request.Get("http://example.com").End() 

需要注意的是，Timeout 是將 Dial 連接和 IO 讀寫的耗時總和，與時間參數(shù)作比較。

重試請求：

request := gorequest.New() 
resp, body, errs := request.Get("http://example.com/"). 
                    Retry(3, 5 * time.Second, http.StatusBadRequest, http.StatusInternalServerError). 
                    End() 

閱讀上面這段代碼，它的含義是當(dāng)服務(wù)器返回結(jié)果是 http.StatusBadRequest 或 http.StatusInternalServerError 時，會每隔 5 秒重試請求一次，共重試 3 次。

重定向處理：

request := gorequest.New() 
resp, body, errs := request.Get("http://example.com/"). 
                    RedirectPolicy(func(req Request, via []*Request) error { 
                      if req.URL.Scheme != "https" { 
                        return http.ErrUseLastResponse 
                      } 
                    }). 
                    End() 

閱讀上面這段代碼，它的含義是將 http 請求重定向為 https 請求。

6返回結(jié)果處理方式

讀者朋友們可能已經(jīng)發(fā)現(xiàn)，以上示例代碼都是以 End 結(jié)束，End 的含義是返回結(jié)果是字符串類型，如果我們希望返回結(jié)果是其他類型，比如字節(jié)類型和結(jié)構(gòu)體類型，可以將 End 分別替換為 EndBytes 和 EndStruct。

EndBytes 格式：

resp, bodyBytes, errs := gorequest.New().Get("http://example.com/").EndBytes() 

EndStruct 格式：

heyYou struct { 
  Hey string `json:"hey"` 
} 
 
var heyYou heyYou 
 
resp, _, errs := gorequest.New().Get("http://example.com/").EndStruct(&heyYou) 

7總結(jié)

本文我們介紹 Golang 語言的極簡 HTTP 客戶端 GoRequest 以及它的使用方法。它比標(biāo)準(zhǔn)庫 net/http 使用方式簡單，當(dāng)我們項目開發(fā)中需要使用 HTTP 方式調(diào)用接口時，強烈推薦使用 GoRequest 庫。

GoRequest 底層在大多數(shù)用例中是基于 http.Client 實現(xiàn)的，所以通過一次調(diào)用 gorequest.New() 得到的對象，應(yīng)盡可能多次使用。

GoRequest 除了上面介紹的 JSON 參數(shù)，它還支持 Struct 和 File，感興趣的讀者可以查閱官方文檔了解相關(guān)內(nèi)容。

本文轉(zhuǎn)載自微信公眾號「Golang語言開發(fā)?！梗梢酝ㄟ^以下二維碼關(guān)注。轉(zhuǎn)載本文請聯(lián)系Golang語言開發(fā)棧公眾號。