如何构建一个优雅的 Golang REST API 架构?

file

有一种说法,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 个参数:

  1. 路由定义的方法
  2. 实际路由的字符串
  3. 处理器(函数),处理给定路由的请求
  4. 给定路由中,定义过的中间件列表(中间件是一个比较简单的函数,它会在处理器被调用前调用,所以它们才会被使用在请求处理之前,授权等)

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

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

file

注意事项

  1. todo 包有一个返回所有路由的方法。这些路由都是写在 main.go 文件中。 实际上我通常会把这些路由写在一个叫 routes.go 的文件中, 这样会很容易在包里找到.
  2. 处理程序具有 func (w http.ResponseWriter,r *http.Request)  的函数签名,这意味着这处理程序和你使用标准库的 net/http 写法没有不同。
  3. 使用 render.JSON,一个 encoding/json 的封装, 它会自动转义你 JSON 响应中所有的 html,并设置 content-type 为 application/json

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

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

本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://itnext.io/structuring-a-producti...

译文地址:https://learnku.com/go/t/23397

本文为协同翻译文章,如您发现瑕疵请点击「改进」按钮提交优化建议
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!