0

0

如何使用Golang实现REST API接口_REST API设计与实现示例

P粉602998670

P粉602998670

发布时间:2026-01-12 17:21:10

|

880人浏览过

|

来源于php中文网

原创

net/http 可实现可维护 REST API:需封装 handler 返回 error、手动解析路径/查询参数、显式设 Content-Type 与状态码、用 TimeoutHandler 和 context 控制超时、httptest 写单元测试、配置 Server 级读写超时。

如何使用golang实现rest api接口_rest api设计与实现示例

用 net/http 实现最简 REST API 路由

Go 标准库 net/http 足够支撑轻量级 REST API,无需框架也能清晰组织。关键不是“能不能”,而是路由是否可维护、错误是否可捕获、参数是否易提取。

常见错误是直接在 http.HandleFunc 里写业务逻辑,导致无法统一处理日志、超时、CORS 或 panic 恢复。正确做法是封装 handler 函数,显式接收 *http.Requesthttp.ResponseWriter,并返回 error 统一交由中间件处理。

  • 路径参数需手动解析(如 /users/123 中的 123),http.ServeMux 不支持占位符,要用 strings.Split(r.URL.Path, "/") 或正则匹配
  • 查询参数用 r.URL.Query().Get("page"),注意空字符串和缺失键的区别
  • 请求体必须显式调用 r.Body.Close(),否则连接不会复用,高并发下会耗尽文件描述符

json.Marshal 与 Content-Type 控制响应格式

REST API 的核心契约是状态码 + JSON body + 正确的 Content-Type。Go 默认不设 header,漏掉 w.Header().Set("Content-Type", "application/json; charset=utf-8") 会导致前端解析失败或乱码。

json.Marshal 对 nil slice、nil map、time.Time 默认输出空值或 panic(如未注册 time.Time 的 JSON marshaler)。生产环境务必预判字段类型:

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

AI小聚
AI小聚

一站式多功能AIGC创作平台,支持AI绘画、AI视频、AI聊天、AI音乐

下载
type User struct {
    ID        int       `json:"id"`
    Name      string    `json:"name"`
    CreatedAt time.Time `json:"created_at"`
}

func (u User) MarshalJSON() ([]byte, error) {
    type Alias User // 防止无限递归
    return json.Marshal(&struct {
        *Alias
        CreatedAt string `json:"created_at"`
    }{
        Alias:     (*Alias)(&u),
        CreatedAt: u.CreatedAt.Format(time.RFC3339),
    })
}
  • 不要用 fmt.Println 打印响应体调试——它会干扰 http.ResponseWriter 的缓冲机制,可能触发 “http: response.WriteHeader called multiple times”
  • 400/404/500 等状态码必须显式调用 w.WriteHeader(http.StatusBadRequest),否则默认是 200
  • 对空响应(如 DELETE 成功),仍要设 Content-Type 并写空字节w.Write(nil)

用 http.TimeoutHandler 处理超时而非依赖客户端

REST API 必须主动控制执行时间,尤其涉及数据库或外部 HTTP 调用时。Go 的 http.TimeoutHandler 是唯一标准方案,它包装已有 handler,在指定时间后中断响应并返回 503。

注意它只终止 handler 执行,不自动取消下游操作(如正在跑的 SQL 查询)。若需真正中断,得配合 context.Context 传入业务层:

handler := http.TimeoutHandler(http.HandlerFunc(userHandler), 5*time.Second, "timeout\n")
http.Handle("/users", handler)

func userHandler(w http.ResponseWriter, r *http.Request) {
    ctx, cancel := context.WithTimeout(r.Context(), 3*time.Second)
    defer cancel()

    user, err := db.GetUser(ctx, userID) // 传入 ctx,让驱动可中断
    if err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }
    // ...
}
  • TimeoutHandler 的 timeout 值应略大于业务层 context.WithTimeout,避免双重超时干扰
  • 不要在 handler 内部用 time.Sleep 模拟延迟测试——它会阻塞 goroutine,而真实慢查询是 I/O 阻塞,行为不同
  • 超时响应体默认是纯文本,如需 JSON,得自己实现 wrapper 或改用第三方中间件(如 gorilla/handlers

用 go test + httptest 验证接口行为而非人工 curl

REST 接口一旦上线,修改路径、参数或状态码就是破坏性变更。单元测试必须覆盖:URL 路由是否命中、请求体能否解析、状态码是否符合预期、JSON 字段是否完整。

httptest.NewRecorder() 是关键,它模拟 http.ResponseWriter,让你断言 rec.Coderec.Body.String() 和 header,无需启动真实服务:

func TestCreateUser(t *testing.T) {
    req := httptest.NewRequest("POST", "/users", strings.NewReader(`{"name":"alice"}`))
    req.Header.Set("Content-Type", "application/json")

    w := httptest.NewRecorder()
    createUserHandler(w, req)

    if w.Code != http.StatusCreated {
        t.Fatalf("expected 201, got %d", w.Code)
    }

    var resp map[string]interface{}
    if err := json.Unmarshal(w.Body.Bytes(), &resp); err != nil {
        t.Fatal(err)
    }
    if resp["id"] == nil {
        t.Error("missing id field")
    }
}
  • 测试中不要用 http.ListenAndServe 启服务——它阻塞主线程,且端口冲突难管理
  • 对 400 错误,要测具体错误信息(如 JSON 解析失败时返回的 message),而不仅是状态码
  • 测试路由时,用 http.ServeMux 注册所有 handler 后再传给 httptest.NewServer,可验证 mux 行为
实际部署时最容易被忽略的是:没有设置 http.Server.ReadTimeoutWriteTimeout。它们控制连接层面的读写超时,和 handler 超时互补——前者防慢速攻击(slowloris),后者防业务卡死。两者缺一不可。

相关专题

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

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

178

2024.02.23

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

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

226

2024.02.23

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

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

337

2024.02.23

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

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

208

2024.03.05

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

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

388

2024.05.21

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

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

194

2025.06.09

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

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

189

2025.06.10

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

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

192

2025.06.17

Java 项目构建与依赖管理(Maven / Gradle)
Java 项目构建与依赖管理(Maven / Gradle)

本专题系统讲解 Java 项目构建与依赖管理的完整体系,重点覆盖 Maven 与 Gradle 的核心概念、项目生命周期、依赖冲突解决、多模块项目管理、构建加速与版本发布规范。通过真实项目结构示例,帮助学习者掌握 从零搭建、维护到发布 Java 工程的标准化流程,提升在实际团队开发中的工程能力与协作效率。

10

2026.01.12

热门下载

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

精品课程

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

共101课时 | 8.2万人学习

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

共39课时 | 3.1万人学习

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

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