36.Go HTTP Client

标准库中的net / http软件包提供了发出HTTP网络请求的功能。

在示例中,我们使用httpbin.org这是一个聪明的服务,可以返回特定的HTTP响应,这对于演示HTTP协议的各个方面很有用。

基本HTTP GET
为简单起见,此示例使用http.Get()。 在实际程序中应该使用具有超时的自定义客户端,如下所述。

uri := "https://httpbin.org/html"
resp, err := http.Get(uri)
if err != nil {
    log.Fatalf("http.Get() failed with '%s'\n", err)
}

// it's important to close resp.Body or else we'll leak network connection
// it must be done after checking for error because in error case
// resp.Body can be nil
defer resp.Body.Close()
d, err := ioutil.ReadAll(resp.Body)
if err != nil {
    log.Fatalf("ioutil.ReadAll() failed with '%s'\n", err)
}

contentType := resp.Header.Get("Content-Type")
fmt.Printf("http.Get() returned content of type '%s' and size %d bytes.\nStatus code: %d\n", contentType, len(d), resp.StatusCode)

// getting page that doesn't exist return 404
uri = "https://httpbin.org/page-doesnt-exist"
resp, err = http.Get(uri)
if err != nil {
    log.Fatalf("http.Get() failed with '%s'\n", err)
}

contentType = resp.Header.Get("Content-Type")
fmt.Printf("\nhttp.Get() returned content of type '%s' and size %d bytes.\nStatus code: %d\n", contentType, len(d), resp.StatusCode)

// acessing non-existent host fails
uri = "http://website.not-exists.as/index.html"
resp, err = http.Get(uri)
if err != nil {
    fmt.Printf("\nhttp.Get() failed with: '%s'\nresp: %v\n", err, resp)
}

这显示了如何对URL发出HTTP GET请求(在这种情况下为HTML页面)。

我使用uri作为变量名,因为有net / url包,这意味着在同一文件中导入net / url时使用更自然的url会导致命名冲突。

如果没有错误,则http.Get()返回* http.Response,其中包含以下重要字段:

正文是包含响应内容的io.Reader。 如果URL是HTML页面,则为HTML数据。 如果网址是PNG图片,则为PNG数据
StatusCode是描述HTTP状态代码的int。 200表示确定。 404表示未找到等。
标头包含响应标头。 其类型为map [string] [] string,因为根据HTTP规范,可以使用多个具有相同名称的标头
如果没有错误返回,请务必使用resp.Body.Close(),否则将浪费资源。

尝试访问服务器上不存在的页面会返回状态码为404(未找到)的响应。

尝试访问不存在的主机将失败,在这种情况下,响应为nil。

HTTP GET using custom client
http.Get()只是委派所有工作http.DefaultClient的包装,后者是* http.Client类型的包变量。

最好不要使用http.Get,因为默认客户端没有超时,这意味着它将永远等待连接到速度慢,错误的服务器或恶意服务器。

client := &http.Client{}
client.Timeout = time.Millisecond * 100

uri := "https://httpbin.org/delay/3"
resp, err := client.Get(uri)
if err != nil {
    log.Fatalf("http.Get() failed with '%s'\n", err)
}

如图所示,创建和使用自定义http.Client很容易。

在此示例中,我们设置了非常短的超时,以证明超过该超时将取消连接。

在实际程序中,我们将使用更长的超时时间,例如15秒(确切的超时时间取决于代码的详细信息)。

基本的HTTP POST

client := &http.Client{}
client.Timeout = time.Second * 15

uri := "https://httpbin.org/post"
body := bytes.NewBufferString("text we send")
resp, err := client.Post(uri, "text/plain", body)
if err != nil {
    log.Fatalf("client.Post() failed with '%s'\n", err)
}
defer resp.Body.Close()
d, err := ioutil.ReadAll(resp.Body)
if err != nil {
    log.Fatalf("http.Get() failed with '%s'\n", err)
}

fmt.Printf(“ http.Post()返回状态代码%d,截断的文本:\ n%s ... \ n”,分别为StatusCode,字符串(d)[:93])
进行POST的最简单方法是使用http.Client.Post(URL字符串,contentType字符串,body io.Reader)。

在此示例中,我们发送原始文本。 在大多数情况下,服务器期望正文为url编码格式。

基本HTTP HEAD
类似于HTTP GET,但使用http.Client.Head(uri字符串)方法。

HTTP POST

HTTP POST将二进制数据发送到服务器。

服务器如何解释此数据取决于Content-Type标头的值。

HTTP POST和url编码数据
HTTP POST最常用于将HTML页面中的表单数据提交给服务器。

表单数据是键/值对的字典,其中key是字符串,值是字符串数组(通常是带有单个元素的数组)。

表单键/值对最常作为URL编码的数据发送,其内容类型为application / x-www-form-urlencoded。

client := &http.Client{}
client.Timeout = time.Second * 15

uri := "https://httpbin.org/post"
data := url.Values{
    "name":  []string{"John"},
    "email": []string{"john@gmail.com"},
}
resp, err := client.PostForm(uri, data)
if err != nil {
    log.Fatalf("client.PosFormt() failed with '%s'\n", err)
}
defer resp.Body.Close()
_, err = ioutil.ReadAll(resp.Body)
if err != nil {
    log.Fatalf("ioutil.ReadAll() failed with '%s'\n", err)
}

fmt.Printf("PostForm() sent '%s'. Response status code: %d\n", data.Encode(), resp.StatusCode)

JSON对象的PUT请求

http.Client没有方便的方法来执行PUT请求,因此我们构造了一个http.Request对象,并使用http.Client.Do(req * http.Request)来执行该请求。

user := User{
    Name:  "John Doe",
    Email: "johndoe@example.com",
}

