原文: Best Practices for Scaling Your Node.js REST APIs
除了使用集群模式,还有各种各样扩展API的方式。在这篇教程中,我们将学习10种扩展Node.js API的方式。
我们经常会在处理项目的时候获取一些零散的知识以提高技能,必须通过不断地复习,才能将习得的技能应用到下次项目中。
这个方法一直奏效吗?我甚至不记得我昨天做了些什么。所以我写下了这篇教程,也是对自己知识的复盘。
我尝试记录下这些不常被提起扩展Node.js的方法。
本文提及的方法不一定是你最后的救命稻草,你可以在Node.js项目的任何阶段应用这些方法。
让我们来看看本文的内容:
- 🚦使用节流
- 🐢 优化数据库查询
- ䷪ 使用断路器快速故障
- 🔍 记录检查点
- 🌠 使用Kafka而非HTTP请求
- 🪝 小心内存泄露
- 🐇 使用缓存
- 🎏 使用连接池
- 🕋 无缝扩展
- 💎 OpenAPI兼容文档
使用节流
节流可以限制对服务器的访问,以防止请求过量。使用节流的好处非常明显:可以保护应用免受大量用户爆发的困扰,也可以防止拒绝服务攻击(Dos攻击)。
输入和输出的速率不匹配的时候,通常是应用节流机制的时候。特别是当入站流量远超过服务器可以(或者希望)处理的流量。
让我们通过图像来理解:
在应用程序和新闻推送服务器之间的第一个节点应用了节流:
- 新闻推送服务(NFS)订阅了你的应用以发送通知。
- 每秒向你的应用发送1000个请求。
- 根据NFS的订阅计费计划,你的应用仅处理500个请求/秒。
- 为前500个请求发送通知。
必须要注意的是,所有超过500个请求/秒以外的请求都会失败,需要NFS再次尝试发送请求。
当可以排队的时候,为什么要拒绝额外的请求? 有以下理由:
- 接受所有请求会使应用开始累积请求,这可能导致所有订阅你的应用的客户端出现单点故障(通过RAM/磁盘耗尽),包括NFS。
- 你不应该接受超出客户订阅计划范围的请求(在我们的例子中是NFS)。
对于应用程序级别的速率限制,你可以使用Express.js API的中间件——express-rate-limit。对于网络级别的节流,你可以使用类似WAF的解决方案。
如果你使用的是发布-订阅机制,也可以限制消费者和订阅者。例如,你可以通过设置maxBytes选项来限制消费Kafka标签(topic)的字节数据。
优化数据库查询
有时你可能没有缓存数据,或者数据已经过期,查询数据成了唯一的选择。
发生这种情况时,请确保你的数据库做好了准备:第一步是拥有足够的RAM和磁盘IOPS(每秒输入输出量)。
其次,尽可能优化你的查询。对于初学者来说,做对这几件事很关键:
- 查询时尽量使用索引字段,但不要过度索引。索引也有开销。
- 对于删除,坚持软删除。如果需要永久删除,请推迟。(一个有趣的故事)
- 在读取数据的时候,仅使用投影(projection)获取需要的字段。如果可以的话,去掉没有必要的元数据和方法。(例如,Mongoose提供lean)。
- 尝试将数据库性能和用户体验分离。如果数据库上的CRUD可以在后台发生(即非阻塞),请执行此操作。不要让用户等待。
- 使用更新查询直接更新所需字段。不要获取文档,更新字段,然后将整个文档保存回数据库。这会造成网络和数据库开销。
使用断路器快速故障
想象一下,你的Node.js应用程序出现突发流量,并且满足请求所需的外部服务器之一已关闭。你是否想在此后的每个请求中一直走死胡同?当然不!我们不想在注定要失败的请求上浪费时间和资源。
这就是使用断路器的核心思想:尽早失败、快速失败。
例如,如果100个请求中有50个失败,则在接下来的X秒内不允许对该外部服务器发出任何请求。它可以防止触发必然会失败的请求。
一旦线路复位,就允许请求通过。如果它们再次失败,则线路断开并重复循环。
可以查看Opposum以了解更多添加断路器的信息。你也可以在这里阅读更多关断路器的信息。
记录检查点
良好的日志记录设置可以帮助你快速发现错误。你可以创建可视化日志来了解应用程序的行为、设置警报和有效地调试。
你可以使用ELK stack来设置良好的日志记录和警报管道。
虽然日志记录是必不可少的工具,但很容易过度使用。如果记录所有内容,最终可能会耗尽磁盘IOPS,从而导致你的应用程序受到影响。
一个值得借鉴的经验是只记录检查点。
检查点可以是:
- 当进入应用程序中的主控制流时以及在它们经过验证和清理之后的请求
- 与外部服务/SDK/API交互时的请求和响应。
- 对该请求的最终响应。
- 为catch处理程序提供有用的错误消息(错误消息具有合理的默认值)。
另外: 如果一个请求在生命周期中经过多个服务器,你可以在日志中传递一个唯一ID,以跨服务器捕获特定请求。
使用Kafka而非HTTP请求
虽然存在HTTP请求的用例,但容易使用过度,请在不必要的时候避免使用HTTP请求。
让我们通过这个例子来理解:
假设我们要创建一个如Amazon一样的产品,这个产品包含两大服务:
- 供应商服务
- 库存服务
每当你收到来自供应商服务的新库存,就推送一个库存详情到Kafka标签。库存服务监听到这个标签,并且更新数据库以确认有新的补货。
请注意,你将库存数据推送到管道(pipeline)然后程序流,就可以继续其他的操作。程序会自动按照一定节奏消费库存服务。Kafka使服务解耦。
现在,如果你的库存服务出现了故障怎么办?如果是用HTTP请求就不容易处理。但如果使用Kafka,就可以重播预期的消息(例如使用kcat)。使用Kafka的话,数据被消费后不会丢失。
当某个商品重新回到库存,你可能希望向愿望清单包含这个商品的顾客推送消息。要实现这个功能,可以让通知服务和库存服务监听同样的标签。通过这种方式,就可以实现在不同的地方使用单个消息总线,并没有HTTP开销。
KafkaJS的开始页面分享了从Node.js应用的基础设置到上述功能的代码片段,我强烈推荐你查看,有很多内容值得研究。
小心内存泄露
如果你不编写保护内存安全的代码,并且不经常分析你的应用,很有可能造成服务器崩溃。
你可不希望自己的分析结果如下:
对于初学者,我建议:
- 使用
--inspect
标志来执行 Node.js API。 - 在Chrome浏览器打开
chrome://inspect/#devices
。 - 点击 inspect >
Memory
tab >Allocation instrumentation on timeline
。 - 在执行一些应用功能。可以使用macOS的apache bench来同时发出多个请求,在终端执行
curl cheat.sh/ab
查看怎么使用apache bench。 - 停止记录并分析内存保持器。
如果发现任何大块的保留内存,请尝试将其最小化。这个话题相关的资源很多,你可以从谷歌搜索“如何防止 Node.js 中的内存泄漏”开始探索。
分析你的 Node.js 应用程序并寻找内存使用模式应该是常规做法。让我们把“分析驱动重构”(PDR)提上日程?
使用缓存避免过多的数据库查找
这么做的目的是不要每一次应用发出请求都连接一次数据库,使用缓存存储结果可以减少数据库的负载,提高应用性能。
有两种使用缓存的策略。
通过缓存写入可确保在发生写入操作时将数据插入数据库和缓存中。这可以使缓存保持相关,并带来更好的性能。缺点是因为不经常使用的数据也被存储到缓存中,所以缓存开销昂贵。
而在延迟加载中,数据仅在第一次读取时才写入缓存。第一次请求提供来自数据库的数据,但随后的请求使用缓存。它具有较小的成本,但增加了第一次请求的响应时间。
要决定缓存数据的TTL(或生存时间),请问自己:
- 基础数据要多久更改一次?
- 将过期数据返回给最终用户的风险是什么?
在允许的情况下,更长的TTL意味着更好的应用表现。
重要的是,为你的TTL添加一点增量。如果应用程序一时间收到大量流量,并且你的所有缓存数据立即过期,则可能导致数据库无法承受负载,从而影响用户体验。
最终TTL = TTL预估值 + 一点随机增量
TTL的计算
有许多缓存逐出的策略,保留默认值是一种有效且可接受的方法。
使用连接池
打开一个与数据库的独立连接开销很高。它涉及TCP握手、SSL、身份验证和授权检查等。
你可以利用连接池来取代独立连接。
一个连接池在任何给定时间都拥有多个连接。每当需要它时,池管理器都会分配任何可用/空闲连接。你可以跳过建立全新连接的冷启动阶段。
那么,为什么不最大化池中的连接数呢?因为它高度依赖于硬件资源。如果忽略这一点,可能会造成巨大的性能损失。
连接越多,每个连接的RAM越少,利用RAM的查询越慢(例如排序)。同样的原则也适用于磁盘和CPU。每个新连接都将被分配到资源。
你可以根据自己的需求调节连接数,对于初学者来说你可以在这里评估连接池的大小。
你可以在这里阅读连接池相关的内容。若你使用的是PostgreSQL,你可以使用node-postgres
包。这是一个连接池的内置支持。
无缝扩展
当应用程序的用户群逐渐增长并且已经达到垂直扩展的上限时,你会怎么做?水平缩放。
垂直扩展意味着增加节点(CPU、内存等)资源,而水平扩展意味着增加更多的节点以平衡每个节点的负载。
如果你使用的是AWS,则可以利用自动扩展组(ASG),它根据预定义的规则(例如,当CPU利用率超过50% 时水平扩展服务器数量。
你可以通过提前规划行为来提前规划扩展和缩小的计划,以此来应对可以遇见的流量模式(如在世界杯期间的流媒体服务)。
准备好ASG后,在最前面添加负载均衡器将确保流量根据所选策略路由到所有实例(如round robin)。
PS: 预估单个服务器可以处理的请求(CPU、内存、磁盘等)并分配至少 30%以上的容量总不会错。
OpenAPI兼容文档
它可能不会直接影响扩展Node.js应用程序的能力,但我必须将其包含在列表中。如果你曾经做过API集成,你就知道为什么了。
在向前迈出一步之前,了解有关 API 的所有信息至关重要。它使设计的集成、迭代和推理变得容易,更不用说对开发速度的帮助。
确保为你的 Node.js API 创建 OpenAPI 规范(OAS)。
这使得你以行业标准的方式创建 API 文档。OAS充当单一的事实来源。如果定义得当,它会使与 API 的交互更加高效。
我在这里创建了一个API文档样本,你可以使用swagger inspector来监测任意API。
你可以在Swagger Hub dashboard找到所有API文档,以及创建一个新的文档。
行动起来吧!
我们研究了十个鲜为人知的扩展Node.js的最佳实践,以及如何开启每一个最佳时间。
现在轮到你对照这个清单并探索发现你的Node.js应用程序缺少了什么。
获取你的检查清单✨
希望这篇文章对你有所帮助,并在可扩展性方面为你提供了一些指导。这并不是所有最佳实践的详尽清单——我只是列出了这些我认为不常被提及的。
欢迎在Twitter上联系我。我很乐意听取你在使用其他最佳实践的经历和心得。
喜欢这篇文章吗?在这里获取更多后端提升小建议 💌。