JavaScript 异步上下文：管理请求范围的变量

异步编程是现代 JavaScript 开发的基石，尤其是在 Node.js 这样的环境中，非阻塞 I/O 对性能至关重要。然而，在异步操作中管理上下文可能具有挑战性。这时 JavaScript 的异步上下文，特别是 AsyncLocalStorage，就派上用场了。

什么是异步上下文？

异步上下文是指将数据关联到异步操作的能力，这些数据在其生命周期内保持不变。这对于需要跨多个异步调用维护请求范围信息（例如：用户 ID、请求 ID、跟踪信息）的场景至关重要。如果没有适当的上下文管理，调试、日志记录和安全性可能会变得更加困难。

在异步操作中维护上下文的挑战

随着异步代码复杂性的增加，通过函数调用显式传递变量等传统的上下文管理方法可能会变得繁琐且容易出错。回调地狱（callback hell）和 Promise 链可能会模糊上下文的流向，导致维护问题和潜在的安全漏洞。考虑这个简化的例子：


function processRequest(req, res) {
  const userId = req.userId;

  fetchData(userId, (data) => {
    transformData(userId, data, (transformedData) => {
      logData(userId, transformedData, () => {
        res.send(transformedData);
      });
    });
  });
}

在此示例中，userId 被反复地通过嵌套的回调传递。这种方法不仅冗长，而且将函数紧密耦合，降低了它们的可重用性并增加了测试难度。

介绍 AsyncLocalStorage

AsyncLocalStorage 是 Node.js 中的一个内置模块，它提供了一种存储特定异步上下文本地数据的机制。它允许您设置和检索在同一执行上下文的异步边界内自动传播的值。这极大地简化了请求范围变量的管理。

AsyncLocalStorage 如何工作

AsyncLocalStorage 通过创建与当前异步操作关联的存储上下文来工作。当发起新的异步操作时（例如，Promise、回调），存储上下文会自动传播到新操作。这确保了在整个异步调用链中都可以访问相同的数据。

AsyncLocalStorage 的基本用法

以下是如何使用 AsyncLocalStorage 的基本示例：


const { AsyncLocalStorage } = require('async_hooks');

const asyncLocalStorage = new AsyncLocalStorage();

function processRequest(req, res) {
  const userId = req.userId;

  asyncLocalStorage.run(new Map(), () => {
    asyncLocalStorage.getStore().set('userId', userId);

    fetchData().then(data => {
      return transformData(data);
    }).then(transformedData => {
      return logData(transformedData);
    }).then(() => {
      res.send(transformedData);
    });
  });
}

async function fetchData() {
  const userId = asyncLocalStorage.getStore().get('userId');
  // ... 使用 userId 获取数据
  return data;
}

async function transformData(data) {
  const userId = asyncLocalStorage.getStore().get('userId');
  // ... 使用 userId 转换数据
  return transformedData;
}

async function logData(data) {
  const userId = asyncLocalStorage.getStore().get('userId');
  // ... 使用 userId 记录数据
  return;
}

在此示例中：

我们创建了 AsyncLocalStorage 的一个实例。
在 processRequest 函数中，我们使用 asyncLocalStorage.run 在新的存储实例（此处为 Map）的上下文中执行一个函数。
我们使用 asyncLocalStorage.getStore().set('userId', userId) 在存储中设置 userId。
在异步操作（fetchData、transformData、logData）中，我们可以使用 asyncLocalStorage.getStore().get('userId') 检索 userId。

AsyncLocalStorage 的用例

AsyncLocalStorage 在以下场景中特别有用：

1. 请求跟踪

在分布式系统中，跨多个服务跟踪请求对于监控性能和识别瓶颈至关重要。AsyncLocalStorage 可用于存储一个唯一的请求 ID，该 ID 会在服务边界之间传播。这允许您关联来自不同服务的日志和指标，从而全面了解请求的历程。例如，考虑一个微服务架构，其中用户请求通过 API 网关、身份验证服务和数据处理服务。使用 AsyncLocalStorage，可以在 API 网关生成唯一的请求 ID，并将其自动传播到处理请求的所有后续服务。

2. 日志上下文

在记录事件时，通常需要包含上下文信息，例如用户 ID、请求 ID 或会话 ID。AsyncLocalStorage 可用于自动将此信息包含在日志消息中，从而更轻松地调试和分析问题。设想一个场景，您需要在应用程序中跟踪用户活动。通过将用户 ID 存储在 AsyncLocalStorage 中，您可以将其自动包含在与该用户会话相关的所有日志消息中，从而提供对其行为和可能遇到的问题的宝贵见解。

