本教程旨在解决node.js express应用中难以通用追踪“运行中进程”或“活动promise”的问题，特别是针对未完成的http请求。我们将介绍如何利用`on-finished`中间件来建立一个通用的请求生命周期监控机制，从而无需为每个异步路由单独编写状态检查逻辑，实现对当前未响应请求数量的实时统计。
在构建复杂的Node.js应用时，尤其是在使用Express框架处理大量异步HTTP请求的场景下，我们常常需要了解当前有多少请求正在被处理，或者有多少异步操作尚未完成。直接监控Node.js内部的Promise状态或操作系统层面的进程通常不切实际且过于复杂。更实际的需求是追踪那些已经接收但尚未完全响应的HTTP请求。本教程将提供一个通用且高效的方法来解决这一问题，避免为每个业务逻辑编写冗余的状态管理代码。
理解问题核心：追踪未完成的HTTP请求
“运行中的进程”或“活动的Promise”在HTTP服务上下文中，通常指的是那些已经进入服务器处理流程，但其HTTP响应尚未发送给客户端的请求。这些请求可能正在执行数据库查询、调用外部API或进行其他耗时操作。手动为每个异步路由添加开始和结束标志来更新全局计数器，不仅工作量巨大，而且容易出错。我们需要一个能够自动挂钩到HTTP请求生命周期的机制。
解决方案：利用 on-finished 中间件
Node.js生态系统提供了on-finished这个轻量级中间件，它专门用于监听HTTP请求或响应的完成事件。通过在请求开始时记录请求，并在响应完成时移除记录，我们就可以精确地追踪当前有多少请求处于“进行中”状态。
1. 安装 on-finished
首先，确保你的项目中安装了on-finished库：
npm install on-finished
2. 创建请求追踪中间件
我们将创建一个自定义的Express中间件，它会维护一个全局的Set来存储当前所有未完成请求的唯一标识符。
const onFinished = require('on-finished');
// 使用 Set 存储未完成请求的唯一ID
const unresolvedRequestIds = new Set();
/**
* 请求追踪中间件
* 在请求开始时添加ID，在响应结束时移除ID。
*/
const requestTracker = (req, res, next) => {
// 为每个请求生成一个唯一的ID
// 实际应用中可以使用更健壮的ID生成策略，如 UUID
const id = Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
unresolvedRequestIds.add(id);
// 监听响应完成事件
onFinished(res, () => {
unresolvedRequestIds.delete(id);
console.log(`Request finished. Active requests: ${unresolvedRequestIds.size}`);
});
next(); // 继续处理请求
};代码解释：
- unresolvedRequestIds：一个JavaScript Set，用于存储每个未完成请求的唯一标识符。Set的特性是只存储唯一值，并且查找和删除效率高。
- id = Math.random()...：这里使用了一个简单的随机字符串作为请求ID。在生产环境中，你可能需要一个更健壮的唯一ID生成器，例如UUID（uuid库）。
- onFinished(res, () => { ... })：这是核心逻辑。当HTTP响应（res）完成（无论是成功发送、客户端中断还是发生错误）时，回调函数会被执行，此时我们将对应的请求ID从unresolvedRequestIds中移除。
- next()：调用next()将请求传递给下一个中间件或路由处理器。
3. 集成请求追踪中间件
你可以选择在特定路由上应用此中间件，或者在整个应用程序级别应用。
A. 针对特定路由应用
如果你只想追踪某些特定的异步路由，可以在这些路由前使用requestTracker：
const express = require('express');
const app = express();
const router = express.Router();
// 引入上面定义的 requestTracker
// const requestTracker = ...;
router.post('/someEndpoint', requestTracker, async (req, res) => {
console.log('Processing /someEndpoint...');
// 模拟异步操作
await new Promise(resolve => setTimeout(resolve, 2000));
res.status(200).json({ message: 'Operation completed' });
});
router.get('/anotherEndpoint', requestTracker, async (req, res) => {
console.log('Processing /anotherEndpoint...');
await new Promise(resolve => setTimeout(resolve, 1000));
res.status(200).json({ message: 'Another operation completed' });
});
app.use('/', router); // 将路由挂载到应用B. 全局应用
更常见且更方便的做法是在应用程序的顶层应用requestTracker。这样，它将对所有进入Express应用的请求生效。
const express = require('express');
const app = express();
// 引入上面定义的 requestTracker
// const requestTracker = ...;
// 在所有路由之前应用请求追踪中间件
app.use(requestTracker);
app.post('/someEndpoint', async (req, res) => {
console.log('Processing /someEndpoint...');
await new Promise(resolve => setTimeout(resolve, 2000));
res.status(200).json({ message: 'Operation completed' });
});
app.get('/anotherEndpoint', async (req, res) => {
console.log('Processing /anotherEndpoint...');
await new Promise(resolve => setTimeout(resolve, 1000));
res.status(200).json({ message: 'Another operation completed' });
});
// 其他路由...
app.listen(3000, () => {
console.log('Server running on port 3000');
});注意事项： 当全局应用requestTracker时，它会追踪所有HTTP请求，包括那些不涉及复杂异步操作的简单请求（如静态文件请求或同步路由）。这通常是可接受的，因为它提供了一个全面的视图。
4. 创建获取未完成请求数量的API
现在，我们可以创建一个新的API端点，用于暴露当前未完成请求的数量。
// ... (之前的 requestTracker 和 app.use(requestTracker) 代码) ...
app.get('/getUnresolvedRequestCount', (req, res) => {
res.status(200).json({ unresolvedRequestCount: unresolvedRequestIds.size });
});
// ... (其他路由和 app.listen) ...当你访问 /getUnresolvedRequestCount 时，它将返回一个JSON对象，其中包含当前正在处理的HTTP请求数量。
完整示例代码
const express = require('express');
const onFinished = require('on-finished');
const app = express();
const PORT = 3000;
// 使用 Set 存储未完成请求的唯一ID
const unresolvedRequestIds = new Set();
/**
* 请求追踪中间件
* 在请求开始时添加ID，在响应结束时移除ID。
*/
const requestTracker = (req, res, next) => {
// 为每个请求生成一个唯一的ID
const id = Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
unresolvedRequestIds.add(id);
console.log(`Request started [${id}]. Active requests: ${unresolvedRequestIds.size}`);
// 监听响应完成事件
onFinished(res, () => {
unresolvedRequestIds.delete(id);
console.log(`Request finished [${id}]. Active requests: ${unresolvedRequestIds.size}`);
});
next(); // 继续处理请求
};
// 在所有路由之前应用请求追踪中间件
app.use(requestTracker);
// 示例异步路由 1
app.post('/api/long-task', async (req, res) => {
console.log('Processing /api/long-task...');
// 模拟一个耗时5秒的异步操作
await new Promise(resolve => setTimeout(resolve, 5000));
res.status(200).json({ message: 'Long task completed successfully!' });
});
// 示例异步路由 2
app.get('/api/short-task', async (req, res) => {
console.log('Processing /api/short-task...');
// 模拟一个耗时1秒的异步操作
await new Promise(resolve => setTimeout(resolve, 1000));
res.status(200).json({ message: 'Short task completed successfully!' });
});
// 获取未完成请求数量的API
app.get('/getUnresolvedRequestCount', (req, res) => {
res.status(200).json({ unresolvedRequestCount: unresolvedRequestIds.size });
});
// 启动服务器
app.listen(PORT, () => {
console.log(`Server running on http://localhost:${PORT}`);
console.log(`Try POST http://localhost:${PORT}/api/long-task`);
console.log(`Try GET http://localhost:${PORT}/api/short-task`);
console.log(`Monitor GET http://localhost:${PORT}/getUnresolvedRequestCount`);
});总结与注意事项
- 通用性： 这种方法提供了一个通用的机制来监控HTTP请求的生命周期，而无需修改每个业务路由的逻辑。
- 粒度： 这种方法追踪的是HTTP请求，而不是Node.js应用程序中所有的Promise或底层进程。对于大多数Web服务监控场景，追踪HTTP请求是更直接和有用的指标。
- 资源消耗： Set数据结构在添加、删除和检查大小方面效率很高，因此这种方法对性能的影响很小。
- 扩展性： 你可以扩展requestTracker中间件，不仅仅存储请求ID，还可以存储更多信息，例如请求路径、开始时间、用户ID等，以便进行更详细的监控和分析。
- 唯一ID生成： 示例中使用了Math.random()生成ID，这在小规模测试中可行，但在生产环境中建议使用更健壮的唯一标识符生成器（如uuid库），以避免ID冲突的极小概率。
- 错误处理： on-finished库能够正确处理请求正常完成、客户端中断连接或服务器内部错误等多种情况，确保请求ID在任何情况下都能被正确移除。
通过上述方法，你可以为你的Node.js Express应用建立一个可靠的、通用的未完成HTTP请求监控系统，从而更好地了解应用的实时负载和处理能力。
