Go 如何模拟 HTTP 请求

原创 fliyu 邂逅Go语言

这一篇，我们来学习一下如何使用 httpmock 库，当使用 Go 语言编写 HTTP 服务时，可以使用第三方库来模拟 HTTP 请求和响应，例如：httpmock 库。这个库提供了一些方便的函数和结构体，用于在测试中模拟 HTTP 请求和验证期望的 HTTP 调用。

轻松模拟来自外部资源的 http 响应。
https://github.com/jarcoal/httpmock

01 服务端

我们先使用 net/http 构建几个接口，方便我们来模拟。

package main
import (   "context"   "fmt"   "net/http")
func main() {   mux := http.NewServeMux()   mux.HandleFunc("/", index)   mux.Handle("/foo", http.HandlerFunc(foo))   mux.Handle("/bar", http.HandlerFunc(bar))
   server := http.Server{      Addr:    ":8081",      Handler: mux,   }   server.ListenAndServe()}
func index(w http.ResponseWriter, r *http.Request) {   fmt.Println("index")   w.Header().Set("Content-Type", "application/json; charset=utf-8")   w.Write([]byte(`{"name": "index"}`))}
func foo(w http.ResponseWriter, r *http.Request) {   fmt.Println("foo")   w.Header().Set("Content-Type", "application/json; charset=utf-8")   w.Write([]byte(`{"name": "foo"}`))}
func bar(w http.ResponseWriter, r *http.Request) {   fmt.Println("bar")   w.Header().Set("Content-Type", "application/json; charset=utf-8")   w.Write([]byte(`{"name": "bar"}`))}

运行完上面代码，我们实现了3个接口，分别是/，/foo，/bar ！

02 httpmock 简单示例

针对上面的接口，如果我们想用代码去访问 http 请求，可以是这样子的：

func TestHttpGet(t *testing.T) {   // 对 foo 发送GET请求   resp, err := http.Get("http://localhost:8081/foo")   if err != nil {      t.Fatalf("Failed to send GET request: %v", err)   }
   body, _ := ioutil.ReadAll(resp.Body)   resp.Body.Close()   t.Log(string(body))}

输出结果是：{"name": "foo"}。

下面，我们使用 httpmock 来模拟我们的 http 请求，让它返回我们想要的结果，请看下面示例：

package main
import (   "github.com/jarcoal/httpmock"   "io/ioutil"   "net/http"   "testing")
func TestHttpMockGetRequest(t *testing.T) {   httpmock.Activate()   defer httpmock.DeactivateAndReset()
   expectedResponse := "Hello, World!"
   httpmock.RegisterResponder("GET", "http://localhost:8081/foo",
      httpmock.NewStringResponder(200, expectedResponse))
httpmock.RegisterResponder("GET", "http://localhost:8081/bar",
      httpmock.NewStringResponder(200, expectedResponse))

   // 对 foo 发送GET请求   resp, err := http.Get("http://localhost:8081/foo")   if err != nil {      t.Fatalf("Failed to send GET request: %v", err)   }   // 验证响应   body, _ := ioutil.ReadAll(resp.Body)   resp.Body.Close()   if string(body) != expectedResponse {      t.Errorf("Unexpected response. Expected: %s, Got: %s", expectedResponse, string(body))   }
   // 对 bar 发送GET请求   resp, err = http.Get("http://localhost:8081/bar")   if err != nil {      t.Fatalf("Failed to send GET request: %v", err)   }   // 验证响应   body, _ = ioutil.ReadAll(resp.Body)   resp.Body.Close()   if string(body) != expectedResponse {      t.Errorf("Unexpected response. Expected: %s, Got: %s", expectedResponse, string(body))   }
   count := httpmock.GetTotalCallCount()   t.Log(count)}

现在，一起看解析一下上面代码的含义。

httpmock.Activate: 启动模拟环境，需要在测试运行之前调用。它将会把 http.DefaultClient 的 http.Client.Transport 字段替换为 DefaultTransport。
httpmock.DeactivateAndReset: 与 Activate 成对出现，重置所做的改变。
httpmock.RegisterResponder: 注册一个新的响应程序，该响应程序与给定的 HTTP 方法和 URL 路径关联。当收到匹配的请求参数时，将调用注册的响应程序，并将结果放回给客户端。
httpmock.GetTotalCallCount: 查看多少个用到了 httpmock 结果。

运行上面的测试用例，原先 foo 接口和 bar 接口分别返回的是 {"name": "foo"} 和 {"name": "bar"}。经过我们修改后，它们都将返回 Hello, World! 与此同时，count 的值为2。

03 httpmock 高级示例