3. 身份验证和授权

AsyncLocalStorage 可用于存储身份验证和授权信息，例如用户的角色和权限。这使您无需将用户的凭据显式传递给每个函数，即可在整个应用程序中强制执行访问控制策略。考虑一个电子商务应用程序，其中不同的用户具有不同的访问级别（例如：管理员、普通客户）。通过将用户的角色存储在 AsyncLocalStorage 中，您可以在允许他们执行某些操作之前轻松检查其权限，确保只有授权用户才能访问敏感数据或功能。

4. 数据库事务

在处理数据库时，通常需要在多个异步操作之间管理事务。AsyncLocalStorage 可用于存储数据库连接或事务对象，确保同一请求内的所有操作都在同一事务中执行。例如，如果用户正在下订单，您可能需要更新多个表（例如：orders、order_items、inventory）。通过将数据库事务对象存储在 AsyncLocalStorage 中，您可以确保所有这些更新都在单个事务中执行，保证原子性和一致性。

5. 多租户

在多租户应用程序中，隔离每个租户的数据和资源至关重要。AsyncLocalStorage 可用于存储租户 ID，从而根据当前租户动态地将请求路由到适当的数据存储或资源。设想一个 SaaS 平台，其中多个组织使用相同的应用程序实例。通过将租户 ID 存储在 AsyncLocalStorage 中，您可以确保每个组织的数据保持分离，并且他们只能访问自己的资源。

使用 AsyncLocalStorage 的最佳实践

虽然 AsyncLocalStorage 是一个强大的工具，但谨慎使用它以避免潜在的性能问题并保持代码清晰非常重要。以下是一些需要牢记的最佳实践：

1. 最小化数据存储

只在 AsyncLocalStorage 中存储绝对必要的数据。存储大量数据会影响性能，尤其是在高并发环境中。例如，与其存储整个用户对象，不如存储用户 ID，并在需要时从缓存或数据库中检索用户对象。

2. 避免过度的上下文切换

频繁的上下文切换也会影响性能。尽量减少设置和检索 AsyncLocalStorage 中值的次数。将频繁访问的值缓存到函数内的本地，以减少访问存储上下文的开销。例如，如果您需要在函数内多次访问用户 ID，请从 AsyncLocalStorage 中检索一次，并将其存储在局部变量中以供后续使用。

3. 使用清晰一致的命名约定

为存储在 AsyncLocalStorage 中的键使用清晰一致的命名约定。这将提高代码的可读性和可维护性。例如，为所有与特定功能或域相关的键使用一致的前缀，例如 request.id 或 user.id。

4. 使用后清理

虽然 AsyncLocalStorage 在异步操作完成时会自动清理存储上下文，但在不再需要时显式清除存储上下文是一个好习惯。这有助于防止内存泄漏并提高性能。您可以通过使用 exit 方法显式清除上下文来实现这一点。

5. 考虑性能影响

注意使用 AsyncLocalStorage 对性能的影响，尤其是在高并发环境中。对您的代码进行基准测试，以确保其满足您的性能要求。对您的应用程序进行性能分析，以识别与上下文管理相关的潜在瓶颈。如果 AsyncLocalStorage 引入了不可接受的性能开销，请考虑其他方法，例如显式上下文传递。

6. 在库中谨慎使用

避免在旨在通用使用的库中直接使用 AsyncLocalStorage。库不应假定其使用上下文。而是提供选项供用户显式传递上下文信息。这允许用户控制其应用程序中的上下文管理方式，并避免潜在的冲突或意外行为。

AsyncLocalStorage 的替代方案

虽然 AsyncLocalStorage 是一个方便强大的工具，但它并非总是最适合所有场景的解决方案。以下是一些可以考虑的替代方案：

1. 显式上下文传递

最简单的方法是将上下文信息作为参数显式传递给函数。这种方法简单明了，但随着代码复杂性的增加，它可能会变得很麻烦。显式上下文传递适用于上下文相对较小且代码嵌套不深的简单场景。但是，对于更复杂的场景，它可能导致代码难以阅读和维护。

2. 上下文对象

与其传递单个变量，不如创建一个上下文对象来封装所有上下文信息。这可以简化函数签名，提高代码的可读性。上下文对象是显式上下文传递和 AsyncLocalStorage 之间的良好折衷。它们提供了一种将相关上下文信息分组的方法，使代码更具组织性，并且更易于理解。但是，它们仍然需要将上下文对象显式传递给每个函数。

