如何在 Express 的 JSON 解析前记录原始请求日志

1次阅读

如何在 Express 的 JSON 解析前记录原始请求日志

本文介绍如何在 express 中正确插入前置中间件,在 express.json() 解析请求体之前捕获并记录原始请求(包括非法 json),避免因解析失败导致日志丢失。关键在于使用标准中间件签名,而非错误处理中间件。

本文介绍如何在 express 中正确插入前置中间件,在 `express.json()` 解析请求体之前捕获并记录原始请求(包括非法 json),避免因解析失败导致日志丢失。关键在于使用标准中间件签名,而非错误处理中间件。

在 Express 应用中,若希望对所有传入请求(尤其是可能含非法 JSON 的请求)进行统一日志记录,必须确保日志中间件严格位于 express.json() 之前执行,且以标准中间件形式注册——即接收 (req, res, next) 三个参数,而非四参数的错误处理签名 (err, req, res, next)。

你遇到的问题根源在于:

app.use((err, req, res, next) => { ... }); // ❌ 错误:这是错误处理器,仅在抛出异常后触发

该写法将中间件注册为错误处理中间件,Express 仅在后续中间件(如 express.json())抛出同步错误(例如 SyntaxError)时才会调用它,但此时请求体已读取失败、原始数据不可恢复,且该中间件本身不会拦截正常请求流,因此 console.log(‘hi there 678’) 永远不会执行。

✅ 正确做法是注册一个标准中间件,直接访问 req 的原始数据流:

// ✅ 在 express.json() 之前注册:记录原始请求(含非法 JSON) app.use((req, res, next) => {   const startTime = Date.now();    // 记录请求基础信息(方法、路径、IP)   logger.info({     event: 'request_received',     method: req.method,     url: req.url,     ip: req.ip,     timestamp: new Date().toISOString()   });    // 可选:记录原始请求体(需谨慎,大请求体可能影响性能)   let rawData = '';   req.setEncoding('utf8');   req.on('data', (chunk) => {     rawData += chunk;     if (rawData.length > 10240) { // 限制记录长度,防内存溢出       rawData = rawData.substring(0, 10240) + '...[TRUNCATED]';     }   });   req.on('end', () => {     if (rawData) {       logger.debug({         event: 'request_body_preview',         body_preview: rawData       });     }     // 注意:此处不能直接 next() —— 因为 req.body 已被消费,需重新挂载流     // 实际生产环境建议使用 'raw-body' 库或跳过完整 body 记录     next();   }); });  // ✅ 紧随其后:JSON 解析中间件(会在此处捕获非法 JSON 并抛出错误) app.use(express.json({ limit: '50mb', strict: false }));

⚠️ 重要注意事项

  • 不要在标准中间件中尝试 await 或阻塞读取整个 req 流,否则会破坏后续中间件对 req.body 的正常解析;如需完整日志,推荐使用 raw-body 库安全提取原始字节。
  • 若仅需记录请求元数据(method、url、headers、ip),上述简单中间件完全足够且零副作用。
  • 对于非法 JSON 导致的 400 Bad Request,仍需配合全局错误处理器捕获并补全日志:
    app.use((err, req, res, next) => {   if (err.status === 400 && err.message.includes('invalid json')) {     logger.warn({       event: 'json_parse_failed',       method: req.method,       url: req.url,       error: err.message,       ip: req.ip     });   }   next(err); });

总结:日志前置的核心是位置 + 签名——把 (req, res, next) 形式的中间件置于 express.json() 之前,即可稳定捕获每个请求的起点状态,为可观测性打下坚实基础。

text=ZqhQzanResources