【记录】go 设置 http 请求超时

背景

最近接手了一个老项目进行维护,发现其中有个关于 http 请求的方法设置的 timeout 没有生效,很奇怪!

一开始查看代码并没有发现什么可疑点,后查看了源码,打断点调试才发现问题所在,这里简单记录复盘一下。

说明 :本篇的源码的 go 版本是 1.20.2

问题

示例代码

go 复制代码
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)

go 复制代码
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 设置超时主要有两种方式:

  1. http.Client
go 复制代码
	c := http.Client{
		Timeout: time.Minute,
	}
	c.Do(req)
  1. http.Request 设置 context 超时
go 复制代码
	ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
	defer cancel()
	req = req.WithContext(ctx)

Client 上指定 Timeout 会作用于通过该 Client 发起的所有请求,而 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

总结

平常自己使用 http 发送请求设置超时,都是直接给 http.Client 对象设置 Timeout 属性,很少使用这种对单个 Request 设置超时的。

其实还是个熟练度问题,平常源码读的比较少。有空读读源码不仅可以在使用代码的时候更得心应手,也能够学习借鉴源码的代码设计实现。对自己平常经常需要使用的库,还是建议都过一遍源码,很不错的一个打发空闲时间的方式。

相关推荐
游戏开发爱好者86 小时前
iOS重构期调试实战:架构升级中的性能与数据保障策略
websocket·网络协议·tcp/ip·http·网络安全·https·udp
2501_9160137416 小时前
iOS 多线程导致接口乱序?抓包还原 + 请求调度优化实战
websocket·网络协议·tcp/ip·http·网络安全·https·udp
路长且阻17 小时前
网络协议(TCP/IP、HTTP、HTTPS)
网络协议·tcp/ip·http
程序员爱钓鱼17 小时前
Go语言项目工程化 — 常见开发工具与 CI/CD 支持
开发语言·后端·golang·gin
吴free19 小时前
mac电脑wireshark快速实现http接口抓包
网络·测试工具·http·wireshark
THMOM911 天前
TinyWebserver学习(9)-HTTP
网络协议·学习·http
en-route1 天前
HTTP 缓存
网络协议·http·缓存
隆里卡那唔1 天前
在dify中通过http请求neo4j时为什么需要将localhost变为host.docker.internal
http·docker·neo4j
2501_915921431 天前
Fiddler 中文版怎么配合 Postman 与 Wireshark 做多环境接口调试?
websocket·网络协议·tcp/ip·http·网络安全·https·udp
~山有木兮1 天前
LiteHub中间件之限流实现
网络·http·中间件