如何在Golang测试中模拟外部API调用 Go语言gock库拦截HTTP请求

3次阅读

gock 能可靠拦截 go 测试中的 http 请求,但仅限于使用 http.defaultclient 或显式传入 gock.newclient() 创建的 *http.client;不拦截底层 net/http 原始连接、自定义 roundtripper、非标准客户端(如 curl)或 h2c 协议。

如何在Golang测试中模拟外部API调用 Go语言gock库拦截HTTP请求

gock 能否可靠拦截 Go 测试中的 HTTP 请求

能,但仅限于使用 http.DefaultClient 或显式传入由 gock 包装的 *http.Client 的请求。它不拦截底层 net/http 的原始连接、自定义 RoundTripper(如 http.Transport 直接复写)、或非标准 HTTP 客户端(比如用 curl 命令行调用)。

常见错误现象:gock.Intercept() 后测试仍发起真实网络请求,或报错 Get "https://api.example.com": dial tcp: lookup api.example.com: no such host —— 这说明请求根本没走到 gock 拦截层。

  • 确认你的业务代码调用的是 http.Get / http.Post 等默认函数,或明确用了 client.Do(req)client 是未被替换过的 http.DefaultClient
  • 封装了自定义 http.Client(例如带超时、重试),必须在测试中把它替换成 gock.NewClient() 返回的客户端,并注入到被测对象
  • 避免在测试前/后遗漏 gock.Off()gock.Flush(),否则残留规则会影响后续测试

如何正确注册 gock 规则并匹配真实请求

gock 规则不是“通配符匹配”,而是按协议、主机、路径、方法、甚至请求头和 body 逐字段比对。默认只匹配 GET 和完整 URL 路径,其余需显式声明。

使用场景:你调用 http.Post("https://api.example.com/v1/users", "application/json", body),但 gock 只写了 gock.New("https://api.example.com").Get("/v1/users") → 不会命中。

立即学习go语言免费学习笔记(深入)”;

  • 方法必须一致:gock.Post(...) 对应 http.Postgock.Put(...) 对应 http.NewRequest("PUT", ...)
  • 路径要精确:/v1/users/v1/users/(末尾斜杠不同即不匹配)
  • 若请求含 Authorization 头,需用 .MatchHeader("Authorization", "Bearer .+"),否则 gock 默认忽略 header 匹配
  • JSON body 匹配建议用 .MatchType("json").JSON(map[String]Interface{}{"name": "foo"}),避免手动解析字节流
gock.New("https://api.example.com").     Post("/v1/users").     MatchHeader("Content-Type", "application/json").     JSON(map[string]interface{}{"name": "alice"}).     Reply(201).     JSON(map[string]interface{}{"id": 123})

测试结束后忘记清理 gock 导致的连锁失败

gock 规则是全局注册的,不主动清理会污染其他测试用例 —— 表现为某个测试突然失败,错误信息却是“no mock for GET https://xxx”,而它本不该发这个请求。

性能影响不大,但兼容性风险高:多个测试共用同一套 mock 规则时,顺序执行可能因规则残留导致误匹配;并行测试(t.Parallel())下更易崩溃。

  • 每个测试函数结尾必须加 defer gock.Off()(关闭拦截) + defer gock.Flush()(清空所有已注册规则)
  • 不要在 TestMain 里统一 gock.On() —— 它无法按测试粒度隔离
  • 如果想复用规则模板,用函数封装 gock.New(...) 链式调用,而不是复用一个全局变量

当 gock 拦截失效时,第一反应该检查什么

先别改业务逻辑,直接看请求是否真的走到了 net/http —— 很多“拦截失败”其实是代码绕过了 HTTP 客户端。

  • 检查是否误用了 os/exec.Command("curl", ...)exec.Command("wget", ...),这类进程外调用 gock 完全无感知
  • 检查是否用了 http.Client{Transport: &http.Transport{...}} 并覆盖了 RoundTripper,此时需手动把 gock.RoundTripper 注入进去:&http.Transport{RoundTripper: gock.RoundTripper()}
  • 检查 URL 是否含变量:比如业务拼出 "https://api.example.com/v1/users/" + userID,但 gock 写死 "/v1/users/123" → 应改用正则匹配:.MatchParam("id", "d+") 或路径通配 .Get("/v1/users/.+")
  • gock.IsDone() 在测试末尾断言是否所有预期请求都已发出,避免漏测

最常被忽略的一点:gock 不支持 HTTP/2 的 h2c(非 TLS 明文 HTTP/2)连接,如果你的测试服务启用了 h2c,mock 会静默跳过 —— 改用 HTTP/1.1 或换 httptest.Server 更稳妥。

text=ZqhQzanResources