Go / 系统课时

测试 HTTP Client

测试 HTTP Client

本节使用 httptest.Server 启动一个由测试控制的本地 HTTP 服务,让真实 http.Client 发起请求,并验证请求方法、路径、请求头、成功响应与非 2xx 异常分支。这样既不依赖外部服务,又能覆盖完整的 HTTP 往返过程。

学习目标

  • 使用 httptest.NewServer 构造可控的本地服务端
  • 在服务端断言客户端发出的请求,并在客户端断言解析结果
  • 为非 2xx 响应建立稳定的错误分支测试

为什么 Client 测试要启动测试服务器

直接伪造 http.Response 可以测试部分解析逻辑,但无法证明客户端是否真的发出了正确的方法、路径和请求头。httptest.Server 会监听一个随机本地端口,并提供 server.URL;被测客户端只需把基础地址指向这个 URL,就能走真实的 net/http 传输链路,同时避免依赖外部网络。

HTTP Client 与 httptest.Server 的测试时序

这类测试的关键是让服务端“既返回结果,也检查请求”。这样一次测试同时覆盖客户端的请求构造与响应处理,而不是只验证其中一半。

编写可控制成功与失败的服务端

下面的测试文件包含一个最小 APIClient。测试服务器根据路径返回成功数据或 503,并在收到请求时检查方法和 Accept 请求头。

go
package httpdemo

import (
	"encoding/json"
	"fmt"
	"net/http"
	"net/http/httptest"
	"testing"
)

type User struct {
	ID   int    `json:"id"`
	Name string `json:"name"`
}

type APIClient struct {
	BaseURL string
	Client  *http.Client
}

func (c *APIClient) GetUser(id int) (User, error) {
	req, err := http.NewRequest(
		http.MethodGet,
		fmt.Sprintf("%s/users/%d", c.BaseURL, id),
		nil,
	)
	if err != nil {
		return User{}, err
	}
	req.Header.Set("Accept", "application/json")

	resp, err := c.Client.Do(req)
	if err != nil {
		return User{}, err
	}
	defer resp.Body.Close()

	if resp.StatusCode != http.StatusOK {
		return User{}, fmt.Errorf("unexpected status: %s", resp.Status)
	}

	var user User
	if err := json.NewDecoder(resp.Body).Decode(&user); err != nil {
		return User{}, err
	}
	return user, nil
}

func TestAPIClientGetUser(t *testing.T) {
	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		if r.Method != http.MethodGet {
			t.Errorf("method = %s, want GET", r.Method)
		}
		if r.Header.Get("Accept") != "application/json" {
			t.Errorf("Accept = %q, want application/json", r.Header.Get("Accept"))
		}

		switch r.URL.Path {
		case "/users/42":
			w.Header().Set("Content-Type", "application/json")
			_, _ = w.Write([]byte(`{"id":42,"name":"Ada"}`))
		case "/users/500":
			http.Error(w, "temporarily unavailable", http.StatusServiceUnavailable)
		default:
			http.NotFound(w, r)
		}
	}))
	defer server.Close()

	client := &APIClient{
		BaseURL: server.URL,
		Client:  server.Client(),
	}

	t.Run("success", func(t *testing.T) {
		user, err := client.GetUser(42)
		if err != nil {
			t.Fatal(err)
		}
		if user != (User{ID: 42, Name: "Ada"}) {
			t.Fatalf("user = %+v", user)
		}
	})

	t.Run("non-2xx", func(t *testing.T) {
		_, err := client.GetUser(500)
		if err == nil {
			t.Fatal("expected error for 503 response")
		}
	})
}

预期结果:success 分支能够解码用户数据,non-2xx 分支能够把 503 Service Unavailable 转换为错误;服务端对方法或请求头的检查若失败,测试也会失败。

运行测试:

bash
go test -run TestAPIClientGetUser -v

预期输出:

text
=== RUN   TestAPIClientGetUser
=== RUN   TestAPIClientGetUser/success
=== RUN   TestAPIClientGetUser/non-2xx
--- PASS: TestAPIClientGetUser (<TIME>)
    --- PASS: TestAPIClientGetUser/success (<TIME>)
    --- PASS: TestAPIClientGetUser/non-2xx (<TIME>)
PASS
ok   <MODULE_PATH>   <TIME>

httptest.Server 使用随机端口,因此不要在断言中写死 localhost:<PORT>。始终把 server.URL 注入被测客户端,实际端口由测试框架管理。

让异常分支保持可控

客户端测试最容易变脆的做法,是访问真实第三方接口后等待它“刚好失败”。测试服务器应该明确制造所需条件,例如返回 401、429、503、无效 JSON 或延迟响应。每个分支只测试当前客户端承诺处理的行为,不必模拟整个远端系统。

如果客户端配置了超时或上下文取消,还可以让 Handler 延迟响应,再验证 context deadline exceeded 一类错误;但这属于超时策略的专门测试,不应和普通成功路径挤在同一个主示例里。

选择 NewServer 还是 NewTLSServer

普通 HTTP 行为使用 httptest.NewServer 即可。只有被测逻辑依赖 HTTPS、证书或 TLS 配置时,才使用 httptest.NewTLSServer,并使用测试服务器提供的客户端或显式配置受信任证书。

httptest.Server 的价值不在于“模拟得像生产”,而在于把外部依赖收进测试进程:请求可检查、响应可控制、失败可重复。这样可以稳定验证 HTTP Client 的对外契约,同时把第三方服务波动从单元测试中剥离。

按自己的节奏,确认真正理解。

目录与阅读设置

记录一个想法

测试 HTTP Client

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通