由于Node.js的 单线程模型 的限制，我们无法设置全局 traceid 来聚合请求，即 实现输出日志与请求的绑定 。如果不实现日志和请求的绑定，我们难以判断日志输出与对应用户请求的对应关系，这对 线上问题排查 带来了困难。
例如，在用户访问 retrieveOne API 时，其会调用 retrieveOneSub 函数，如果我们想在 retrieveOneSub 函数中输出当前请求对应的学生信息，是繁琐的。在 course-se 现有实现下，我们针对此问题的解决方法是：
方案1：在调用 retrieveOneSub 函数的父函数，即 retrieveOne 内，对 paramData 进行 解构 ，输出学生相关信息，但该方案 无法细化日志输出粒度 。
方案2：修改 retrieveOneSub 函数签名，接收 paramData 为其参数，该方案 能确保日志输出粒度 ，但 在调用链很深的情况下，需要给各函数修改函数签名 ，使其接收 paramData ，颇具工作量，并不太可行。
/** * 返回获取一份提交的函数 * @param {ParamData} paramData * @param {Context} ctx * @param {string} id */ export async function retrieveOne(paramData, ctx, id) { const { subModel } = paramData.ce; const sub_asgn_id = Number(id); // 通过 paramData.user 获取 user 相关信息，如 user_id ， // 但无法细化日志输出粒度，除非修改 retrieveOneSub 的签名， // 添加 paramData 为其参数。 const { user_id } = paramData.user; console.log(`${user_id} is trying to retreive one submission.`); // 调用了 retrieveOneSub 函数。 const sub = await retrieveOneSub(sub_asgn_id, subModel); const submission = sub; assign(sub, { sub_asgn_id }); assign(paramData, { submission, sub }); return sub; } /** * 从数据库获取一份提交 * @param {number} sub_asgn_id * @param {SubModel} model */ async function retrieveOneSub(sub_asgn_id, model) { const [sub] = await model.findById(sub_asgn_id); if (!sub) { throw new ME.SoftError(ME.NOT_FOUND, '找不到该提交'); } return sub; }
Async Hooks
其实，针对以上的问题，我们还可以从 Node 的 Async Hooks 实验性 API 方面入手。在 Node.js v8.x 后，官方提供了可用于 监听异步行为 的 Async Hooks（异步钩子）API 的支持。
Async Scope
Async Hooks 对每一个（同步或异步）函数提供了一个 Async Scope ，我们可调用 executionAsyncId 方法获取当前函数的 Async ID ，调用 triggerAsyncId 获取当前函数调用者的 Async ID。
const asyncHooks = require("async_hooks"); const { executionAsyncId, triggerAsyncId } = asyncHooks; console.log(`top level: ${executionAsyncId()} ${triggerAsyncId()}`); const f = () => { console.log(`f: ${executionAsyncId()} ${triggerAsyncId()}`); }; f(); const g = () => { console.log(`setTimeout: ${executionAsyncId()} ${triggerAsyncId()}`); setTimeout(() => { console.log(`inner setTimeout: ${executionAsyncId()} ${triggerAsyncId()}`); }, 0); }; setTimeout(g, 0); setTimeout(g, 0);
在上述代码中，我们使用 setTimeout 模拟一个异步调用过程，且在该异步过程中我们调用了 handler 同步函数，我们在每个函数内都输出其对应的 Async ID 和 Trigger Async ID 。执行上述代码后，其运行结果如下。
top level: 1 0 f: 1 0 setTimeout: 7 1 setTimeout: 9 1 inner setTimeout: 11 7 inner setTimeout: 13 9
通过上述日志输出，我们得出以下信息：
调用同步函数，不会改变其 Async ID ，如函数 f 内的 Async ID 和其调用者的 Async ID 相同。
同一个函数，被不同时刻进行异步调用，会分配至不同的 Async ID ，如上述代码中的 g 函数。
追踪异步资源
正如我们前面所说的，Async Hooks 可用于追踪异步资源。为了实现此目的，我们需要了解 Async Hooks 的相关 API ，具体说明参照以下代码中的注释。
const asyncHooks = require("async_hooks"); // 创建一个 AsyncHooks 实例。 const hooks = asyncHooks.createHook({ // 对象构造时会触发 init 事件。 init: function(asyncId, type, triggerId, resource) {}, // 在执行回调前会触发 before 事件。 before: function(asyncId) {}, // 在执行回调后会触发 after 事件。 after: function(asyncId) {}, // 在销毁对象后会触发 destroy 事件。 destroy: function(asyncId) {} }); // 允许该实例中对异步函数启用 hooks 。 hooks.enable(); // 关闭对异步资源的追踪。 hooks.disable();
我们在调用 createHook 时，可注入 init 、 before 、 after 和 destroy 函数，用于 追踪异步资源的不同生命周期 。
全新解决方案
基于 Async Hooks API ，我们即可设计以下解决方案，实现日志与请求记录的绑定，即 Trace ID 的全局绑定。