目录
为什么选择用 Chi ,而不是用标准库或者 Gin 或者 router-x 进行路由?
让我们开始吧
上面的代码是一些最佳实践的重点
接下来我们构建一个 todo 包,它实际上保存了我们 todo 逻辑。
注意事项
首页 后端开发 Golang 优雅的实现 Golang REST API 架构

优雅的实现 Golang REST API 架构

Jun 17, 2020 pm 05:48 PM
go golang

优雅的实现 Golang REST API 架构

有一种说法,golang 编写的 API 不能像其他语言那样简单和通用。但实际上,我遇到很多 REST API 的代码,非常多的抽象,使得代码库变得混乱和复杂,最终伤害了可读性和可维护性。

这一系列,我们将通过如何建立一个产品级的 REST API TODO 列表,一个可持续扩展架构,从路由和代码接口开始,然后添加一个 mongo 的数据库和一个 badger 数据层,然后是授权协议层(OAuth 2.0)

在这一系列中我们将使用 chi 路由。

file

为什么选择用 Chi ,而不是用标准库或者 Gin 或者 router-x 进行路由?

嗯,其实选择用什么并不重要。无论你使用什么来进行路由,本系列中讨论的概念都将是有用的。但是有下面的这些优点可以让我认为 Chi-router 比大多数替代方案更优越:

  • net/http 标准库 100% 兼容---可以在 Go 生态系统中使用任何与net / http 兼容的 http 或中间件 pkg

  • 专为模块化/可组合 API 设计 - 中间件,内联中间件,路由组和子路由器安装

  • 没有外部依赖---纯粹的就是 Go 1.7+ stdlib + net / http

  • 强悍 --- 有很多公司正在使用,比如:Pressly,CloudFlare,Heroku,99Designs

  • 轻量级 --- cloc'd in ~1000 LOC for the chi router

  • 速度很快

我最喜欢的是,你为其他 net / http 兼容路由器编写的旧的 http 处理程序和中间件也可以在正常运行。

让我们开始吧

首先,我们创建一个 main.go 。我们程序的基础(或者说中心元件 ?)

file

上面的代码是一些最佳实践的重点

  1. 用一个单独的包来实现路由的逻辑,并将它们分好组,然后安装(mount) 它们:

r.Mount("/api/todo", todo.Routes())

  1. 给 API 打上版本,这样你就可以对 api 进行更新时,不会破坏旧的客户端:

router.Route("/v1", ....)

  1. 使用中间件作为扩展。使用了非常多路由的代码是非常笨重的,其实可以变成链接的中间件,像:授权,设置响应头部,压缩,请求日志,限速等。

笔者(基于 Ajinkya 在评论中提到的问题,我会更多的阐述 walk 方法):

chi 路由有一个方法叫做 walk。这个方法接收的参数:

  • A router

  • A callback.

每个被定义的路由都会被回调,并且接收 4 个参数:

  • 路由定义的方法

  • 实际路由的字符串

  • 处理器(函数),处理给定路由的请求

  • 给定路由中,定义过的中间件列表(中间件是一个比较简单的函数,它会在处理器被调用前调用,所以它们才会被使用在请求处理之前,授权等)

以我为例,我将简单地轮询路由并且打印所有被定义的路由。从而让我对所有可用的路由一目了然。

接下来我们构建一个 todo 包,它实际上保存了我们 todo 逻辑。

file

注意事项

  • todo 包有一个返回所有路由的方法。这些路由都是写在 main.go 文件中。 实际上我通常会把这些路由写在一个叫 routes.go 的文件中, 这样会很容易在包里找到.

  • 处理程序具有 func (w http.ResponseWriter,r *http.Request)  的函数签名,这意味着这处理程序和你使用标准库的 net/http 写法没有不同。

  • 使用 render.JSON,一个 encoding/json 的封装, 它会自动转义你 JSON 响应中所有的 html,并设置 content-type 为 application/json

你被它有多简单吓到了吗?可以在 GitHub 上查看这个项目 https://github.com/tonyalaribe/todoapi/tre....

在我们本系列的下篇文章中, 我们会继续对配置和共享状态的支持。 大多数项目通常都需要额外的配置,例如数据库连接,等等。 我们将会在下篇文章里讨论这个。

推荐教程:《Go教程

以上是优雅的实现 Golang REST API 架构的详细内容。更多信息请关注PHP中文网其他相关文章!

本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热AI工具

Undress AI Tool

Undress AI Tool

免费脱衣服图片

Undresser.AI Undress

Undresser.AI Undress

人工智能驱动的应用程序,用于创建逼真的裸体照片

AI Clothes Remover

AI Clothes Remover

用于从照片中去除衣服的在线人工智能工具。

Clothoff.io

Clothoff.io

AI脱衣机

Video Face Swap

Video Face Swap

使用我们完全免费的人工智能换脸工具轻松在任何视频中换脸!

热工具

记事本++7.3.1

记事本++7.3.1

好用且免费的代码编辑器

SublimeText3汉化版

