如何优化你的Node.jsAPI

点击上方 程序员成长指北&＃xff0c;关注公众号

回复1&＃xff0c;加入高级Node交流群

在这篇文章中&＃xff0c;我将讲解如何优化使用 Node.js 编写的 API。

前提条件

想要充分了解本文内容&＃xff0c;你必须了解以下概念&＃xff1a;

• Node.js 的设置与安装

• 如何使用 Node 创建 API

• 如何使用 Postman

• Javascript 的 async/await 工作原理

• Redis 的基础操作

API 优化到底指的是什么

优化包含了改善 API 的响应时间。响应时间越短&＃xff0c;API 的速度越快。

我将在本文分享一些技巧&＃xff0c;帮助你缩短响应时间、降低延迟、管理错误和吞吐量&＃xff0c;并且最大限度地减少 CPU 和内存的使用

如何优化 Node.js 的 API

1. 始终使用异步函数

异步函数就像 Javascript 的心脏。因此&＃xff0c;优化 CPU 使用率的最佳方法就是编写异步函数来执行非阻塞 I/O 操作。

I/O 操作包括对数据的读和写。它可以在数据库、云存储或者任何本地磁盘上进行。

在大量使用 I/O 操作的应用使用异步函数可以提高效率。因为由于没有阻塞 I/O&＃xff0c;当一个请求在做输入/输出操作的时候&＃xff0c;CPU 可以同时处理多个请求。

举例如下&＃xff1a;

var fs &＃61; require(&＃39;fs&＃39;);
// 执行阻塞I/O
var file &＃61; fs.readFileSync(&＃39;/etc/passwd&＃39;);
console.log(file);
// 执行非阻塞I/O
fs.readFile(&＃39;/etc/passwd&＃39;, function(err, file) {if (err) return err;console.log(file);
});

• 使用 Node 包 fs 来处理文件

• readFileSync() 是同步函数&＃xff0c;会在执行完成前阻塞线程

• readFile() 是异步函数&＃xff0c;会立刻返回并在后台运行

2. 避免在 API 中使用 session 和 COOKIE&＃xff0c;仅在 API 响应中发送数据

当我们使用 COOKIE 或者 session 来存储临时状态的时候&＃xff0c;会占用非常多的服务器内存。

现在通用无状态 API&＃xff0c;并且也有 JWT、OAuth 等验证机制。验证令牌保存在客户端以便服务器管理状态。

JWT 是基于 JSON 的用于 API 验证的安全令牌。JWT 可以被看到&＃xff0c;但一旦发送就无法修改。JWT 只是一个序列并没有加密。OAuth 不是 API 或服务——相反&＃xff0c;它是授权的开放标准。OAuth 是一组用于获取令牌的标准步骤。

同时&＃xff0c;也不要把时间浪费在使用 Node.js 来服务静态文件。这方面 NGINX 和 Apache 做得更好。

使用 Node 搭建 API 的时候&＃xff0c;不要在响应中发送完整的 HTML 页面。当仅有数据通过 API 发送的时候&＃xff0c;Node 服务得会更好。大部分 Node 应用都使用 JSON 数据。

3. 优化数据库查询

优化 Node API 的重要一环是优化查询。特别是对于大型应用来说&＃xff0c;我们需要多次查询数据库&＃xff0c;所以一个糟糕的查询会降低应用的整体性能。

索引是一种优化数据库性能的方法&＃xff0c;通过最小化处理查询时所需的磁盘访问次数来实现。它是一种数据结构技术&＃xff0c;用于快速定位和访问数据库中的数据。索引是使用几个数据库列创建的。

假设我们有一个没有索引的数据库模式&＃xff0c;并且数据库包含 100 万条记录。与带有索引的模式相比&＃xff0c;使用没有索引的模式做一个简单的 find&＃xff08;查找&＃xff09;查询将扫描更多的记录来找到匹配的记录。

• 没有索引的查询

> db.user.find({email: &＃39;ofan&＃64;skyshi.com&＃39;}).explain("executionStats")

• 有索引的查询

> db.getCollection("user").createIndex({ "email": 1 }, { "name": "email_1", "unique": true })
{"createdCollectionAutomatically" : false,"numIndexesBefore" : 1,"numIndexesAfter" : 2,"ok" : 1
}

两者之间扫描文件的数量相差巨大 ~ 1038&＃xff1a;

