httptest 是 go 标准库中用于 http 单元测试的工具包,它通过模拟请求和记录响应来验证处理函数的行为。1. 它无需启动真实服务即可测试接口逻辑,适用于如返回 json 的 api 接口;2. 常用方法包括 httptest.newrequest() 创建伪造请求对象,以及 httptest.newrecorder() 捕获 handler 输出;3. 测试路由和中间件时需将 handler 注册到临时 mux 或使用框架提供的测试引擎,例如 gin 的 testingengine;4. 小技巧包括设置请求头、解析 json 响应、构造路径参数以测试不同场景,并避免全局变量影响测试独立性。
在 golang 的 Web 开发中,单元测试 HTTP 处理程序是一个很常见的需求。使用标准库中的
httptest
包可以非常方便地对处理函数进行模拟请求和响应的测试。它能让你不需要启动真实的服务就能验证接口逻辑是否正确。
1. 为什么用
httptest
httptest
Go 标准库提供了
net/http/httptest
这个包,专门用来做 HTTP 的单元测试。它可以在不真正发起网络请求的情况下模拟请求(Request)和记录响应(Response),非常适合用于测试 handler 函数的行为。
比如你写了一个返回 JSON 的 API 接口,你可以通过构造一个请求,调用这个 handler,然后检查它的输出是否符合预期。
立即学习“go语言免费学习笔记(深入)”;
2. 基本用法:创建一个测试服务器
httptest
提供了
NewRecorder()
和
NewRequest()
两个常用方法:
-
httptest.NewRequest()
:创建一个伪造的请求对象。
-
httptest.NewRecorder()
:创建一个响应记录器,用来捕获 handler 的输出。
举个例子,假设你有如下一个简单的 handler:
func helloHandler(w http.ResponseWriter, r *http.Request) { fmt.Fprintln(w, "Hello, world") }
对应的测试代码可以这样写:
func TestHelloHandler(t *testing.T) { req := httptest.NewRequest("GET", "http://example.com/hello", nil) w := httptest.NewRecorder() helloHandler(w, req) resp := w.Result() body, _ := io.ReadAll(resp.Body) if string(body) != "Hello, worldn" { t.Errorf("Expected Hello, world, got %s", body) } }
这一步是测试的核心,关键点在于:
- 构造请求对象时注意 URL、Method 和 Body(如果有)
- 使用
httptest.NewRecorder()
捕获响应内容
- 最后检查状态码或响应体是否符合预期
3. 测试路由和中间件
如果你用的是类似
Gin
或者
这样的框架,或者自己用了
http.ServeMux
,那测试方式稍有不同。你需要把 handler 注册到一个临时的 mux 上,再用
httptest
发起请求。
比如:
func TestWithServeMux(t *testing.T) { mux := http.NewServeMux() mux.HandleFunc("/hello", helloHandler) req := httptest.NewRequest("GET", "/hello", nil) w := httptest.NewRecorder() mux.ServeHTTP(w, req) // 检查结果... }
如果是 Gin 框架,也可以用
gin.TestingEngine
来配合测试。
4. 小技巧和注意事项
-
设置请求头:比如要测试 JWT 认证,可以在 request 上加 Header:
req.Header.Set("Authorization", "Bearer token123")
-
处理 JSON 响应:如果 handler 返回的是 JSON,可以用
json.Unmarshal
解析 body 再做断言。
-
测试参数和路径变量:可以通过构造不同的 URL 路径来模拟路径参数(如
/user/123
)
-
避免全局变量污染:单元测试尽量保持独立,不要依赖外部状态
基本上就这些。用
httptest
测试 HTTP handler 是 Go 里最直接的方式,虽然简单但非常实用。只要掌握几个核心函数,就可以写出清晰可靠的测试用例。