0

0

如何使用Golang测试RESTful接口_Golang net/http与httptest方法

P粉602998670

P粉602998670

发布时间:2026-01-30 11:18:09

|

176人浏览过

|

来源于php中文网

原创

httptest.NewServer 用于集成测试真实HTTP服务,启动本地临时服务并返回可请求的 *httptest.Server 实例;httptest.NewRecorder 用于单元测试单个 handler,绕过网络栈直接捕获响应细节。

如何使用golang测试restful接口_golang net/http与httptest方法

httptest.NewServer 启动真实 HTTP 服务做集成测试

当你要验证接口行为是否符合外部调用预期(比如 JSON 结构、状态码、Header),而不是只测 handler 内部逻辑时,httptest.NewServer 更贴近真实场景。它会启动一个监听本地端口的临时 HTTP 服务,返回可直接请求的 *httptest.Server 实例。

常见错误是误用 httptest.NewRecorder 去模拟整个服务调用链——它不走网络层,无法测试中间件、路由匹配失败、重定向、TLS 配置等。

  • 必须手动调用 server.Close(),否则端口不释放,连续测试会报 address already in use
  • URL 是动态生成的(如 http://127.0.0.1:34212),不能硬编码;应通过 server.URL 拼接路径
  • 默认不启用 HTTPS,若测试中依赖 req.TLS 或强制跳转,需额外配置 httptest.NewUnstartedServer + 手动启动 TLS listener
func TestAPIWithRealServer(t *testing.T) {
    server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        if r.Method != "GET" || r.URL.Path != "/users" {
            http.Error(w, "not found", http.StatusNotFound)
            return
        }
        json.NewEncoder(w).Encode([]map[string]string{{"name": "alice"}})
    }))
    defer server.Close() // 必须 defer
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)
}

}

NatAgent
NatAgent

AI数据情报监测与分析平台

下载

httptest.NewRecorder 测试单个 handler 的响应细节

这是最轻量、最快的方式,适合单元测试:绕过网络,把请求直接“注入”到 handler,捕获其对 http.ResponseWriter 的所有写入(状态码、Header、Body)。

立即学习go语言免费学习笔记(深入)”;

注意它不会执行路由匹配,也不会触发 http.ServeMux 的路径前缀处理,所以传入的 *http.Request 必须手动构造好 URL.PathMethod

  • req := httptest.NewRequest("POST", "/login", strings.NewReader(`{"user":"a"}`)) 中,路径和方法必须与 handler 实际期望的一致
  • 若 handler 依赖 context.WithValue 注入的数据(如用户 ID、trace ID),需在 request 上显式设置:req = req.WithContext(context.WithValue(req.Context(), key, value))
  • Body 是 io.ReadCloser,若多次读取(如解析两次 JSON),需用 req.Body = ioutil.NopCloser(bytes.NewReader(buf)) 重置
func TestLoginHandler(t *testing.T) {
    req := httptest.NewRequest("POST", "/login", strings.NewReader(`{"username":"test","password":"123"}`))
    req.Header.Set("Content-Type", "application/json")
rr := httptest.NewRecorder()
handler := http.HandlerFunc(loginHandler)
handler.ServeHTTP(rr, req)

if status := rr.Code; status != http.StatusOK {
    t.Errorf("handler returned wrong status code: got %v want %v",
        status, http.StatusOK)
}

var res map[string]string
if err := json.Unmarshal(rr.Body.Bytes(), &res); err != nil {
    t.Fatal(err)
}
if res["token"] == "" {
    t.Error("expected non-empty token")
}

}

测试带中间件的 handler 链(如 JWT 校验、日志)

中间件本质是包装 handler 的函数,测试时只需把最终组合后的 handler 传给 httptest.NewRecorder,不需要 mock 中间件本身。

容易忽略的是中间件可能修改 request context 或写入 Header,这些都会反映在 Recorder 中,但不会自动触发 panic 捕获或 panic recovery 行为——如果中间件里有 panic,测试会直接失败。

  • 若中间件依赖全局变量(如数据库连接池),测试前需确保已初始化,或用接口抽象后注入 mock
  • 测试 401/403 等拒绝响应时,检查 rr.Coderr.Body.String() 是否符合预期,不要只看状态码
  • 避免在中间件里调用 log.Fatalos.Exit,这会让测试进程退出
func TestAuthMiddleware(t *testing.T) {
    // 构造带无效 token 的请求
    req := httptest.NewRequest("GET", "/admin", nil)
    req.Header.Set("Authorization", "Bearer invalid-token")
rr := httptest.NewRecorder()
// authMiddleware(justHandler) 是完整链
authMiddleware(justHandler).ServeHTTP(rr, req)

if rr.Code != http.StatusUnauthorized {
    t.Errorf("expected 401, got %d", rr.Code)
}
if !strings.Contains(rr.Body.String(), "invalid token") {
    t.Error("response body missing expected error message")
}

}

测试超时、重定向、客户端错误等边界情况

真实客户端行为(如取消请求、发送畸形 Body、不带必要 Header)很难靠单个 httptest.NewRequest 覆盖全。这时要分两层验证:

一是 handler 层:用 NewRequest 构造非法输入,确认它返回 400/415 等合理状态;二是服务层:用 NewServer 配合自定义 http.Client 控制超时、禁用重定向等。

  • 测试超时:创建 client 设置 Timeout: 1 * time.Millisecond,再发请求,检查是否返回 context.DeadlineExceeded
  • 测试重定向:client 默认跟随重定向,要测试原始 302 响应,需设 CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse }
  • 测试空 Body 或非 JSON:用 strings.NewReader("")strings.NewReader("garbage"),验证 handler 是否正确返回 400

复杂点在于:有些错误发生在 net/http 底层(如 TLS 握手失败、DNS 解析超时),httptest 不模拟这些,只能靠集成测试加真实 stub 服务(如 gock)或跳过。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

182

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

229

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

343

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

210

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

396

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

240

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

194

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

458

2025.06.17

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

0

2026.01.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.6万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号