本文将介绍一个 Golang 下的 Http 请求封装库。可以与 Python 的 requests 库类似的配置请求和处理返回。
## 获取 Goreq
```
go get -u github.com/zhshch2002/goreq
```
## Quick start
首先,我们来发起一个 GET 请求,代码非常简单。如下:
```go
func main() {
res := goreq.Do(goreq.Get("https://httpbin.org/get"))
if res.Err != nil {
fmt.Println(res.Err)
} else {
fmt.Println(res.Text)
}
}
```
其中`res`包含了相应的数据,`res.Err`为非空时表示请求中遇到错误。
除了 GET,HTTP 还有其他一系列方法,包括 POST、PUT、DELETE、HEAD、OPTIONS。更换`goreq.Get`为`goreq.Post`即可。
```go
func main() {
res := goreq.Post("https://httpbin.org/post").Do()
if res.Err != nil {
fmt.Println(res.Err)
} else {
fmt.Println(res.Text)
}
}
```
## URL 参数
指在 UR`?`L 之后用`&`隔开的键值对数据。手工构建 URL 会比较麻烦,我们可以只用 Goreq 提供的链式函数来构建。
```go
func main() {
res := goreq.Get("https://httpbin.org/get?hi=myself").
AddParam("aaa", "111"). // set a single param
AddParams(map[string]string{
"bbb": "222",
}).Do()
if res.Err != nil {
fmt.Println(res.Err)
} else {
fmt.Println(res.Text)
}
}
```
此时发出的请求的 URL 为`https://httpbin.org/get?hi=myself&aaa=111&bbb=222`。Goreq 会自动编码参数。
由此,我们可以发现 Gore 去对请求配置的方式——链式配置。比原始的 HTTP 库提供的方式要快捷很多。
原始的参数构建方式。
```go
req, err := http.NewRequest(http.MethodGet, "http://httpbin.org/get", nil)
if err != nil {
panic(err)
}
params := make(url.Values) // 参数在此出
params.Add("key1", "value1")
params.Add("key2", "value2")
req.URL.RawQuery = params.Encode()
r, err := http.DefaultClient.Do(req)
```
重新另起数据结构再转化打断了一开始的编程思路。
## Goreq 配置请求
* `AddParam(k, v string)` 添URL参数
* `AddParams(v map[string]string)` 添加一组URL参数
* `AddHeader(key, value string)` 添加请求头部
* `AddHeaders(v map[string]string)` 添加一组请求头部
* `AddCookie(c *http.Cookie)`添加Cookie
* `SetUA(ua string)`设置UA
* `SetBasicAuth(username, password string)`设置HTTP身份验证
* `SetProxy(urladdr string)`为此请求设置代理
* `SetTimeout(t time.Duration)`为此请求设置超时时间
* `DisableRedirect()`禁用重定向跟随
* `SetCheckRedirect(fn func(req *http.Request, via []*http.Request) error)`为此请求设置重定向跟随检查函数
* 设置POST数据
* `SetBody(b io.Reader)`
* `SetRawBody(b []byte)`
* `SetFormBody(v map[string]string)`
* `SetJsonBody(v interface{})`
* `SetMultipartBody(data ...interface{})` 设置Multipart格式的数据
* `Callback(fn func(resp *Response)` 设置一个在`Do`方法调用完成之后执行的回调函数
## 响应数据
```go
func main() {
res := goreq.Post("https://httpbin.org/post").Do()
fmt.Println(res.Body) // []byte格式的数据
fmt.Println(res.Text) // 自动处理编码后解析的字符串
}
```
Goreq一开始是为了API和网页请求设计的库,会自动根据响应内容和响应头推断编码类型,并自动解析为字符串。
如果我们要处理JSON格式的响应数据,这样写可以更优雅。
```go
func main() {
var data map[string]interface{}
err := goreq.Post("https://httpbin.org/post").Do().BindJSON(&data)
fmt.Println(data, err)
}
```
Goreq为响应`res`提供了一些快速解析的方法,`*goreq.Response`可以通过下述函数来获取响应数据。
* `Resp() (*Response, error)` 获取响应本身以及网络请求错误。
* `Txt() (string, error)` 自动处理完编码并解析为文本后的内容以及网络请求错误。
* `HTML() (*goquery.Document, error)`
* `XML() (*xmlpath.Node, error)`
* `BindXML(i interface{}) error`
* `JSON() (gjson.Result, error)`
* `BindJSON(i interface{}) error`
* `Error() error` 网络请求错误。(正常情况下为`nil`)
## 老爹说:还有一件事……
Goreq基本使用就是这样,更完整的API请见[GitHub](https://github.com/zhshch2002/goreq)。其中还包括自定义`Client`和中间件的使用。