日志记录在任何 Web 应用程序的开发和维护过程中都是至关重要的。通过记录各种活动，包括请求和响应，错误和异常，您可以更好地了解应用程序的行为并提高其性能。在本文中，我们将介绍在使用 Express.js 框架开发 Web 应用程序时如何实现日志记录。
为什么要记录日志？
在编写 Web 应用程序时，日志记录是一个必不可少的工具。日志记录不仅可以跟踪应用程序的运行情况，还可以用于以下目的：
- 除错和故障排除：当应用程序出现错误或故障时，可以使用日志来跟踪问题的根源，从而使修复问题更容易。
- 性能优化：通过记录应用程序的各种活动，您可以了解到应用程序的繁忙时段和资源瓶颈，从而优化其性能。
- 监控应用程序健康状况：通过监控日志，您可以获得应用程序的实时状态、交互和性能数据，了解应用程序健康状况。
Express.js 中的日志记录
Express.js 是一个基于 Node.js 平台的 Web 应用程序框架，提供了一种简单而有效的方式来记录日志。Express.js 框架可以与各种第三方日志库和中间件集成，以满足不同的应用程序需求。此外，Express.js 还提供了一些内置中间件来帮助您记录日志。
使用内置中间件记录日志
Express.js 提供了一个内置的 middleware，用于记录请求和响应的日志。该 middleware 是常见的日志记录实现之一，为您提供了一些默认的信息，例如远程 IP 和请求的路径、HTTP 方法、响应状态码以及响应时间等。
----- ------- - ------------------- ----- --- - ---------- --------------------------
使用 express.logger() 作为 middleware 就能够记录基本的请求和响应信息，这种方法默认会输出日志到控制台(stdOut)。如果您想要将日志记录到文件中，请使用第三方日志库或自定义中间件。
使用第三方日志库记录日志
使用第三方日志库有很多好处，例如精细的控制，异步日志记录和更丰富的日志格式和存储支持。在这里，我们将介绍如何使用最流行的日志库之一 winston 记录日志。
首先，您需要安装 winston：
--- ------- -------
接下来，您需要创建一个 logger。下面是一个使用 winston 记录日志的简单示例：
----- ------- - -------------------
----- ------- - -------------------
----- --- - ----------
----- ------ - ----------------------
------ -------
------- ----------------------
------------ - -------- -------------- --
----------- -
--
-- - ----- --- ---- ---- ----- ------- --- ----- -- -----------
-- - ----- --- ---- ---- ----- ------ --- ----- -- --------------
--
--- ------------------------- --------- ------------ ------ ------- ---
--- ------------------------- --------- -------------- --
-
---
------------------ --------
------------- ---- ----- -- -
-------------------------- ------------------ ------------
-------
---
------------ ----- ---- -- -
--------------- ---------
---
---------------- -- -- -
-------------------- --- --------- -- ---- --------
---在上面的示例中，我们创建了一个具有以下功能的 logger：
- 默认级别为 info：设置默认记录级别为 info 级别。
- JSON 格式：使用 JSON 格式记录日志。
- 服务名称：为所有日志添加一个服务名称。
- 记录到文件：将记录级别为 error 的日志记录到 error.log 文件中，将记录级别为 info 的日志记录到 combined.log 文件中。
在 Express.js 应用程序中，我们使用中间件来记录日志。在上面的示例中，我们创建了一个 logger 对象，在每个中间件处理程序中使用它来记录请求和响应信息。以下是输出示例：
----------------- --------------------------------------------------------------------------------------
此外，我们还可以将日志输出到控制台，例如使用 winston 的 Console transport：
----- ------ - ----------------------
------ -------
------- ----------------------
------------ - -------- -------------- --
----------- -
--- -----------------------------
--- ------------------------- --------- ------------ ------ ------- ---
--- ------------------------- --------- -------------- --
-
---自定义日志中间件
在某些情况下，您可能需要编写自己的日志中间件以满足特定的需求。在 Express.js 中，可以通过编写自定义中间件函数来实现这一点。自定义中间件函数遵循以下约定：
- 接受
request、response和next参数。 - 调用
next函数以将控件传递给下一个中间件处理程序。 - 利用
winston或其他日志库记录信息。
以下是自定义日志中间件的示例：
----- ------- - -------------------
----- ------- - -------------------
----- --- - ----------
----- ------ - ----------------------
------ -------
------- ----------------------
------------ - -------- -------------- --
----------- -
--- -----------------------------
--- ------------------------- --------- ------------ ------ ------- ---
--- ------------------------- --------- -------------- --
-
---
----- ------------ - ----- ---- ----- -- -
----- ----- - -----------
---------------- -- -- -
----- ---------------- - ---------- - ------
----- -------- - -------------- ------------------ ----------------- -----------------------
----------------------
---
-------
--
----------------------
------------ ----- ---- -- -
--------------- ---------
---
---------------- -- -- -
-------------------- --- --------- -- ---- --------
---在上面的示例中，我们编写了一个自定义中间件 customLogger，该中间件记录每个请求和响应的信息。为了计算响应时间，我们在 res.on('finish') 中实现延迟日志。以下是输出示例：
--- - --- --- --- -------- --- ---
结论
在 Express.js 中记录日志是应用程序开发和维护过程中必不可少的一部分。本文介绍了使用 Express.js 内置中间件、第三方日志库和自定义中间件记录日志的方法。使用这些技术，您可以更好地了解应用程序的行为并提高其性能。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/67060d33d91dce0dc85775fb