d, err := json.Marshal(user)
if err != nil {
    log.Fatalf("json.Marshal() failed with '%s'\n", err)
}

client := &http.Client{}
client.Timeout = time.Second * 15

uri := "https://httpbin.org/put"
body := bytes.NewBuffer(d)
req, err := http.NewRequest(http.MethodPut, uri, body)
if err != nil {
    log.Fatalf("http.NewRequest() failed with '%s'\n", err)
}

req.Header.Set("Content-Type", "application/json; charset=utf-8")
resp, err := client.Do(req)
if err != nil {
    log.Fatalf("client.Do() failed with '%s'\n", err)
}

defer resp.Body.Close()
d, err = ioutil.ReadAll(resp.Body)
if err != nil {
    log.Fatalf("ioutil.ReadAll() failed with '%s'\n", err)
}

fmt.Printf("Response status code: %d, text:\n%s\n", resp.StatusCode, string(d))

带有上下文的超时请求

从Go 1.7开始,可以使用context.Context超时单个HTTP请求。

// httpbin.org is a service for testing HTTP client
// this URL waits 3 seconds before returning a response
uri := "https://httpbin.org/delay/3"
req, err := http.NewRequest("GET", uri, nil)
if err != nil {
    log.Fatalf("http.NewRequest() failed with '%s'\n", err)
}

// create a context indicating 100 ms timeout
ctx, _ := context.WithTimeout(context.Background(), time.Millisecond*100)
// get a new request based on original request but with the context
req = req.WithContext(ctx)

resp, err := http.DefaultClient.Do(req)
if err != nil {
    // the request should timeout because we want to wait max 100 ms
    // but the server doesn't return response for 3 seconds
    log.Fatalf("http.DefaultClient.Do() failed with:\n'%s'\n", err)
}
defer resp.Body.Close()

带有URL参数和JSON响应的GET

本示例说明如何为GET请求正确编码URL参数,以及如何解析由Stack Exchange API返回的有关Stack Overflow帖子信息的JSON输出。

type postItem struct {
    Score int    `json:"score"`
    Link  string `json:"link"`
}

type postsType struct {
    Items []postItem `json:"items"`
}

values := url.Values{
    "order": []string{"desc"},
    "sort":  []string{"activity"},
    "site":  []string{"stackoverflow"},
}

// URL parameters can also be programmatically set
values.Set("page", "1")
values.Set("pagesize", "10")

uri := "https://api.stackexchange.com/2.2/posts?"
client := &http.Client{
    Timeout: 15 * time.Second,
}
resp, err := client.Get(uri + values.Encode())
if err != nil {
    log.Fatalf("http.Get() failed with '%s'\n", err)
}
defer resp.Body.Close()

if resp.StatusCode != http.StatusOK {
    d, _ := ioutil.ReadAll(resp.Body)
    log.Fatalf("Request was '%s' (%d) and not OK (200). Body:\n%s\n", resp.Status, resp.StatusCode, string(d))
}

dec := json.NewDecoder(resp.Body)
var p postsType
err = dec.Decode(&p)
if err != nil {
    log.Fatalf("dec.Decode() failed with '%s'\n", err)
}

fmt.Println("Top 10 most recently active StackOverflow posts:")
fmt.Println("Score", "Link")
for _, post := range p.Items {
    fmt.Println(post.Score, post.Link)
}

设置User-Agent

HTTP请求包括User-Agent标头。

最好使用对你的程序有意义的用户代理。

另外,某些服务器对它们接受的内容很挑剔。

这是设置自定义用户代理的方法:

userAgent := "Special Agent v 1.0.16"

client := &http.Client{}
client.Timeout = time.Second * 15

uri := "https://httpbin.org/user-agent"
req, err := http.NewRequest(http.MethodGet, uri, nil)
if err != nil {
    log.Fatalf("http.NewRequest() failed with '%s'\n", err)
}
req.Header.Set("User-Agent", userAgent)
resp, err := client.Do(req)
if err != nil {
    log.Fatalf("client.Do() failed with '%s'\n", err)
}

defer resp.Body.Close()
d, err := ioutil.ReadAll(resp.Body)
if err != nil {
    log.Fatalf("ioutil.ReadAll() failed with '%s'\n", err)
}

fmt.Printf("Response status code: %d, text:\n%s\n", resp.StatusCode, string(d))

HTTP请求的方式

程序包net / http具有分层的设计,其中每一层都是位于较低层之上的便利包装。

每个较低的层都比较复杂,但是提供了更多的控制权。

这里是对执行HTTP GET请求的3种方式的概述。

使用http.Get()函数
最简单的方法是使用顶级http.Get()函数,但由于缺少超时,因此不建议使用。

使用http.Client.Get()方法
使用&http.Client {}创建* http.Client
设置适当的超时
使用其Get()或Post()或PostForm()方法
使用http.Client.Do()方法
这样可以最大程度地控制请求。

创建http.Client并设置适当的超时
使用http.NewRequest创建* http.Request
将其方法设置为“ GET”,“ POST”,“ HEAD”,“ PUT”或“ DELETE”
设置自定义标头,例如User-Agentwith Header.Set(key,value string)
通过设置io.ReadCloser类型的主体来设置要发送的主体
设置TransferEncoding
与client.Do(req * http.Request)发送请求
通过使用上下文包含截止期限req = request.WithContext(ctx)的新请求来设置每个请求超时
这是执行PUT或DELETE请求的唯一方法。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,236评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,867评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,715评论 0 340
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,899评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,895评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,733评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,085评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,722评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,025评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,696评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,816评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,447评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,057评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,254评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,204评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,561评论 2 343

推荐阅读更多精彩内容