4. 使用 PM2 集群模式优化 API

PM2 是为 Node.js 应用程序设计的生产流程管理器。它内置了负载平衡器&＃xff0c;允许应用程序在不修改代码的情况下&＃xff0c;作为多个进程运行。

使用 PM2 时的应用停机时间几乎为零。总体来说&＃xff0c;PM2 确实可以提升 API 性能和并发性。

在生产环境中部署代码并运行以下命令以查看 PM2 集群如何在所有可用 CPU 上进行扩展&＃xff1a;

pm2 start  app.js -i 0

5. 减少 TTFB&＃xff08;第一字节时间&＃xff09;

第一字节时间是一种测量方式&＃xff0c;用作表示 Web 服务器或者其他网络资源的响应时间。TTFB 测量从用户或客户发出 HTTP 请求到客户的浏览器收到页面的第一个字节的时间。

所有用户访问浏览器的同一页面加载速度不可能在 100 毫秒之内&＃xff0c;这仅仅是因为服务器和用户之间的物理距离。

我们可以通过使用 CDN 和全球本地数据中心缓存内容来减少第一个字节的时间。这有助于用户以最小的延迟访问内容。你可以从 Cloudflare 提供的 CDN 解决方案开始着手。

6. 使用带日志的错误脚本

监视 API 是否正常工作最好的办法是记录行为&＃xff0c;于是记录日志就派上用场。

一个常见的办法是将记录打印在控制台上&＃xff08;使用console.log()&＃xff09;。

比console.log()更高效的方法是使用 Morgan、Buyan 和 Winston。我将在这里以 Winston 为例。

如何使用 Winston 记录 – 功能

• 支持 4 个可以自由选择的日志等级&＃xff0c;如&＃xff1a;info、error、verbose、debug、silly 和 warn

• 支持查询日志

• 简单的分析

• 可以使用相同的类型进行多个 transports 输出

• 捕获并记录 uncaughtException

可以使用以下命令行设置 Winston&＃xff1a;

npm install winston --save

这里是使用 Winston 记录的基本配置&＃xff1a;

const winston &＃61; require(&＃39;winston&＃39;);let logger &＃61; new winston.Logger({transports: [new winston.transports.File({level: &＃39;verbose&＃39;,timestamp: new Date(),filename: &＃39;filelog-verbose.log&＃39;,json: false,}),new winston.transports.File({level: &＃39;error&＃39;,timestamp: new Date(),filename: &＃39;filelog-error.log&＃39;,json: false,})]
});logger.stream &＃61; {write: function(message, encoding) {logger.info(message);}
};

7. 使用 HTTP/2 而不是 HTTP

除了上述使用的这些技巧&＃xff0c;我们还可以使用 HTTP/2 而不是 HTTP&＃xff0c;因为它具备以下优势&＃xff1a;

• 多路复用

• 头部压缩

• 服务器推送

• 二进制格式

它专注提高性能&＃xff0c;并解决 HTTP 的问题。它使网页浏览更快、更容易&＃xff0c;并且消耗更少的带宽。

8. 并行任务

使用 async.js 来运行任务。并行任务对 API 的性能有很大改善&＃xff0c;它减少了延迟并最大限度地减少了阻塞操作。

并行意味着同时运行多个任务。当你并行任务的时候&＃xff0c;不需要控制程序的执行顺序。

以下是一个数组异步并行的简单例子&＃xff1a;

const async &＃61; require("async");
// 使用对象而不是数组
async.parallel({task1: function(callback) {setTimeout(function() {console.log(&＃39;Task One&＃39;);callback(null, 1);}, 200);},task2: function(callback) {setTimeout(function() {console.log(&＃39;Task Two&＃39;);callback(null, 2);}, 100);}
}, function(err, results) {console.log(results);// 结果相当于: {task2: 2, task1: 1}
});

在以上例子中&＃xff0c;我们使用了 async.js 以异步的形式执行了两个任务。task 1 需要 200 毫秒完成&＃xff0c;但是 task 2 不需要等待 task 1 完成后再执行 – 它在设定的 100 毫秒后执行。

并行任务对 API 的性能有很大的影响。它减少了延迟并最大限度地减少了阻塞操作。

9. 使用 Redis 缓存应用

Redis 是 Memcached 的高级版本。它通过在服务器的主内存中存储和检索数据来优化 API 响应时间。它提高了数据库查询的性能&＃xff0c;也减少了访问延迟。

