如何使用Golang测试HTTP接口_使用httptest模拟请求响应

Go语言httptest包提供两种HTTP测试方式:1. NewServer启动临时服务,适合需真实客户端调用的集成测试;2. NewRequest+NewRecorder模拟请求响应,适合快速可控的单元测试,支持中间件、路由框架及JSON/表单等请求体测试。

Go 语言自带的 net/http/httptest 包是测试 HTTP 接口最轻量、最可靠的方式,无需启动真实服务器,就能完整模拟请求与响应流程。

用 httptest.NewServer 启动临时测试服务

适合需要真实 HTTP 客户端(如 http.Client)发起请求的场景,比如测试 SDK、外部调用逻辑或集成行为。

  • 它会自动监听一个空闲端口,返回一个可关闭的 *httptest.Server
  • 服务内部使用你提供的 http.Handler(可以是路由 mux、自定义 handler,甚至整个 Gin/Echo 实例)
  • 务必在测试结束前调用 server.Close(),避免端口泄漏

示例:

func TestAPIWithRealClient(t *testing.T) {
    handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        if r.URL.Path == "/users" && r.Method == "GET" {
            w.Header().Set("Content-Type", "application/json")
            w.WriteHeader(http.StatusOK)
            json.NewEncoder(w).Encode([]map[string]string{{"name": "Alice"}})
        }
    })

    server := httptest.NewServer(handler)
    defer server.Close() // 关键:释放端口和资源

    resp, err := http.Get(server.URL + "/users")
    if err != nil {
        t.Fatal(err)
    }
    defer resp.Body.Close()

    if resp.StatusCode != http.StatusOK {
        t.Errorf("expected 200, got %d", resp.StatusCode)
    }
}

用 httptest.NewRequest + httptest.NewRecorder 模拟单次请求

适合单元测试 handler 函数本身,不依赖网络,执行快、可控性强,是绝大多数接口逻辑测试的首选方式。

  • httptest.NewRequest 构造任意方法、路径、Header、Body 的请求对象
  • httptest.NewRecorder 替代真实 ResponseWriter,捕获状态码、Header、响应体等全部输出
  • 直接把 request 和 recorder 传给你的 handler 调用即可

示例:

func TestUserHandler(t *testing.T) {
    req := httptest.NewRequest("GET", "/users/123", nil)
    w := httptest.NewRecorder()

    handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        id := strings.TrimPrefix(r.URL.Path, "/users/")
        w.Header().Set("Content-Type", "application/json")
        w.WriteHeader(http.StatusOK)
        json.NewEncoder(w).Encode(map[string]string{"id": id, "name": "Bob"})
    })

    handler.ServeHTTP(w, req)

    if w.Code != http.StatusOK {
        t.Errorf("expected status 200, got %d", w.Code)
    }

    var result map[string]string
    if err := json.Unmarshal(w.Body.Bytes(), &result); err != nil {
        t.Fatal(err)
    }
    if result["id"] != "123" {
        t.Error("expected id '123'")
    }
}

测试带中间件或路由框架的接口

无论是 Gorilla Mux、Chi 还是 Gin,只要最终暴露的是 http.Handler,就能用 NewRequest + NewRecorder 测试。

  • Gin 示例:用 gin.CreateTestContext(w, req) 获取上下文后调用 c.Next()engine.ServeHTTP()
  • Chi/Gorilla:直接将 chi.NewMux()mux.NewRouter() 作为 handler 传入 ServeHTTP
  • 注意:注册路由后,确保请求路径与路由规则完全匹配(包括 trailing slash)

处理 JSON 请求体和表单数据

测试 POST/PUT 接口时,需正确设置 Body 和 Content-Type。

  • JSON:用 bytes.NewReader(jsonBytes) 构造 body,并设置 req.Header.Set("Content-Type", "application/json")
  • 表单:用 url.Values{"key": {"value"}}.Encode(),并设为 "application/x-www-form-urlencoded"
  • 文件上传可结合 multipart.Writer 构造复杂 body,但多数场景用 JSON 或表单已足够

不复杂但容易忽略。