在上面的示例中，httpmock 直接匹配的是：请求方法和URL路径。下面我们来看看 httpmock 提供的正则表达式匹配。

func TestHttpMockRegexpRequest(t *testing.T) {   httpmock.Activate()   defer httpmock.DeactivateAndReset()
   httpmock.RegisterResponder("GET", `=~^http://localhost:8081/(\w+)\z`,      func(req *http.Request) (*http.Response, error) {         name := httpmock.MustGetSubmatch(req, 1) // 1=first regexp submatch         fmt.Println(name)         return httpmock.NewJsonResponse(200, map[string]interface{}{            "name": "My name is " + name,         })      })
   resp, err := http.Get("http://localhost:8081/bar")   if err != nil {      t.Fatalf("Failed to send GET request: %v", err)   }   // 验证响应   body, _ := ioutil.ReadAll(resp.Body)   resp.Body.Close()   t.Log(string(body))}

与先前的示例不同，现在我们的 URL 是使用了正则表达式：

`=~^http://localhost:8081/(\w+)\z` 是一个正则表达式模式。让我来解释一下它的含义：

=~：这个符号表示进行正则表达式匹配操作。
^：在正则表达式中，^ 表示匹配文本的开头位置。
http://localhost:8081/：这部分匹配了固定的文本 http://localhost:8081/。
\w+：这部分匹配一个或多个单词字符。
\z：在正则表达式中，\z 表示匹配文本的结尾位置。

因此，我们输入 http://localhost:8081/bar 作为测试例子，就能够被完全匹配了，并且输出：{"name":"My name is bar"}。

04 resty 与 httpmock 结合

在日常开发中，我比较喜欢用 go-resty 库，go-resty 库是 Go 语言中一个简单的 HTTP 和 Resty 客户端库，其涵盖了比较多的功能，开箱即用，很方便。下面一起来看看如何把 resty 也使用 httpmock 请求。

首先，我们编写一段客户端代码，用于请求上面定义的接口，代码如下：

package main
import (   "context"   "fmt"   "github.com/go-resty/resty/v2")
func Request(client *resty.Client) (*Result, error) {   url := "http://localhost:8081"   result := &Result{}resp, err := client.SetTimeout(time.Second * 5).
    R().SetContext(context.Background()).SetResult(result).Get(url)
// 出现网络等请求错误   if err != nil {      return nil, err   }
   // 响应码不是 200   if resp.StatusCode() != http.StatusOK {      return nil, fmt.Errorf("status code: %d", resp.StatusCode())   }
   return result, nil}

下面我们直接看看 Request 方法的测试用例如何写：

func TestRequest(t *testing.T) {   client := resty.New()   method := "GET"   url := "http://localhost:8081"   convey.Convey("Test Request", t, func() {      // 1. 模拟出现网络错误      convey.Convey("模拟出现网络错误", func() {         httpmock.ActivateNonDefault(client.GetClient())         defer httpmock.DeactivateAndReset()
         httpmock.RegisterResponder(method, url, func(req *http.Request) (*http.Response, error) {            return nil, fmt.Errorf("network error")         })
         _, err := Request(client)         convey.So(err, convey.ShouldNotBeNil)      })
      // 2. 模拟出现500错误码      convey.Convey("模拟出现500错误码", func() {         httpmock.ActivateNonDefault(client.GetClient())         defer httpmock.DeactivateAndReset()
         httpmock.RegisterResponder(method, url, httpmock.NewStringResponder(500, ""))         _, err := Request(client)         convey.So(err, convey.ShouldNotBeNil)      })
      // 3. 模拟正常请求      convey.Convey("模拟正常请求", func() {         httpmock.ActivateNonDefault(client.GetClient())         defer httpmock.DeactivateAndReset()
         httpmock.RegisterResponder(method, url, func(req *http.Request) (*http.Response, error) {            return httpmock.NewJsonResponse(200, &Result{Name: "success"})         })         resp, err := Request(client)         convey.So(err, convey.ShouldBeNil)         convey.So(resp.Name, convey.ShouldEqual, "success")      })   })}

一个完整的测试用例就呈现了，代码的核心是：

httpmock.ActivateNonDefault(client.GetClient())

我们需要将 client 作为参数传入到 Request 方法中，才可以让 httpmock 去使用。

05 总结

httpmock 是一个用法比较简单的库，如果你平时有写测试用例，应该是会用到的啦，这篇文章分享给你，希望对你有用！

推荐阅读

欢迎关注点赞分享与收藏，一起学习进步！

专注于 Go 语言领域工作学习经验分享，期待与您一同学习进步。学的不仅是技术，更是梦想！

继续滑动看下一个