3. Async Hooks（用于诊断）

Node.js 的 async_hooks 模块提供了更通用的机制来跟踪异步操作。虽然它比 AsyncLocalStorage 更复杂，但它提供了更大的灵活性和控制力。async_hooks 主要用于诊断和调试目的。它允许您跟踪异步操作的生命周期并收集有关其执行的信息。但是，由于其潜在的性能开销，不建议将其用于通用上下文管理。

4. 诊断上下文（OpenTelemetry）

OpenTelemetry 提供了收集和导出遥测数据（包括跟踪、指标和日志）的标准 API。其诊断上下文功能为分布式系统中的上下文传播提供了高级而健壮的解决方案。与 OpenTelemetry 集成提供了一种独立于供应商的方式，以确保跨不同服务和平台的上下文一致性。这在需要跨服务边界传播上下文的复杂微服务架构中尤其有用。

实际示例

让我们探讨一些 AsyncLocalStorage 在不同场景下的实际使用示例。

1. 电子商务应用程序：请求跟踪

在电子商务应用程序中，您可以使用 AsyncLocalStorage 来跟踪跨多个服务（例如：产品目录、购物车和支付网关）的用户请求。这使您能够监控每个服务的性能，并识别可能影响用户体验的瓶颈。


// 在 API 网关中
const { AsyncLocalStorage } = require('async_hooks');
const { v4: uuidv4 } = require('uuid');

const asyncLocalStorage = new AsyncLocalStorage();

app.use((req, res, next) => {
  const requestId = uuidv4();
  asyncLocalStorage.run(new Map(), () => {
    asyncLocalStorage.getStore().set('requestId', requestId);
    res.setHeader('X-Request-Id', requestId);
    next();
  });
});

// 在产品目录服务中
async function getProductDetails(productId) {
  const requestId = asyncLocalStorage.getStore().get('requestId');
  // 与其他详细信息一起记录请求 ID
  logger.info(`[${requestId}] Fetching product details for product ID: ${productId}`);
  // ... 获取产品详细信息
}

2. SaaS 平台：多租户

在 SaaS 平台中，您可以使用 AsyncLocalStorage 来存储租户 ID，并根据当前租户动态地将请求路由到适当的数据存储或资源。这确保了每个租户的数据保持分离，并且他们只能访问自己的资源。


// 提取请求中租户 ID 的中间件
app.use((req, res, next) => {
  const tenantId = req.headers['x-tenant-id'];
  asyncLocalStorage.run(new Map(), () => {
    asyncLocalStorage.getStore().set('tenantId', tenantId);
    next();
  });
});

// 获取特定租户数据的函数
async function fetchData(query) {
  const tenantId = asyncLocalStorage.getStore().get('tenantId');
  const db = getDatabaseConnection(tenantId);
  return db.query(query);
}

3. 微服务架构：日志上下文

在微服务架构中，您可以使用 AsyncLocalStorage 来存储用户 ID，并将其自动包含在来自不同服务的日志消息中。这使得调试和分析可能影响特定用户的问题更加容易。


// 在身份验证服务中
app.use((req, res, next) => {
  const userId = req.user.id;
  asyncLocalStorage.run(new Map(), () => {
    asyncLocalStorage.getStore().set('userId', userId);
    next();
  });
});

// 在数据处理服务中
async function processData(data) {
  const userId = asyncLocalStorage.getStore().get('userId');
  logger.info(`[User ID: ${userId}] Processing data: ${JSON.stringify(data)}`);
  // ... 处理数据
}

结论

AsyncLocalStorage 是管理异步 JavaScript 环境中请求范围变量的宝贵工具。它简化了跨异步操作的上下文管理，使代码更易于阅读、维护和安全。通过了解其用例、最佳实践和替代方案，您可以有效地利用 AsyncLocalStorage 来构建健壮且可扩展的应用程序。但是，仔细考虑其性能影响并明智地使用它以避免潜在问题至关重要。拥抱 AsyncLocalStorage 是一种深思熟虑的方式，可以改进您的异步 JavaScript 开发实践。

通过包含清晰的示例、实用的建议和全面的概述，本指南旨在为全球开发人员提供知识，让他们能够有效地使用 AsyncLocalStorage 在其 JavaScript 应用程序中管理异步上下文。请记住考虑性能影响和替代方案，以确保为您的特定需求提供最佳解决方案。