在开发 Web 应用程序时，日志记录是非常重要的一环。它可以帮助你了解应用程序在生产环境中的运行情况、快速发现错误并修复它们。在 Express.js 项目中进行日志记录，有助于了解请求和响应的详细信息以及捕获错误。
本文介绍了如何在 Express.js 中进行日志记录，包括配置日志记录和使用日志记录进行调试。此外，还将讨论一些最佳实践，以确保应用程序的可靠性和运行速度。
配置日志记录
要配置日志记录，需要使用一个叫做 morgan 的 Express.js 中间件。morgan 是一个用于生成 HTTP 请求的日志记录的库，它可以用来记录所有请求细节，如请求方式、url、响应状态码、请求体、响应体等，并且它与 Express.js 完全兼容。
首先，需要在项目中安装 morgan，可以使用 npm 包管理器来安装：
npm install morgan
在安装完 morgan 后，我们可以在 Express.js 中使用它来记录日志。为了使用 morgan，先导入它：
const morgan = require('morgan');接下来，在应用程序中间件中使用 morgan，并根据需要选择日志记录格式。例如，可以使用以下代码记录所有请求：
app.use(morgan('[:date[iso]] :method :url :status :response-time ms - :res[content-length]'));此外，我们还可以将日志记录输出到文件，而不是默认的 stdout。可以使用以下代码：
const fs = require('fs');
const path = require('path');
const accessLogStream = fs.createWriteStream(path.join(__dirname, 'access.log'), { flags: 'a' });
app.use(morgan('[:date[iso]] :method :url :status :response-time ms - :res[content-length]', { stream: accessLogStream }));此代码将日志记录输出到项目根目录下的 access.log 文件中。请注意，flags 指定了 a，这意味着将日志追加到文件中。如果您想覆盖现有数据，请使用 w 标志。
使用日志记录进行调试
在实际开发中，日志记录最常用于调试代码和查找错误。在 Express.js 中，我们可以使用日志记录来记录请求和响应的详细信息，以及捕获错误。
例如，我们可以使用以下代码记录请求和响应：
-- -------------------- ---- -------
------------- ---- ----- -- -
----- ----- - -----------
---------------- -- -- -
----- -------- - ---------- - ------
------------------- ---------------------- ------------- ------------------ ---- ------------- --- ---- --------------------
---
-------
---此代码将在每次请求完成后将请求信息和响应信息记录到控制台。
此外，我们还可以使用类似的代码来捕获错误：
app.use((err, req, res, next) => {
console.error(`[${new Date().toISOString()}] ${err.stack}`);
res.status(500).send('Something broke!');
});这将捕获 Express.js 应用程序中发生的所有错误并记录到控制台。
最佳实践
在使用日志记录时，有一些最佳实践可以遵循，以确保应用程序的可靠性和运行速度。
遵循统一的日志格式
遵循统一的日志格式可以帮助我们更轻松地分析和比较日志记录。对于 HTTP 请求，通常会在日志记录中包括请求方法、URL、响应状态代码和响应时间等信息。
记录信息的详细程度
记录太少的信息不利于排查错误，而记录太多的信息则可能会影响应用程序性能。为了找到平衡点，我们需要考虑到应用程序的使用场景和目标受众。比较好的做法是记录请求的头部、身体、查询参数，以及响应码、响应体和时间等信息。
启用日志文件轮换
为了避免过大的日志文件，我们需要启用某种日志文件轮换机制。将旧日志文件删除或归档到特定目录中，而不是让它们一直存在于文件系统中。
禁用不必要的日志记录
在生产环境中，不需要记录所有请求的详细信息。这会导致不必要的 I/O 操作和对性能的消耗。相反，应记录应用程序必要的错误信息和一些统计信息，如请求数、响应时间和错误数量等。这有助于快速定位问题并快速修复。
结论
在 Express.js 应用程序中使用日志记录是非常重要的。它可以帮助我们了解应用程序在生产环境中的运行情况、快速发现错误并修复它们。在本文中，我们介绍了如何配置日志记录和使用日志记录进行调试。此外，我们还讨论了一些最佳实践，以确保应用程序的可靠性和运行速度。使用这些知识，您可以更好地管理和调试您的 Express.js 应用程序。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/66f51b69c5c563ced56cf09b