Go httptest.ResponseRecorder.Result 怎么读取最终响应快照

在 Go 的 HTTP 单元测试里，httptest.ResponseRecorder.Result() 用来读取处理器执行完成后的最终响应快照。最稳妥的方式是先让 handler 执行完，再调用 Result()，从返回的 http.Response 分别读取 StatusCode、Header 和 Body。

官方资料：https://pkg.go.dev/net/http/httptest#ResponseRecorder

这和直接读取 recorder 的内部记录有一个重要区别：Header() 是 handler 写入响应头的入口，Result().Header 才是完成后用于断言的响应头视图；Result() 还会把隐式状态码和可读取的响应体整理成 http.Response。

先区分 ResponseRecorder 和最终响应

ResponseRecorder 是一个测试用的 http.ResponseWriter 实现，它记录 handler 对响应做过的修改。常见字段适合观察记录过程，但不应该把它们当成最终 API 的完整替代：

Result() 应该在 handler 执行完成后调用

最小用法是创建请求和 recorder，调用 handler，然后读取返回值。Result() 的调用时机很关键：官方文档要求 handler 已经运行结束，否则快照可能还没有包含后续写入。

package handler_test

import (
	"io"
	"net/http"
	"net/http/httptest"
	"testing"
)

func TestResultSnapshot(t *testing.T) {
	handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		// 先设置响应头，再写状态和正文，方便测试完整响应。
		w.Header().Set("Content-Type", "text/plain; charset=utf-8")
		w.WriteHeader(http.StatusCreated)
		_, _ = w.Write([]byte("created"))
	})

	req := httptest.NewRequest(http.MethodPost, "/items", nil)
	recorder := httptest.NewRecorder()

	// handler 返回后，响应内容才算进入可断言的完成状态。
	handler.ServeHTTP(recorder, req)
	resp := recorder.Result()
	defer resp.Body.Close() // 读取完成后关闭响应体，保持测试资源边界清楚。

	body, err := io.ReadAll(resp.Body)
	if err != nil {
		t.Fatalf("读取响应体失败: %v", err)
	}
	if resp.StatusCode != http.StatusCreated {
		t.Fatalf("状态码 = %d, want %d", resp.StatusCode, http.StatusCreated)
	}
	if got := resp.Header.Get("Content-Type"); got != "text/plain; charset=utf-8" {
		t.Fatalf("Content-Type = %q", got)
	}
	if string(body) != "created" {
		t.Fatalf("响应体 = %q", string(body))
	}
}

这个测试的断言对象是 resp，而不是 recorder 的某个内部字段。Body 是流，读取后游标会向前移动，所以通常应在读取前保存需要的字节，或者只在一个地方消费它。

状态码、响应头和响应体怎么分别读取

把最终响应拆成三个独立断言，既能表达测试意图，也能避免把“没有显式写状态码”和“状态码读取错误”混在一起。

func assertResponse(t *testing.T, resp *http.Response) {
	t.Helper()

	// StatusCode 是最终响应语义，适合断言隐式或显式的 HTTP 状态。
	if resp.StatusCode != http.StatusOK {
		t.Errorf("StatusCode = %d, want %d", resp.StatusCode, http.StatusOK)
	}

	// Header 来自完成后的响应快照，不再修改 handler 的写入入口。
	if got := resp.Header.Get("X-Request-Mode"); got != "test" {
		t.Errorf("X-Request-Mode = %q, want %q", got, "test")
	}

	// Body 必须读取并处理错误；测试结束前由调用方负责关闭它。
	body, err := io.ReadAll(resp.Body)
	if err != nil {
		t.Fatalf("读取 Body 失败: %v", err)
	}
	if string(body) != "ok" {
		t.Errorf("Body = %q, want %q", string(body), "ok")
	}
}

如果只关心一项，就只断言那一项。例如只测错误处理分支时，可以只看 StatusCode 和错误正文，不需要把所有响应头都写进断言。

没有显式 WriteHeader 时为什么仍应看 StatusCode

一个 handler 可能只调用 Write，甚至完全不写响应。HTTP 语义通常会落到隐式成功状态，但 recorder 的原始字段不一定表达出你想断言的最终结果。官方文档明确建议用 Result() 获得隐式的 http.StatusOK。

func TestImplicitOK(t *testing.T) {
	recorder := httptest.NewRecorder()
	req := httptest.NewRequest(http.MethodGet, "/health", nil)

	http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		// 不调用 WriteHeader，直接结束处理，测试 Result 的隐式状态。
	}).ServeHTTP(recorder, req)

	resp := recorder.Result()
	defer resp.Body.Close()
	if resp.StatusCode != http.StatusOK {
		t.Fatalf("StatusCode = %d, want %d", resp.StatusCode, http.StatusOK)
	}
}

这里不要把“handler 没有写任何内容”误判为测试失败。你要测试的是最终 HTTP 响应，就让 Result().StatusCode 成为唯一判断入口。

Header 是快照，不能把它当成实时引用

Result().Header 表示响应头快照：如果 handler 已经第一次写入响应，它对应首次写入时的头；如果 handler 没有写入，则在调用 Result() 时取得当前头。因此，断言应该放在 handler 完成之后，且不要期待后续修改 recorder 的头会改变已经拿到的响应。

另外，HeaderMap 是历史兼容字段，官方文档将它标记为内部细节并建议使用 Result() 返回的响应头。测试代码直接依赖 HeaderMap，会让断言和 recorder 的内部实现耦合。

不要 DeepEqual 整个 http.Response

Result() 返回的 http.Response 未来可能增加更多字段，官方文档因此不建议在测试里对整个结果做 DeepEqual。更稳定的写法是按业务契约断言：

• 状态是否是预期的 StatusCode。
• 关键响应头是否存在、值是否正确。
• 正文是否能被读取，并符合协议内容。
• 如果有 trailer，再单独断言相关字段，而不是把完整响应对象作为快照。

这样写的好处是，测试失败时能直接指出是状态、头还是正文不符合约定，也不容易因为 Go 标准库未来填充额外字段而产生无关失败。

常见问题

Result() 返回的 Body 会不会是 nil？

官方契约保证返回的 Response.Body 非 nil，并且读取时除了 io.EOF 不应出现其他错误。测试仍应在读取后关闭它。

可以同时读取 recorder.Body 和 resp.Body 吗？

可以观察，但不建议把两套读取混在同一个断言流程里。面向最终响应的测试统一读取 resp.Body，更能表达“处理完成后的结果”。

什么时候直接检查 recorder.Code 仍然有用？

如果你专门测试 handler 是否调用了某个写入动作，原始记录字段可以帮助定位过程；如果测试目标是 HTTP 响应契约，应优先使用 Result() 后的字段。

速查结论

一句话记忆：ResponseRecorder 负责记录 handler 的写入，Result() 负责把这些写入整理成可读取的最终响应；处理器结束后按字段读取，就是最清晰也最稳的测试方式。

技术事实来源：https://pkg.go.dev/net/http/httptest#ResponseRecorder、https://go.dev/src/net/http/httptest/recorder.go