在开发 Web 应用程序时，日志记录是一项重要的任务。它可以帮助我们跟踪应用程序的行为，诊断问题并监控性能。在 Express.js 中，我们可以使用不同的工具来记录日志，但是如何使用这些工具来记录日志是一项需要认真考虑的任务。在本文中，我们将介绍 Express.js 日志记录的最佳实践，以及如何使用这些最佳实践来记录日志。
为什么需要日志记录？
在开发 Web 应用程序时，我们需要记录应用程序的行为。这些行为可能包括：
- 用户请求和响应
- 错误和异常
- 计时和性能数据
通过记录这些行为，我们可以：
- 跟踪应用程序的行为并诊断问题
- 监控性能并优化应用程序
- 提供审计日志以满足安全和合规要求
Express.js 中的日志记录工具
在 Express.js 中，我们可以使用不同的工具来记录日志。以下是一些常用的工具：
- Morgan：Morgan 是一个流行的 HTTP 请求记录器，它可以记录 HTTP 请求的信息，例如请求方法、URL、状态码、响应时间和响应体大小等。它可以与 Express.js 集成，以记录应用程序的请求和响应。
- Winston：Winston 是一个灵活的日志记录器，它可以记录不同级别的日志，例如调试、信息、警告和错误等。它还可以将日志记录到不同的目标，例如控制台、文件和数据库等。它可以与 Express.js 集成，以记录应用程序的日志。
- Bunyan：Bunyan 是一个结构化的日志记录器，它可以记录 JSON 格式的日志。它支持不同的记录级别，例如跟踪、调试、信息、警告和错误等。它可以与 Express.js 集成，以记录应用程序的日志。
在本文中，我们将使用 Morgan 和 Winston 来演示如何记录日志。
最佳实践
以下是记录 Express.js 日志的最佳实践：
1. 记录请求和响应
记录请求和响应是一项重要的任务，它可以帮助我们跟踪应用程序的行为并诊断问题。我们可以使用 Morgan 来记录请求和响应。以下是一个示例：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ------ - ------------------ ----- --- - ---------- -- -- ------ ------- ---------------------------- ------------ ----- ---- -- - ---------------- --------- --- ---------------- -- -- - ------------------- -- --------- -- ---- ------- ---
在上面的示例中，我们使用 morgan('combined') 来记录请求和响应。combined 是一个预定义的格式，它包含请求方法、URL、状态码、响应时间、响应体大小和用户代理等信息。您还可以使用其他格式，例如 dev、common 和 short 等。
2. 记录错误和异常
记录错误和异常是一项重要的任务，它可以帮助我们诊断问题并提供更好的用户体验。我们可以使用 Winston 来记录错误和异常。以下是一个示例：
-- -------------------- ---- -------
----- ------- - -------------------
----- ------- - -------------------
----- --- - ----------
-- ---- ------- -----
----- ------ - ----------------------
------ --------
------- ----------------------
----------- -
--- -----------------------------
--- ------------------------- --------- ----------- --
-
---
------------ ----- ---- -- -
--- -
-- ------
----- --- ---------------- ---- --------
- ----- --- -
-- -------
------------------------
------------------------------- ---- --------
-
---
---------------- -- -- -
------------------- -- --------- -- ---- -------
---在上面的示例中，我们创建了一个 Winston 日志记录器，并将其配置为记录错误级别的日志。我们还将日志记录器配置为将日志记录到控制台和文件中。在路由处理程序中，我们使用 try-catch 块来捕获异常，并使用日志记录器记录异常。
3. 记录计时和性能数据
记录计时和性能数据是一项重要的任务，它可以帮助我们监控性能并优化应用程序。我们可以使用 Morgan 和 Winston 来记录计时和性能数据。以下是一个示例：
-- -------------------- ---- -------
----- ------- - -------------------
----- ------ - ------------------
----- ------- - -------------------
----- --- - ----------
-- -- ------ -------
----------------------------
-- ---- ------- -----
----- ------ - ----------------------
------ -------
------- ----------------------
----------- -
--- -----------------------------
--- ------------------------- --------- ---------- --
-
---
-- ---------
------------- ---- ----- -- -
----- ----- - -----------
---------------- -- -- -
----- ------- - ---------- - ------
-------------
-------- -------------- ------------------ -------------------
-------
---
---
-------
---
------------ ----- ---- -- -
---------------- ---------
---
---------------- -- -- -
------------------- -- --------- -- ---- -------
---在上面的示例中，我们使用 Morgan 记录请求和响应，并使用 Winston 记录计时和性能数据。在中间件中，我们使用 Date.now() 记录请求开始时间，并在响应结束时计算响应时间。我们还将请求方法、URL 和状态码等信息记录到日志中。
结论
在本文中，我们介绍了 Express.js 日志记录的最佳实践，并演示了如何使用 Morgan 和 Winston 来记录日志。通过遵循这些最佳实践，我们可以跟踪应用程序的行为，诊断问题并监控性能。希望这篇文章对您有帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67798c80381bbe667f941b8f