Golang的一個簡單實用的http客戶端庫httpc

httpc簡介

httpc這是一個發起http請求的客戶端庫。
它具有的特色包括：簡單易用、易于擴展、支持鏈式調用、支持多種格式的處理等。
特別適合用來調用restfull風格的接口。

項目地址

https://github.com/recallsong/httpc

下載

go get github.com/recallsong/httpc

Api文檔

查看 在線Api文檔

我們也可以利用godoc工具在本地查看api文檔：

godoc -http=:9090

在瀏覽器中查看地址：

http://localhost:9090/pkg/github.com/recallsong/httpc

快速入門

最簡單的使用方式

var resp string
// GET http://localhost/hello?name=RecallSong
err := httpc.New("http://localhost").Path("hello").Query("name", "RecallSong").Get(&resp)
if err != nil {
    fmt.Println(resp) // 以字符串方式獲取響應的數據
} else {
    fmt.Println(err)
}

設置請求頭和Cookie等

var resp string
err := httpc.New("http://localhost").Path("/hello").Query("param", "value").
    Header("MyHeader", "HeaderValue").
    AddCookie(&http.Cookie{Name: "cookieName", Value: "cookieValue"}).
    Body("body data").Post(&resp)
if err != nil {
    fmt.Println(resp) // 以字符串方式獲取響應的數據
} else {
    fmt.Println(err)
}

發送和接收json格式的數據

使用map傳遞數據

body := map[string]interface{}{
    "name": "RecallSong",
    "age":  18,
}
var resp map[string]interface{}
// 根據請求的Content-Type自動對數據進行轉換
err := httpc.New("http://localhost").Path("json").
    ContentType(httpc.TypeApplicationJson).
    Body(body). // body轉變為 {"name":"RecallSong","age":18}
    Post(&resp) // 根據響應中的Content-Type，將返回的數據解析到resp中
fmt.Println(err, resp)

// 如果請求或響應沒有指定Content-Type，或是不正確，也可以強制指定轉換格式類型
err = httpc.New("http://localhost").Path("json").
    Body(body, httpc.TypeApplicationJson). // body轉變為 {"name":"RecallSong","age":18}
    Post(&resp, httpc.TypeApplicationJson) // 將返回的數據按json格式解析到map中
fmt.Println(err, resp)

使用struct傳遞數據

type Person struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
}
body := Person{Name: "RecallSong", Age: 18}
var resp Person
err := httpc.New("http://localhost").Path("json").
    Body(body, httpc.TypeApplicationJson).
    Post(&resp, httpc.TypeApplicationJson)
fmt.Println(err, resp)

發送和接收xml格式的數據

type Person struct {
    Name string `xml:"name"`
    Age  int    `xml:"age"`
}
body := Person{Name: "RecallSong", Age: 18}
var resp Person
err := httpc.New("http://localhost").Path("xml").
    Body(body, httpc.TypeApplicationXml). // 數據轉變為xml格式
    Post(&resp, httpc.TypeApplicationXml)
fmt.Println(err, resp)

發送表單參數

使用結構體發送

sbody := struct {
    Name string `form:"name"`
    Age  int    `form:"age"`
}{
    Name: "RecallSong",
    Age:  18,
}
var resp string
err := httpc.New("http://localhost").Path("echo").
    Body(sbody, httpc.TypeApplicationForm). // 將結構體轉變為form格式的數據體
    Post(&resp)
fmt.Println(err, resp)

使用map發送

mbody := map[string]interface{}{
    "name": "RecallSong",
    "age":  19,
}
var resp string
err := httpc.New("http://localhost").Path("echo").
    Body(mbody, httpc.TypeApplicationForm). // 將map變為form格式的數據體
    Post(&resp)
fmt.Println(err, resp)

使用url.Values發送

ubody := url.Values{}
ubody.Set("name", "RecallSong")
ubody.Set("age", "20")
var resp string
err := httpc.New("http://localhost").Path("echo").
    Body(ubody). // 將url.Values類型轉變form格式的數據體
    Post(&resp)
fmt.Println(err, resp)

自動編碼url路徑參數

var resp string
// 可以自動編碼url路徑參數
err := httpc.New("http://localhost").EscapedPath("recall/Song").EscapedPath(18).Get(&resp)
// 請求地址為 http://localhost/recall%2FSong/18
fmt.Println(err, resp)

上傳文件

方式1

file, err := os.Open("doc.go")
if err != nil {
  fmt.Println(err)
  return
}
defer file.Close()
body := map[string]interface{}{
    "file":  file,
    "name":  "RecallSong",
    "age":   18,
    "file2": httpc.FilePath("doc.go:hello.go"), //上傳doc.go文件，參數名為file2，文件名為hello.go
}
var resp string
err = httpc.New("http://localhost").Path("echo").
    Body(body, httpc.TypeMultipartFormData).Post(&resp)
fmt.Println(err)

方式2

