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

Go 怎样用 ResponseRecorder 测响应

来源:17golang原创

时间:2026-10-21 23:41:48 115浏览 收藏

我在给 Go 的 HTTP handler 补测试时,最常见的需求不是启动一个端口,而是确认“这个请求进来后返回了什么”。这时用 net/http/httptest 的 NewRequest 和 NewRecorder 就够了:前者构造测试请求,后者实现 http.ResponseWriter 并记录 handler 写入的状态码、响应头和响应体。

最稳妥的读取方式是调用 recorder.Result(),把结果当作普通的 *http.Response 来断言。这样既能覆盖显式写出的状态码,也能正确得到 handler 没有主动写入时的隐含 200。

从请求到响应对象:ResponseRecorder 记录了什么

测试的结构可以固定成四个对象:请求、handler、录制器和结果。录制器不是网络服务器,它只是一个内存中的 http.ResponseWriter 实现;handler 对它调用 Header、WriteHeader 或 Write 后,测试再从结果对象读取内容。

Go httptest 请求、handler、ResponseRecorder 与 http.Response 的静态关系图
图中按测试输入、处理与记录、断言对象分组,帮助理解 NewRequest、handler、ResponseRecorder 和 Result 之间的静态关系。

一个最小的 handler 可以这样写。代码里的中文注释保留了每个写入动作的目的,后面的断言就能按同样的维度对应起来:

package handler_test

import (
    "encoding/json"
    "net/http"
)

// profileHandler 返回一个固定的 JSON 响应,方便测试响应契约。
func profileHandler(w http.ResponseWriter, r *http.Request) {
    // 明确声明响应格式,测试可以检查这个协议头。
    w.Header().Set("Content-Type", "application/json")
    // 先写状态码,避免由第一次 Write 隐式决定状态。
    w.WriteHeader(http.StatusCreated)
    // 只写业务字段,保持响应体足够小且容易断言。
    _ = json.NewEncoder(w).Encode(map[string]string{"name": "gopher"})
}

先构造请求,再把 handler 接到录制器

httptest.NewRequest 用来构造服务端请求。它适合把方法、目标地址和请求体放进测试上下文;地址不需要真的可访问。然后用 httptest.NewRecorder 创建录制器,直接调用 handler:

func TestProfileHandler(t *testing.T) {
    // 使用服务端请求语义,不需要监听真实端口。
    req := httptest.NewRequest(http.MethodGet, "http://example.com/profile", nil)
    // 录制器会接收 handler 对 ResponseWriter 的写入。
    recorder := httptest.NewRecorder()

    profileHandler(recorder, req)

    // Result 必须在 handler 返回后读取,才能得到完整响应。
    response := recorder.Result()
    defer response.Body.Close()
}

这里的关键是调用顺序:handler 返回后再读取结果。Result() 会提供状态码、响应头和非空 Body;它返回的是快照式的 http.Response 视图,测试代码不需要依赖录制器的内部字段。

测试状态码、响应头和 Body:把断言写在 Result 之后

我更倾向于把三类断言分开写。这样失败时一眼就能看出是协议状态、响应头还是业务 JSON 出问题:

Go handler 写入状态码响应头正文后由 ResponseRecorder 结果对象承接的关系图
图中把 handler 的三类写入与结果对象的三类读取并列展示,便于把失败断言定位到状态码、Header 或 Body。
func TestProfileHandlerResponse(t *testing.T) {
    // 组装请求与录制器,测试不依赖外部网络。
    req := httptest.NewRequest(http.MethodGet, "http://example.com/profile", nil)
    recorder := httptest.NewRecorder()

    profileHandler(recorder, req)
    response := recorder.Result()
    defer response.Body.Close()

    // 状态码断言对应 handler 的 WriteHeader 调用。
    if response.StatusCode != http.StatusCreated {
        t.Fatalf("状态码 = %d,期望 %d", response.StatusCode, http.StatusCreated)
    }
    // Header 从 Result 返回的 Response 上读取,不直接依赖 HeaderMap。
    if got := response.Header.Get("Content-Type"); got != "application/json" {
        t.Fatalf("Content-Type = %q,期望 application/json", got)
    }

    // 读取完整 Body 后再解码,避免只比较格式化后的字符串。
    var payload map[string]string
    if err := json.NewDecoder(response.Body).Decode(&payload); err != nil {
        t.Fatalf("解码响应体失败:%v", err)
    }
    // 业务字段断言比整段 JSON 字符串比较更耐字段顺序变化。
    if payload["name"] != "gopher" {
        t.Fatalf("name = %q,期望 gopher", payload["name"])
    }
}

官方文档还特别提醒,不要用 DeepEqual 比较整个 Result() 返回值,因为未来可能补充更多字段。对测试真正关心的状态码、Header 和 Body 做局部断言,维护成本更低。

默认状态码和异常分支要单独覆盖

一个容易踩到的细节是:如果 handler 既没有调用 WriteHeader,也没有调用 Write,录制器的内部 Code 可能仍然是 0。这个 0 不代表客户端收到 0;通过 Result() 读取时,隐含的成功状态会表现为 200。

func emptyHandler(w http.ResponseWriter, r *http.Request) {
    // 故意不写响应,用来覆盖“没有任何写入”的边界。
}

func TestEmptyHandlerUsesResultStatus(t *testing.T) {
    // 构造一个最小服务端请求和录制器。
    req := httptest.NewRequest(http.MethodGet, "/health", nil)
    recorder := httptest.NewRecorder()

    emptyHandler(recorder, req)
    // 通过 Result 读取客户端语义,而不是直接读取内部 Code。
    response := recorder.Result()
    defer response.Body.Close()

    if response.StatusCode != http.StatusOK {
        t.Fatalf("状态码 = %d,期望 %d", response.StatusCode, http.StatusOK)
    }
}

如果要测试错误分支,同样只需要让 handler 写出错误状态和错误体,再对两者分别断言。这样的测试能把“错误响应仍然带 JSON”这类约定固定下来。

ResponseRecorder 适合单元测试,但不是完整网络测试

ResponseRecorder 直接调用 handler,适合验证路由处理函数的输出契约,速度快、没有端口占用,也不会把 DNS、连接复用或真实客户端行为混进测试。它的边界也很清楚:如果你要验证中间件链、真实 HTTP 客户端、重定向、TLS 或连接层行为,就应该考虑 httptest.NewServer,让客户端通过真实地址访问测试服务器。

我的判断是:只测“handler 给了什么响应”,优先用 NewRecorder;要测“客户端经过网络拿到了什么”,再升级到 NewServer。两者不是替代关系,而是把测试范围分开。

几个容易混淆的问题

可以直接读取 recorder.Code 吗?

可以读取,但不建议把它作为主要断言入口。handler 没有写入任何内容时,内部 Code 可能是 0;用 recorder.Result().StatusCode 更接近客户端看到的结果。

为什么要关闭 response.Body?

测试代码应保持和普通 HTTP 响应一样的资源习惯。即使录制器返回的 Body 在内存里,拿到 Response 后仍然用 defer response.Body.Close() 表达清晰的所有权边界。

什么时候不该用 ResponseRecorder?

当测试目标包含真实客户端请求、端口、TLS、重定向或完整中间件链时,使用 httptest.NewServer 更合适;当目标只是 handler 的状态码、Header 和 Body,Recorder 就足够。

总结一下:用 NewRequest 准备请求,用 NewRecorder 接住 handler 的写入,handler 返回后调用 Result(),再分别断言 StatusCode、Header 和 Body。把这四个动作固定下来,Go HTTP 响应测试就不会再依赖真实端口,也不容易被录制器内部字段的细节带偏。

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