Go httptest.Server 入门:给 HTTP 客户端写可信测试

用外部用户服务客户端示例讲 httptest.Server 的基本用法,覆盖成功响应、错误状态、超时和请求头断言。

很多 Go 初学者会给 HTTP handler 写测试,却不知道怎么给 HTTP 客户端写测试。比如你的服务要调用一个用户中心接口,代码里有 http.Client、URL、请求头和 JSON 解码。测试时不可能真的去调用线上用户中心,也不应该为了单元测试启动一整套依赖。标准库里的 net/http/httptest 提供了一个很实用的工具:httptest.Server

httptest.Server 会在本地启动一个真实 HTTP 服务,分配一个临时端口,并给你一个 URL。客户端代码像调用外部服务一样调用它,但一切都在测试进程里完成。这样测试既接近真实 HTTP 行为,又足够快、足够可控。

先写一个客户端

假设我们有一个用户资料接口:

type Profile struct {
	ID    string `json:"id"`
	Name  string `json:"name"`
	Email string `json:"email"`
}

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

func (c *ProfileClient) Get(ctx context.Context, id string) (Profile, error) {
	client := c.Client
	if client == nil {
		client = http.DefaultClient
	}

	u := strings.TrimRight(c.BaseURL, "/") + "/profiles/" + url.PathEscape(id)
	req, err := http.NewRequestWithContext(ctx, http.MethodGet, u, nil)
	if err != nil {
		return Profile{}, err
	}
	req.Header.Set("Accept", "application/json")

	resp, err := client.Do(req)
	if err != nil {
		return Profile{}, err
	}
	defer resp.Body.Close()

	if resp.StatusCode != http.StatusOK {
		return Profile{}, fmt.Errorf("profile status: %d", resp.StatusCode)
	}
	var profile Profile
	if err := json.NewDecoder(resp.Body).Decode(&profile); err != nil {
		return Profile{}, fmt.Errorf("decode profile: %w", err)
	}
	return profile, nil
}

这个客户端有几个可测试点:URL 是否拼对,请求方法是否正确,是否带了 Accept 头,非 200 是否返回错误,JSON 是否能解码。

成功路径测试

httptest.NewServer

func TestProfileClientGet(t *testing.T) {
	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		if r.Method != http.MethodGet {
			t.Fatalf("method = %s", r.Method)
		}
		if r.URL.Path != "/profiles/u-1" {
			t.Fatalf("path = %s", r.URL.Path)
		}
		if r.Header.Get("Accept") != "application/json" {
			t.Fatalf("Accept = %q", r.Header.Get("Accept"))
		}
		w.Header().Set("Content-Type", "application/json")
		fmt.Fprint(w, `{"id":"u-1","name":"Alice","email":"a@example.com"}`)
	}))
	defer server.Close()

	client := &ProfileClient{BaseURL: server.URL, Client: server.Client()}
	got, err := client.Get(context.Background(), "u-1")
	if err != nil {
		t.Fatal(err)
	}
	if got.Name != "Alice" {
		t.Fatalf("name = %q", got.Name)
	}
}

server.Client() 返回一个适合访问这个测试服务器的 client。对于普通 HTTP 服务,用 http.DefaultClient 也能访问;使用 server.Client() 是个好习惯,尤其是测试 HTTPS server 时更方便。

测试错误状态

外部服务不可能永远返回 200。测试 500:

func TestProfileClientGetStatusError(t *testing.T) {
	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		http.Error(w, "boom", http.StatusInternalServerError)
	}))
	defer server.Close()

	client := &ProfileClient{BaseURL: server.URL, Client: server.Client()}
	_, err := client.Get(context.Background(), "u-1")
	if err == nil {
		t.Fatal("expected error")
	}
	if !strings.Contains(err.Error(), "500") {
		t.Fatalf("error = %v", err)
	}
}

不要只测成功路径。HTTP 客户端的大部分坑都在错误响应、超时、坏 JSON 和连接失败里。

测试坏 JSON

func TestProfileClientGetBadJSON(t *testing.T) {
	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		w.Header().Set("Content-Type", "application/json")
		fmt.Fprint(w, `{"id":`)
	}))
	defer server.Close()

	client := &ProfileClient{BaseURL: server.URL, Client: server.Client()}
	_, err := client.Get(context.Background(), "u-1")
	if err == nil {
		t.Fatal("expected decode error")
	}
}

这个测试能确保解码失败不会被当成空对象返回。很多线上问题就是外部接口返回了 HTML 错误页,客户端却按 JSON 解,最后出现奇怪的零值。

测试超时和取消

可以让测试服务器故意慢:

func TestProfileClientGetTimeout(t *testing.T) {
	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		time.Sleep(50 * time.Millisecond)
		fmt.Fprint(w, `{}`)
	}))
	defer server.Close()

	httpClient := server.Client()
	httpClient.Timeout = 10 * time.Millisecond
	client := &ProfileClient{BaseURL: server.URL, Client: httpClient}

	_, err := client.Get(context.Background(), "u-1")
	if err == nil {
		t.Fatal("expected timeout")
	}
}

测试超时不要睡太久。几十毫秒足够表达行为,避免 CI 变慢。更复杂的超时测试可以用 channel 控制 handler 何时返回。

让客户端可配置

上面的客户端能测试,是因为 BaseURLClient 都可以注入。如果代码里写死:

http.Get("https://profile.example.com/profiles/" + id)

测试会非常难写。可测试性不是测试阶段才考虑的,它来自生产代码的边界设计。外部地址、HTTP client、超时都应该由构造函数或配置传入。

小结

httptest.Server 能让你在测试里启动一个真实 HTTP 服务,用来验证 Go HTTP 客户端的请求方法、路径、请求头、响应处理、错误状态和超时行为。它比 mock http.Client 更接近真实网络调用,又比调用外部服务稳定得多。

写客户端时,把 base URL 和 http.Client 做成可注入依赖。这样生产环境使用真实地址,测试环境使用 httptest.Server。入门阶段养成这个习惯,后面写外部 API 集成会轻松很多。

继续阅读

探索更多技术文章

浏览归档,发现更多关于系统设计、工具链和工程实践的内容。

全部文章 返回首页