「Go開源包」requests:一個(gè)比net/http包更簡(jiǎn)潔、高效的開源包
大家好,這里是Go學(xué)堂。
今天給大家推薦一個(gè)高效的HTTP的請(qǐng)求包:carlmjohnson/requests。項(xiàng)目地址是:https://github.com/carlmjohnson/requests
該包誕生的背景
作者在自己的博客中描述了自己為什么寫這個(gè)request包。作者這樣描述go的net/http包:
Go的net/http包雖然功能強(qiáng)大、用途也廣泛,但要想正確地使用請(qǐng)求的客戶端是非常繁瑣的。
我們看下go的net/http包在發(fā)送一個(gè)web請(qǐng)求時(shí)有哪些繁瑣的地方。以下是使用標(biāo)準(zhǔn)的net/http包發(fā)送請(qǐng)求的一個(gè)示例:
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
}
這段代碼有如下問(wèn)題:
- 沒(méi)有調(diào)用Response.Body.Close關(guān)閉連接
- 沒(méi)有檢查響應(yīng)返回的狀態(tài)值
- 響應(yīng)值是字節(jié)切片,沒(méi)有做對(duì)應(yīng)的結(jié)構(gòu)轉(zhuǎn)換
這會(huì)導(dǎo)致正確使用GetFoo函數(shù)應(yīng)該看起來(lái)像下面這樣:
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
}
就是要增加對(duì)Context的支持、關(guān)閉Response.Body、檢查響應(yīng)的返回值以及對(duì)響應(yīng)值轉(zhuǎn)換成json(或其他格式)。
所以,作者才寫了自己的requests庫(kù),目的是要讓http的請(qǐng)求不再繁瑣。
Requests包的使用
基于以上問(wèn)題,requests包就誕生了。該包通過(guò)將發(fā)送請(qǐng)求時(shí)的所有必要信息都抽象成了Builder結(jié)構(gòu)體,通過(guò)該結(jié)構(gòu)體來(lái)構(gòu)建、發(fā)送和處理HTTP的請(qǐng)求。并且還支持鏈?zhǔn)讲僮鳌?/p>
下面我們看一些具體的請(qǐng)求示例。
Get請(qǐng)求,響應(yīng)結(jié)果解析成字符串
如下,是發(fā)送Get的請(qǐng)求。使用requests包發(fā)送Get請(qǐng)求只需要5行代碼,而原生的net/http包得需要11多行代碼。
Post請(qǐng)求
如下,是一個(gè)發(fā)送Post的請(qǐng)求。使用requests包只用了5行代碼,而原生的net/http包需要12多行代碼。
將Get請(qǐng)求的JSON結(jié)果轉(zhuǎn)換成結(jié)構(gòu)體
如下,是Get請(qǐng)求的JSON響應(yīng)結(jié)果解析成對(duì)應(yīng)的結(jié)構(gòu)體。使用requests包只用了7行代碼,而使用原生的net/http包需要使用18多行代碼。
發(fā)送Body是JSON的Post請(qǐng)求
將JSON請(qǐng)求體以POST方式發(fā)送的代碼也很簡(jiǎn)潔,如下:
實(shí)現(xiàn)原理
該包實(shí)現(xiàn)的原理是利用了封裝的思想。將復(fù)雜的操作封裝到函數(shù)中,對(duì)外暴露接口供使用者調(diào)用。
在requests包中,最核心的是是一個(gè)Builder的結(jié)構(gòu)。該結(jié)構(gòu)體將請(qǐng)求的URL、請(qǐng)求的參數(shù)、http的客戶端以及響應(yīng)結(jié)果處理函數(shù)都封裝在這里該結(jié)構(gòu)體中。如下:
- urlBuilder結(jié)構(gòu)體的功能是構(gòu)造請(qǐng)求的URL
- requestBuilder結(jié)構(gòu)體的功能是構(gòu)造請(qǐng)求頭、cookie、請(qǐng)求方法等信息
- http.Client是http請(qǐng)求的客戶端
- ResponseHandler結(jié)構(gòu)體的功能是處理請(qǐng)求的響應(yīng)值。
下圖是ResjponseHandler結(jié)構(gòu)體處理響應(yīng)值的函數(shù)實(shí)現(xiàn)。能處理成JSON、文件、HTML等多種格式。
總結(jié)
requensts包利用“封裝”的思想,將復(fù)雜的處理操作封裝到函數(shù)中,一是避免調(diào)用者編寫重復(fù)的代碼,提高效率;二是能夠減少調(diào)用者出錯(cuò)的概率。在實(shí)際研發(fā)中,我們也可以借鑒其思想,將常用的操作封裝起來(lái),從而提高研發(fā)效率。