file, err := os.Open("doc.go")
if err != nil {
    fmt.Println(err)
    return
}
defer file.Close()
body := struct {
    Name    string         `form:"name"`
    Address []string       `form:"address"`
    Age     int            `form:"age"`
    File    *os.File       `form:"file" file:"hello.go"`
    File2   httpc.FilePath `form:"file2"`
}{
    Name:    "RecallSong",
    Address: []string{"HangZhou", "WenZhou"},
    Age:     18,
    File:    file,
    File2:   httpc.FilePath("doc.go:hello2.go"), //上傳doc.go文件，參數名為file2，文件名為hello2.go
}
var resp string
err = httpc.New("http://localhost").Path("echo").
    Body(body, httpc.TypeMultipartFormData).Post(&resp)
fmt.Println(err)

接收響應數據

// 前面的例子我們知道了可以接收json和xml格式的數據，也可以接收數據到一個string變量中
// 除此之外，我們還可以有一下幾種方式接收數據

// []byte 方式接收
var bytesResp []byte
err := httpc.New("http://localhost").Path("hello").Get(&bytesResp)
fmt.Println(err, bytesResp)

// *http.Response 方式接收
var resp *http.Response
err := httpc.New("http://localhost").Path("hello").Get(&resp)
if err != nil {
  fmt.Println(err)
} else {
  // 注意這種方式要關閉Body
  defer resp.Body.Close()
  body, err := ioutil.ReadAll(resp.Body)
  fmt.Println(err, string(body))
}

下載文件

方式1

// 默認方式保存文件
err := httpc.New("http://localhost").Path("echo").Body("content").Post(httpc.FilePath("download1.txt"))
fmt.Println(err)

方式2

err := httpc.New("http://localhost").Path("echo").Body("content").Post(&httpc.SaveInfo{
    Path:     "download2.txt",
    Override: true,
    Mode:     0777})
fmt.Println(err)

指定成功的http狀態碼

// 如果返回的狀態碼與指定的狀態碼不匹配，則返回一個error
err := httpc.New("http://localhost").Path("not_exist").
    SuccessStatus(200).Get(nil)
fmt.Println(err)
// Output:
// error http status 404 , expect 200

請求上下文

// 請求上下文中包含了每次請求的設置、連接設置等，所有請求應該盡量共享Context
// 我們可以設置回調通知的函數
ctx := httpc.NewContext().
AddCbBeforeSend(func(client *httpc.HttpC, args ...interface{}) error {
    fmt.Println("before request")
    return nil
}).
AddCbAfterSend(func(client *httpc.HttpC, args ...interface{}) error {
    fmt.Println("after response")
    return nil
}).
AddCbOnError(func(client *httpc.HttpC, args ...interface{}) error {
    fmt.Println("on error")
    return nil
}).
SetConnectReadTimeout(30*time.Second, 30*time.Second)
var resp string
err := httpc.New("http://localhost").Path("hello").SetContext(ctx).Get(&resp)
fmt.Println(err, resp)

// 庫默認生成了一個上下文實例 httpc.DefaultContext，它并沒有加鎖保護，所以盡量在所有請求前設置好它
// 改變httpc.DefaultContext會影響所有未調用過SetContext的請求
httpc.DefaultContext.SetConnectReadTimeout(30*time.Second, 30*time.Second)
err = httpc.New("http://localhost").Path("hello").Get(&resp)
fmt.Println(err, resp)

超時設置

err := httpc.New("http://localhost").Path("timeout").
SetContext(httpc.NewContext().SetConnectReadTimeout(time.Second, time.Second)).
  Get(nil)
fmt.Println(err)

請求重試

err := httpc.New("http://not_exist/").Path("not_exist").
    SetContext(httpc.NewContext().AddCbOnRetring(func(c *httpc.HttpC, args ...interface{}) error {
        fmt.Printf("retring %v, next interval %v\n", args[0], args[1])
        return nil
    }).SetRetryConfig(3, time.Second, 2)). // 重試3次，重試時間間隔依次為：2s, 4s, 8s
    Get(nil)
fmt.Println(err)

// Output:
// retring 1, next interval 2s
// retring 2, next interval 4s
// retring 3, next interval 8s
// Get http://not_exist/not_exist: dial tcp: lookup not_exist: no such host

自定義請求或響應處理器

// httpc庫已經注冊了一些通用的請求和響應處理器，但我們也可以額外添加處理器
ctx := httpc.NewContext()
ctx.BodyReaders = httpc.NewBodyReaders()
ctx.BodyReaders.RespBodyTypeReaders[reflect.TypeOf((*int)(nil))] = func(resp *http.Response, reader io.ReadCloser, typ reflect.Type, out interface{}) error {
    output := out.(*int)
    *output = resp.StatusCode
    return nil
}
// 返回響應狀態碼
var status int
err := httpc.New("http://localhost").Path("hello").
    SetContext(ctx).
    Get(&status)
fmt.Println(err, status)
// Output:
// <nil> 200

其他特性

請參考Api文檔或源碼