Go設置http請求超時的方法實現(xiàn)

更新時間：2024年08月11日 10:11:05 作者：Grassto

這篇文章主要介紹了Go設置http請求超時的方法實現(xiàn),最近接手了一個老項目進行維護,發(fā)現(xiàn)其中有個關于 http 請求的方法設置的 timeout 沒有生效,很奇怪,一開始查看代碼并沒有發(fā)現(xiàn)什么可疑點,后查看了源碼,打斷點調(diào)試才發(fā)現(xiàn)問題所在,這里簡單記錄復盤一下

背景

最近接手了一個老項目進行維護，發(fā)現(xiàn)其中有個關于 http 請求的方法設置的 timeout 沒有生效，很奇怪！

一開始查看代碼并沒有發(fā)現(xiàn)什么可疑點，后查看了源碼，打斷點調(diào)試才發(fā)現(xiàn)問題所在，這里簡單記錄復盤一下。

說明：本篇的源碼的 go 版本是 1.20.2 。

問題

示例代碼

package main

import (
	"context"
	"fmt"
	"net/http"
	"time"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://www.baidu.com", nil)
	if err != nil {
		panic(err)
	}

	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond)
	defer cancel()
	req.WithContext(ctx)

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}

	//resp.Write(os.Stdout)
	fmt.Println("end: ", resp.StatusCode)
}

程序正常跑完并輸出了，但是預期的是 http.DefaultClient.Do(req) 這里會直接報錯，難道請求 1ms 就結束了？？Why？？？

大家可以自己看下這段代碼哪里有問題。

先說解決，其實就是 req.WithContext(ctx) 生成的是一個新的 http.Request 對象，上述的問題代碼中并沒有將其賦值給當前的 http.Request。大意了，沒有閃。

req = req.WithContext(ctx)

WithContext 方法的源碼如下（net/http/request.go 356）

func (r *Request) WithContext(ctx context.Context) *Request {
	if ctx == nil {
		panic("nil context")
	}
	r2 := new(Request)
	*r2 = *r
	r2.ctx = ctx
	return r2
}

請求超時設置

翻了下源碼，看了下超時設置的方式，http 設置超時主要有兩種方式：

http.Client

	c := http.Client{
		Timeout: time.Minute,
	}
	c.Do(req)

http.Request 設置 context 超時

	ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
	defer cancel()
	req = req.WithContext(ctx)

在 Client 上指定 Timeout 會作用于通過該 Client 發(fā)起的所有請求，而 Request 設置 Context，僅針對這一次請求。使用的時候需要注意自己的場景。

設置 Tcp 連接階段的超時可以這樣：

client := http.Client{
	Transport: &http.Transport{
		Dial: (&net.Dialer{
			Timeout:   2  * time.Second, //  tcp 連接時設置的連接超時
			Deadline:  time.Now().Add(3  * time.Second),  // 超時強制關閉
		}).Dial,
		TLSHandshakeTimeout: 2 * time.Second, //https 握手超時
	},
	Timeout: 5 * time.Second,
}

可以設置 Transport 中的 Dial。