在下面的代码片段中&＃xff0c;我们分别调用了不使用 Redis 和使用 Redis 的 API&＃xff0c;并比较了响应时间。

响应时间差异巨大~ 899.37 毫秒&＃xff1a;

以下是不使用 Redis 的 Node&＃xff1a;

&＃39;use strict&＃39;;//定义需要的所有依赖项
const express &＃61; require(&＃39;express&＃39;);
const responseTime &＃61; require(&＃39;response-time&＃39;)
const axios &＃61; require(&＃39;axios&＃39;);//加载 Express 框架
var app &＃61; express();//创建在响应头中添加 X-Response-Time 的中间件
app.use(responseTime());const getBook &＃61; (req, res) &＃61;> {let isbn &＃61; req.query.isbn;let url &＃61; &＃96;https://www.googleapis.com/books/v1/volumes?q&＃61;isbn:${isbn}&＃96;;axios.get(url).then(response &＃61;> {let book &＃61; response.data.itemsres.send(book);}).catch(err &＃61;> {res.send(&＃39;The book you are looking for is not found !!!&＃39;);});
};app.get(&＃39;/book&＃39;, getBook);app.listen(3000, function() {console.log(&＃39;Your node is running on port 3000 !!!&＃39;)
});

以下是使用 Redis 的 Node&＃xff1a;

&＃39;use strict&＃39;;//定义需要的所有依赖项
const express &＃61; require(&＃39;express&＃39;);
const responseTime &＃61; require(&＃39;response-time&＃39;)
const axios &＃61; require(&＃39;axios&＃39;);
const redis &＃61; require(&＃39;redis&＃39;);
const client &＃61; redis.createClient();//加载 Express 框架
var app &＃61; express();//创建在响应头中添加 X-Response-Time 的中间件
app.use(responseTime());const getBook &＃61; (req, res) &＃61;> {let isbn &＃61; req.query.isbn;let url &＃61; &＃96;https://www.googleapis.com/books/v1/volumes?q&＃61;isbn:${isbn}&＃96;;return axios.get(url).then(response &＃61;> {let book &＃61; response.data.items;//设置string-key:缓存中的 isbn。以及缓存的内容: title// 设置缓存的过期时间为 1 个小时&＃xff08;60分钟&＃xff09;client.setex(isbn, 3600, JSON.stringify(book));res.send(book);}).catch(err &＃61;> {res.send(&＃39;The book you are looking for is not found !!!&＃39;);});
};const getCache &＃61; (req, res) &＃61;> {let isbn &＃61; req.query.isbn;//对照服务器的 redis 检查缓存数据client.get(isbn, (err, result) &＃61;> {if (result) {res.send(result);} else {getBook(req, res);}});
}
app.get(&＃39;/book&＃39;, getCache);app.listen(3000, function() {console.log(&＃39;Your node is running on port 3000 !!!&＃39;)
)};

总结

在本指南中&＃xff0c;我们了解了如何优化 Node.js API 的响应时间。

Javascript 重度依赖函数&＃xff0c;因此&＃xff0c;使用异步函数可以使脚本运行得更快并且不阻塞。

除此之外&＃xff0c;我们还可以使用缓存记忆&＃xff08;Redis&＃xff09;、数据库索引、TTFB 和 PM2 集群来提高响应速度。

最后请记住&＃xff0c;注意路由的安全性并尽可能优化路由也很重要。我们不能为了提高 API 响应速度而妥协掉安全性。因此&＃xff0c;在 Node.js 中构建优化的 API 时&＃xff0c;应该保留所有标准安全检查。

Happy coding!

Node 社群我组建了一个氛围特别好的 Node.js 社群&＃xff0c;里面有很多 Node.js小伙伴&＃xff0c;如果你对Node.js学习感兴趣的话&＃xff08;后续有计划也可以&＃xff09;&＃xff0c;我们可以一起进行Node.js相关的交流、学习、共建。下方加 考拉 好友回复「Node」即可。如果你觉得这篇内容对你有帮助&＃xff0c;我想请你帮我2个小忙&＃xff1a;1. 点个「在看」&＃xff0c;让更多人也能看到这篇文章2. 订阅官方博客 www.inode.club 让我们一起成长点赞和在看就是最大的支持❤️