登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go教程

Go 单元测试怎么替换 HTTP 客户端而不访问网络

来源:17golang原创

时间:2026-09-06 09:32:59 165浏览 收藏

Go 单元测试里,如果被测函数直接使用默认的 http.Client,一次测试就可能真的发出 DNS、TCP 或 TLS 请求。更稳妥的做法是把客户端作为依赖传入,并在测试中替换它的 Transport。由于 http.Client 依赖的是 http.RoundTripper 接口,替身可以直接返回预设的 http.Response,整个测试不需要启动 HTTP 服务,也不会访问外网。

要点速览
  • 替换点是 http.Client.Transport,不是把生产 URL 改成测试地址。
  • 自定义 RoundTripper 要返回可关闭的 Response.Body,并对请求做断言。
  • 状态码属于响应结果,拿到响应时不要把非 2xx 自动当成 transport 错误。

为什么替换的是 RoundTripper 而不是把请求 URL 改成本地地址

http.Client 负责更高层的请求行为,真正执行一次 HTTP 事务的是 Transport。官方接口把这个能力抽象成 RoundTripper:给它一个已初始化的请求,返回响应或获取响应时发生的错误。默认实现会按需建立网络连接;测试则可以把同一接口换成内存中的函数。

因此生产代码只需要接收一个客户端,测试代码再构造带替身的客户端。这样请求方法、路径、查询参数和请求头仍然由业务代码决定,测试只控制“传输层返回什么”,不会因为改写 URL 而掩盖调用错误。

Go 单元测试中业务函数、http.Client、http.RoundTripper、stubTransport 与 http.Response 的调用边界关系图
图1:http.Client 只依赖 RoundTripper 接口,测试可以在传输边界放入 stubTransport

一个不会访问网络的测试替身怎么写

先给业务函数一个明确的客户端参数。下面的示例只读取响应状态,替身则保存收到的请求,返回一个内存响应:

package report

import (
    "fmt"
    "io"
    "net/http"
)

type roundTripFunc func(*http.Request) (*http.Response, error)

func (f roundTripFunc) RoundTrip(req *http.Request) (*http.Response, error) {
    // 由测试决定响应内容,这里不会拨号。
    return f(req)
}

func fetchStatus(client *http.Client, endpoint string) (int, error) {
    req, err := http.NewRequest(http.MethodGet, endpoint, nil)
    if err != nil {
        return 0, err
    }
    resp, err := client.Do(req)
    if err != nil {
        return 0, err
    }
    defer resp.Body.Close() // 业务代码负责关闭响应体。
    return resp.StatusCode, nil
}

func describeStatus(code int) string {
    return fmt.Sprintf("status=%d", code)
}

var _ http.RoundTripper = roundTripFunc(nil)

测试时把 roundTripFunc 放进 http.Client{Transport: ...}。返回响应时要同时提供 StatusCodeBody;即使示例只读取状态码,也应返回 io.NopCloser 包装的响应体,避免被测代码一旦开始读取正文就得到空指针。

func TestFetchStatusUsesStub(t *testing.T) {
    var gotMethod, gotURL string
    client := &http.Client{
        Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
            // 断言请求到达替身,证明测试没有悄悄换掉调用路径。
            gotMethod = req.Method
            gotURL = req.URL.String()
            return &http.Response{
                StatusCode: http.StatusAccepted,
                Body:       io.NopCloser(strings.NewReader("queued")),
                Header:     make(http.Header),
                Request:    req,
            }, nil
        }),
    }

    code, err := fetchStatus(client, "https://api.example.test/reports")
    if err != nil {
        t.Fatal(err)
    }
    if code != http.StatusAccepted {
        t.Fatalf("status = %d, want %d", code, http.StatusAccepted)
    }
    if gotMethod != http.MethodGet || gotURL != "https://api.example.test/reports" {
        t.Fatalf("request = %s %s", gotMethod, gotURL)
    }
}

这段测试还需要导入 stringstesting。示例把请求地址保留为业务真实地址,只是没有让默认 transport 接管它;这能同时验证 URL 拼写和网络隔离。生产代码中若要复用客户端,也应在创建后复用,而不是每个请求重新创建。

请求替身有哪些边界需要主动验证

替身越简单越好,但不能只返回一个 200 就结束。至少把下面几项分开检查:

检查对象应验证什么常见遗漏
请求方法、URL、查询参数和关键请求头测试通过但业务请求路径写错
响应状态码、正文和错误分支只覆盖成功分支,没处理 401/500
资源Response.Body 可读且最终关闭返回 nil Body,或业务忘记 Close
并发多个测试调用时替身状态是否安全共享切片或变量产生数据竞争
Go HTTP 单元测试中 Test 函数、请求构造、传输替身、响应体与请求响应断言的边界关系图
图2:测试既要检查请求是否正确,也要处理 http.Response.Body 这一可关闭资源。

如果要覆盖网络错误,让 RoundTrip 返回一个明确的 error;如果要覆盖服务端错误,则返回带有 StatusCode 的 response 和 nil error。两者含义不同:前者表示没有拿到响应,后者表示拿到了响应,只是业务状态不理想。

常见问题

Transport 不设置会发生什么?

http.Client 会使用默认 transport,测试可能真的访问网络。要隔离网络,显式传入带替身的客户端。

为什么返回 500 时不能同时返回普通 error?

HTTP 500 是已经取得的响应,应该让客户端拿到 response,再由业务层决定是否报错。transport error 留给 DNS、连接失败等“没有取得响应”的情况。

多个测试可以共用一个替身吗?

可以,但替身必须能并发安全地读取和写入状态。更简单的做法是每个测试创建自己的客户端,避免共享请求记录和响应队列。

把 HTTP 依赖注入到业务函数,再在测试中替换 http.RoundTripper,就能同时保留真实请求构造逻辑和稳定的内存响应。真正需要集成验证服务器路由、TLS 或代理行为时,再单独使用测试服务器或更高层测试,不要把这些成本混入每个单元测试。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>