SublimeText3汉化版

中文版,非常好用

禅工作室 13.0.1

禅工作室 13.0.1

功能强大的PHP集成开发环境

Dreamweaver CS6

Dreamweaver CS6

视觉化网页开发工具

SublimeText3 Mac版

SublimeText3 Mac版

神级代码编辑软件(SublimeText3)

热门话题

PHP教程
1596
276
您如何与Golang的环境变量合作? 您如何与Golang的环境变量合作? Aug 19, 2025 pm 02:06 PM

Goprovidesbuilt-insupportforhandlingenvironmentvariablesviatheospackage,enablingdeveloperstoread,set,andmanageenvironmentdatasecurelyandefficiently.Toreadavariable,useos.Getenv("KEY"),whichreturnsanemptystringifthekeyisnotset,orcombineos.Lo

如何在GO中实现通用LRU缓存 如何在GO中实现通用LRU缓存 Aug 18, 2025 am 08:31 AM

使用Go泛型和container/list可实现线程安全的LRU缓存;2.核心组件包括map、双向链表和互斥锁;3.Get和Add操作均通过锁保证并发安全,时间复杂度为O(1);4.当缓存满时自动淘汰最久未使用的条目;5.示例中容量为3的缓存添加4个元素后成功淘汰最久未使用的"b"。该实现完整支持泛型、高效且可扩展。

您如何在Golang中实现观察者模式? 您如何在Golang中实现观察者模式? Aug 14, 2025 pm 12:04 PM

在Go中可以通过接口和通道实现观察者模式,定义Observer接口包含Update方法,Subject结构体维护观察者列表和消息通道,通过Attach添加观察者,Notify发送消息,listengoroutine异步广播更新,具体观察者如EmailService和LogService实现Update方法处理通知,主程序注册观察者并触发事件,实现松耦合的事件通知机制,适用于事件驱动系统、日志记录和消息通知等场景。

您如何定义并在GO中调用功能? 您如何定义并在GO中调用功能? Aug 14, 2025 pm 06:22 PM

在Go中,定义和调用函数使用func关键字并遵循固定语法,首先明确答案:函数定义需包含名称、参数类型、返回类型及函数体,调用时传入对应参数即可;1.定义函数时使用funcfunctionName(params)returnType{}语法,如funcadd(a,bint)int{returna b};2.支持多返回值,如funcdivide(a,bfloat64)(float64,bool){};3.调用函数直接使用函数名加括号传参,如result:=add(3,5);4.多返回值可用变量接收或

绩效比较:Java vs.去后端服务 绩效比较:Java vs.去后端服务 Aug 14, 2025 pm 03:32 PM

GoTypeDeptersbetterruntimePerformanceWithHigherThrougherTuptuptudandlaterLatency,尤其是Fori/O-HevyServices,DuetoItslightWeightGoroutGoroutineSandefficientsCheduler,wherjava,whilejava,themlowertostart,bylowertostart,themlowertostart,canmatchgoincpuindtaskspu-boundtasksafterjitoptoptimization.2.gous.2.gous.2.gous.2.gous.2.gous.2.2.gome

在GO应用中解析RSS和原子供稿 在GO应用中解析RSS和原子供稿 Aug 18, 2025 am 02:40 AM

使用gofeed库可以轻松解析RSS和Atomfeed,首先通过gogetgithub.com/mmcdole/gofeed安装库,然后创建Parser实例并调用ParseURL或ParseString方法解析远程或本地feed,库会自动识别格式并返回统一的Feed结构体,接着遍历feed.Items获取标题、链接、发布时间等标准化字段,同时建议设置HTTP客户端超时、处理解析错误并利用缓存优化性能,最终实现简单、高效、可靠的feed解析。

如何使用构建区块链应用 如何使用构建区块链应用 Aug 17, 2025 am 03:04 AM

要开始使用Go语言构建区块链应用,首先需掌握区块链核心概念,1.理解区块、哈希、不可变性、共识机制、P2P网络和数字签名;2.安装Go并初始化项目,使用Go模块管理依赖;3.通过定义区块结构、实现SHA-256哈希、创建区块链切片、生成新区块和验证逻辑来构建简易区块链以学习原理;4.在实际开发中使用CosmosSDK、TendermintCore、Go-Ethereum或Badger等成熟框架和库避免重复造轮子;5.利用Go的goroutine和net/http或gorilla/websocke

如何使用Apache Kafka 如何使用Apache Kafka Aug 20, 2025 am 11:25 AM

使用Go与ApacheKafka集成的关键是选择合适的客户端库并正确配置生产者和消费者。首先推荐使用segmentio/kafka-go库,因其简洁且符合Go语言习惯,通过gogetgithub.com/segmentio/kafka-go安装后,可创建Writer发送消息,设置Addr、Topic和Balancer策略;接着配置Reader通过指定Brokers、Topic和GroupID实现消息消费,支持消费者组和手动分区分配;务必使用context控制超时,启用TLS/SASL保障安全,合

See all articles