「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
}

這段代碼有如下問題：

這會導致正確使用 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 的客戶端以及響應結果處理函數都封裝在這裏該結構體中。如下：

下圖是 ResjponseHandler 結構體處理響應值的函數實現。能處理成 JSON、文件、HTML 等多種格式。

總結

requensts 包利用 “封裝” 的思想，將複雜的處理操作封裝到函數中，一是避免調用者編寫重複的代碼，提高效率；二是能夠減少調用者出錯的概率。在實際研發中，我們也可以借鑑其思想，將常用的操作封裝起來，從而提高研發效率。

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/8XOK3FFnaZWh5trca8B8yw

猜你喜歡