优雅的实现 Golang REST API 架构
有一种说法,golang 编写的 API 不能像其他语言那样简单和通用。但实际上,我遇到很多 REST API 的代码,非常多的抽象,使得代码库变得混乱和复杂,最终伤害了可读性和可维护性。
这一系列,我们将通过如何建立一个产品级的 REST API TODO 列表,一个可持续扩展架构,从路由和代码接口开始,然后添加一个 mongo 的数据库和一个 badger 数据层,然后是授权协议层(OAuth 2.0)
在这一系列中我们将使用 chi 路由。
为什么选择用 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 。我们程序的基础(或者说中心元件 ?)
上面的代码是一些最佳实践的重点
- 用一个单独的包来实现路由的逻辑,并将它们分好组,然后安装(mount) 它们:
r.Mount("/api/todo", todo.Routes())
- 给 API 打上版本,这样你就可以对 api 进行更新时,不会破坏旧的客户端:
router.Route("/v1", ....)
- 使用中间件作为扩展。使用了非常多路由的代码是非常笨重的,其实可以变成链接的中间件,像:授权,设置响应头部,压缩,请求日志,限速等。
笔者(基于 Ajinkya 在评论中提到的问题,我会更多的阐述 walk 方法):
chi 路由有一个方法叫做 walk。这个方法接收的参数:
A router
A callback.
每个被定义的路由都会被回调,并且接收 4 个参数:
路由定义的方法
实际路由的字符串
处理器(函数),处理给定路由的请求
给定路由中,定义过的中间件列表(中间件是一个比较简单的函数,它会在处理器被调用前调用,所以它们才会被使用在请求处理之前,授权等)
以我为例,我将简单地轮询路由并且打印所有被定义的路由。从而让我对所有可用的路由一目了然。
接下来我们构建一个 todo 包,它实际上保存了我们 todo 逻辑。
注意事项
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中文网其他相关文章!

热AI工具

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

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

Undress AI Tool
免费脱衣服图片

Clothoff.io
AI脱衣机

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

热门文章

热工具

记事本++7.3.1
好用且免费的代码编辑器

SublimeText3汉化版
中文版,非常好用

禅工作室 13.0.1
功能强大的PHP集成开发环境

Dreamweaver CS6
视觉化网页开发工具

SublimeText3 Mac版
神级代码编辑软件(SublimeText3)

热门话题

在Go中安全地读取和写入文件至关重要。指南包括:检查文件权限使用defer关闭文件验证文件路径使用上下文超时遵循这些准则可确保数据的安全性和应用程序的健壮性。

如何为Go数据库连接配置连接池?使用database/sql包中的DB类型创建数据库连接;设置MaxOpenConns以控制最大并发连接数;设置MaxIdleConns以设定最大空闲连接数;设置ConnMaxLifetime以控制连接的最大生命周期。

GoLang框架与Go框架的区别体现在内部架构和外部特性上。GoLang框架基于Go标准库,扩展其功能,而Go框架由独立库组成,实现特定目的。GoLang框架更灵活,Go框架更容易上手。GoLang框架在性能上稍有优势,Go框架的可扩展性更高。案例:gin-gonic(Go框架)用于构建RESTAPI,而Echo(GoLang框架)用于构建Web应用程序。

可以通过使用gjson库或json.Unmarshal函数将JSON数据保存到MySQL数据库中。gjson库提供了方便的方法来解析JSON字段,而json.Unmarshal函数需要一个目标类型指针来解组JSON数据。这两种方法都需要准备SQL语句和执行插入操作来将数据持久化到数据库中。

FindStringSubmatch函数可找出正则表达式匹配的第一个子字符串:该函数返回包含匹配子字符串的切片,第一个元素为整个匹配字符串,后续元素为各个子字符串。代码示例:regexp.FindStringSubmatch(text,pattern)返回匹配子字符串的切片。实战案例:可用于匹配电子邮件地址中的域名,例如:email:="user@example.com",pattern:=@([^\s]+)$获取域名match[1]。

后端学习路径:从前端转型到后端的探索之旅作为一名从前端开发转型的后端初学者,你已经有了nodejs的基础,...

Go语言中使用预定义时区包括以下步骤:导入"time"包。通过LoadLocation函数加载特定时区。在创建Time对象、解析时间字符串等操作中使用已加载的时区,进行日期和时间转换。使用不同时区的日期进行比较,以说明预定义时区功能的应用。

Go框架开发常见问题解答:框架选择:取决于应用需求和开发者偏好,如Gin(API)、Echo(可扩展)、Beego(ORM)、Iris(性能)。安装和使用:使用gomod命令安装,导入框架并使用。数据库交互:使用ORM库,如gorm,建立数据库连接和操作。身份验证和授权:使用会话管理和身份验证中间件,如gin-contrib/sessions。实战案例:使用Gin框架构建一个简单的博客API,提供POST、GET等功能。
