在Node.js Express应用开发中,追踪未完成的HTTP请求是排查接口超时、异常中断等问题的重要手段,通过通用方案可以避免在每个业务接口中重复编写追踪逻辑,提升代码的可维护性。

实现思路
我们可以通过Express的中间件机制,在请求进入时记录请求的基础信息和开始时间,监听请求和响应的相关事件来更新请求状态,最终将请求的生命周期信息存储或上报。核心逻辑包含三个部分:请求初始化、状态更新、完成处理。
请求初始化
在中间件中为每个请求生成唯一标识,记录请求的方法、路径、开始时间等基础信息,将请求信息存入一个全局的待追踪集合中。
状态更新
监听请求的close事件(客户端主动断开连接)、aborted事件(请求被中止),以及响应的finish事件(响应正常完成),根据事件类型更新请求的状态。
完成处理
当请求进入终态后,从待追踪集合中移除该请求的信息,同时可以将相关信息输出到日志或者上报到监控系统。
完整实现代码
以下是通用的追踪中间件实现,使用JavaScript编写,适配Express框架:
const pendingRequests = new Map();
// 生成唯一请求ID
function generateRequestId() {
return Date.now().toString(36) + Math.random().toString(36).slice(2, 8);
}
// 通用请求追踪中间件
function requestTrackerMiddleware(req, res, next) {
const requestId = generateRequestId();
const requestInfo = {
id: requestId,
method: req.method,
path: req.originalUrl || req.url,
startTime: Date.now(),
status: 'pending', // pending: 处理中, completed: 正常完成, aborted: 客户端中断, error: 处理异常
endTime: null,
duration: null
};
// 将请求信息存入待追踪集合
pendingRequests.set(requestId, requestInfo);
// 监听客户端断开连接
req.on('close', () => {
if (pendingRequests.has(requestId)) {
const info = pendingRequests.get(requestId);
info.status = 'aborted';
info.endTime = Date.now();
info.duration = info.endTime - info.startTime;
console.log('请求被客户端中断:', info);
// 这里可以添加上报逻辑,比如发送到监控系统
pendingRequests.delete(requestId);
}
});
// 监听请求被中止
req.on('aborted', () => {
if (pendingRequests.has(requestId)) {
const info = pendingRequests.get(requestId);
info.status = 'aborted';
info.endTime = Date.now();
info.duration = info.endTime - info.startTime;
console.log('请求被中止:', info);
pendingRequests.delete(requestId);
}
});
// 监听响应完成
res.on('finish', () => {
if (pendingRequests.has(requestId)) {
const info = pendingRequests.get(requestId);
info.status = 'completed';
info.endTime = Date.now();
info.duration = info.endTime - info.startTime;
console.log('请求正常完成:', info);
// 这里可以添加上报逻辑
pendingRequests.delete(requestId);
}
});
// 监听响应关闭(异常情况)
res.on('close', () => {
if (pendingRequests.has(requestId)) {
const info = pendingRequests.get(requestId);
if (info.status === 'pending') {
info.status = 'error';
info.endTime = Date.now();
info.duration = info.endTime - info.startTime;
console.log('请求处理异常:', info);
pendingRequests.delete(requestId);
}
}
});
// 将请求ID挂载到req对象,方便后续业务使用
req.requestId = requestId;
next();
}
// 获取当前所有未完成请求的方法
function getPendingRequests() {
return Array.from(pendingRequests.values());
}
module.exports = {
requestTrackerMiddleware,
getPendingRequests
};
使用方式
在Express应用中引入中间件,在注册业务路由之前使用即可:
const express = require('express');
const { requestTrackerMiddleware, getPendingRequests } = require('./requestTracker');
const app = express();
// 注册追踪中间件,放在所有路由之前
app.use(requestTrackerMiddleware);
// 业务路由示例
app.get('/api/test', (req, res) => {
// 模拟异步处理,5秒后返回
setTimeout(() => {
res.json({ code: 0, msg: 'success', requestId: req.requestId });
}, 5000);
});
// 查看未完成请求的接口
app.get('/api/pending-requests', (req, res) => {
const pending = getPendingRequests();
res.json({ code: 0, data: pending });
});
app.listen(3000, () => {
console.log('服务启动在3000端口');
});
注意事项
- 全局的
pendingRequests集合在高并发场景下需要注意内存占用,可以定期清理过期的请求信息,或者限制最大存储数量。 - 如果应用部署了多个实例,这种内存存储的方式只能追踪当前实例的请求,需要集中式存储的话可以将请求信息上报到Redis等外部存储。
- 事件监听需要注意避免内存泄漏,确保请求终态后一定会被从集合中移除,上述代码已经覆盖了常见的终态场景。
- 如果业务中使用了其他中间件修改了req或res的事件监听,需要确认不会冲突,必要时可以调整中间件的注册顺序。
扩展方向
这个通用方案还可以进一步扩展,比如添加请求参数的记录、响应状态码的统计、耗时阈值的告警等,只需要修改requestInfo的结构和对应的处理逻辑即可,不需要改动业务代码,符合开闭原则。