「Go開源包」requests:一個比net/http包更簡潔、高效的開源包
大家好,這里是Go學堂。
今天給大家推薦一個高效的HTTP的請求包:carlmjohnson/requests。項目地址是:https://github.com/carlmjohnson/requests
該包誕生的背景
作者在自己的博客中描述了自己為什么寫這個request包。作者這樣描述go的net/http包:
Go的net/http包雖然功能強大、用途也廣泛,但要想正確地使用請求的客戶端是非常繁瑣的。
我們看下go的net/http包在發送一個web請求時有哪些繁瑣的地方。以下是使用標準的net/http包發送請求的一個示例:
func GetFoo() (*T, error) {
res, err := http.Get("http://foo/t.json")
if err != nil {
return nil, err
}
t := new(T)
if err := json.NewDecoder(res.Body).Decode(t); err != nil {
return nil, err
}
return t, nil
}
這段代碼有如下問題:
- 沒有調用Response.Body.Close關閉連接
- 沒有檢查響應返回的狀態值
- 響應值是字節切片,沒有做對應的結構轉換
這會導致正確使用GetFoo函數應該看起來像下面這樣:
func GetFoo(ctx context.Context) (*T, error) {
req, err := http.NewRequest("GET", "http://foo/t.json", nil)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
res, err := http.DefaultClient.Do(req)
if err != nil {
return nil, err
}
defer res.Body.Close()
if res.StatusCode < 200 || res.StatusCode > 299 {
return nil, fmt.Errorf("bogus status: got %v", res.Status)
}
t := new(T)
if err := json.NewDecoder(res.Body).Decode(t); err != nil {
return nil, err
}
return t, nil
}
就是要增加對Context的支持、關閉Response.Body、檢查響應的返回值以及對響應值轉換成json(或其他格式)。
所以,作者才寫了自己的requests庫,目的是要讓http的請求不再繁瑣。
Requests包的使用
基于以上問題,requests包就誕生了。該包通過將發送請求時的所有必要信息都抽象成了Builder結構體,通過該結構體來構建、發送和處理HTTP的請求。并且還支持鏈式操作。
下面我們看一些具體的請求示例。
Get請求,響應結果解析成字符串
如下,是發送Get的請求。使用requests包發送Get請求只需要5行代碼,而原生的net/http包得需要11多行代碼。
Post請求
如下,是一個發送Post的請求。使用requests包只用了5行代碼,而原生的net/http包需要12多行代碼。
將Get請求的JSON結果轉換成結構體
如下,是Get請求的JSON響應結果解析成對應的結構體。使用requests包只用了7行代碼,而使用原生的net/http包需要使用18多行代碼。
發送Body是JSON的Post請求
將JSON請求體以POST方式發送的代碼也很簡潔,如下:
實現原理
該包實現的原理是利用了封裝的思想。將復雜的操作封裝到函數中,對外暴露接口供使用者調用。
在requests包中,最核心的是是一個Builder的結構。該結構體將請求的URL、請求的參數、http的客戶端以及響應結果處理函數都封裝在這里該結構體中。如下:
- urlBuilder結構體的功能是構造請求的URL
- requestBuilder結構體的功能是構造請求頭、cookie、請求方法等信息
- http.Client是http請求的客戶端
- ResponseHandler結構體的功能是處理請求的響應值。
下圖是ResjponseHandler結構體處理響應值的函數實現。能處理成JSON、文件、HTML等多種格式。
總結
requensts包利用“封裝”的思想,將復雜的處理操作封裝到函數中,一是避免調用者編寫重復的代碼,提高效率;二是能夠減少調用者出錯的概率。在實際研發中,我們也可以借鑒其思想,將常用的操作封裝起來,從而提高研發效率。