在前端开发中，日志输出是一个非常重要的环节。当代码出现问题时，可以借助日志来查找问题。在 JavaScript 中，通常使用 console.log() 输出日志。
但是在复杂的应用中， console.log() 已经不能满足要求了。输出的日志信息比较少，不能很好地表达程序的运行流程和状态。此时就需要一个更加强大的日志库。
一个常用的日志库是 log4js，它提供了多种日志输出方式，并且可以根据级别过滤日志。另外一个比较受欢迎的日志库是 winston，它提供了类似于 log4j 的句柄和过滤器的功能。
而在这篇文章中，我们要介绍的是一个叫做 contextlog 的 npm 包，它可以让我们在日志中方便地加入上下文信息。下面我们将详细介绍 contextlog 的使用方法。
介绍 contextlog
contextlog 是一个基于 winston 的 npm 包，它可以让我们在日志输出中方便地加入上下文信息。通过 contextlog，我们可以记录日志发生的时间、地点、事件等信息。当程序出错时可以快速定位问题所在。
以下是 contextlog 的主要特性：
- 提供了简洁易用的 API，几乎无需学习和使用配置文件
- 支持运行时动态修改上下文信息
- 可以将日志按照不同的上下文分类
- 支持输出 JSON 格式的日志
- 可以方便地在 Express 中使用
- 可以很容易地添加自定义的日志处理器
- 支持 TypeScript
安装和使用
在安装 contextlog 之前，需要先安装 winston。在终端中执行：
npm install winston --save
然后再安装 contextlog：
npm install contextlog --save
安装完成后，就可以在代码中引入 contextlog：
const { logger, runWithId } = require('contextlog');然后就可以开始使用了。比如，我们可以输出一条日志：
logger.info('hello, world!');logger 变量是 winston 的实例。runWithId 是一个规定了一个上下文环境的方法，当有需要进一步分析记录情况时，可以使用它来在日志中区分不同的场景。
let id = 'user-123';
runWithId(id, () => {
logger.info('hello, world!');
});通过这种方式，我们就可以在日志中区分出不同用户的行为。
动态修改上下文信息
我们可以在输出日志时加入上下文信息。比如，我们可以记录下函数调用的参数和返回值：
function add(a, b) {
logger.info('add', { a, b, result: a + b });
return a + b;
}在上面的代码中， logger.info() 方法的第二个参数是一个对象，并且包含了函数的参数和返回值。这样就可以方便地追踪函数调用的情况了。
在 runWithId() 和 logger.info() 方法之外，我们还可以通过 setContext() 方法来动态修改上下文信息：
logger.setContext({ sessionId: 'session-123' });
logger.info('hello, world!');这里设置了 sessionId 字段，它将包含在日志中。这个方法可以用来记录会话信息、请求信息等也非常有用。
输出 JSON 格式的日志
除了输出文本格式的日志外，还可以将日志以 JSON 格式输出。只需在创建日志实例时传入 json: true 选项即可：
-- -------------------- ---- -------
----- - ------ - - ----------------------
----- -------- - --- ---------------
----------- -
--- --------------------------- ----- ---- --
-
---
--------------------- ---------这样输出的日志就是 JSON 格式的。
在 Express 中使用
contextlog 提供了方便的中间件，可以在 Express 中使用。比如，我们可以使用 withRequestId 中间件来自动生成请求 ID：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- - -------------- ------ - - ---------------------- ----- --- - ---------- ----------------------- ------------ ----- ---- -- - ------------------- --------- ---------------- --------- --- ---------------- -- -- - ------------------- ----------- ---
这里先使用 withRequestId 中间件来生成请求 ID，在后面的代码中使用这个 ID 来区分不同的请求。
添加自定义的日志处理器
除了内置的日志输出器外，还可以自定义日志处理器。比如，我们可以将日志输出到文件中：
-- -------------------- ---- -------
----- - ------ - - ----------------------
----- -- - --------------
----- --------------- ------- ---------------- -
--------- --------- -
------------------------------------- ----- --------------- --------------------
-----------
-
-
----------------------------
------------------- ---------在这个例子中，我们创建了一个自定义的日志处理器 MyFileTransport，它将日志输出到文件 mylog.txt。使用 logger.add() 将自定义处理器添加到日志实例中即可。
总结
本文介绍了 contextlog 的使用方法。通过 contextlog，可以方便地将上下文信息加入日志中，输出更加详细和有用的日志信息。相信读完本文，对于日志处理的相关工作方面也有了更进一步的掌握。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056cd481e8991b448e667c