node-mssql 流式查询与异步/等待模式的最佳实践

在使用 node-mssql 进行数据库操作时，流式查询(streaming)是一个非常有用的特性，特别是在处理大量数据时。然而，当开发者尝试将流式查询与 async/await 语法结合使用时，可能会遇到一些意料之外的行为。本文将深入探讨这个问题，并提供正确的使用方式。

问题现象

当开发者使用以下模式时，可能会发现事件监听器没有被触发：

async function main() {
  await sql.connect(config);
  const request = new sql.Request();
  request.stream = true;

  await request.query(`select 1`);  // 这里使用了await
  request.on('row', (row) => {      // 事件监听器在查询后添加
    console.log(row);               // 永远不会执行
  });

  await new Promise((resolve) => {
    request.on('done', () => {      // 同样不会执行
      console.log('done');
      resolve();
    });
  });
  await sql.close();
}

原因分析

这个问题的根本原因在于 JavaScript 的事件循环机制和 async/await 的工作方式：

1. 当调用 await request.query() 时，函数执行会暂停，直到查询完全完成
2. 查询完成后才会继续执行后面的代码，添加事件监听器
3. 此时查询已经结束，自然无法捕获到任何事件

正确使用方式

方法一：先添加监听器再执行查询

async function main() {
  await sql.connect(config);
  const request = new sql.Request();
  request.stream = true;

  // 先添加事件监听器
  request.on('row', (row) => {
    console.log(row);
  });

  const donePromise = new Promise((resolve) => {
    request.on('done', () => {
      console.log('done');
      resolve();
    });
  });

  // 然后执行查询
  await request.query(`select 1`);
  await donePromise;
  await sql.close();
}

方法二：不使用 await 执行查询

async function main() {
  await sql.connect(config);
  const request = new sql.Request();
  request.stream = true;

  // 直接执行查询而不await
  request.query(`select 1`);

  request.on('row', (row) => {
    console.log(row);
  });

  await new Promise((resolve) => {
    request.on('done', () => {
      console.log('done');
      resolve();
    });
  });
  await sql.close();
}

技术原理

在 node-mssql 中，流式查询的实现基于事件发射器(EventEmitter)模式。当启用流式查询时：

1. query() 方法会立即开始执行查询
2. 数据库返回的数据会通过 'row' 事件逐个发射
3. 查询完成后会发射 'done' 事件
4. 同时，query() 方法返回的 Promise 会在查询完全结束后解析

这种设计意味着在流式模式下，Promise 的解析实际上表示查询的结束，而不是开始。这与许多开发者的直觉相反，因此容易导致误解。

最佳实践建议

1. 避免混用流式和 Promise：如果使用流式查询，最好完全依赖事件机制，不要同时使用 await

2. 考虑使用 toReadableStream()：node-mssql 提供了更标准的流接口，可能更适合现代 Node.js 应用

3. 始终处理错误事件：流式查询应该添加 'error' 事件处理器，避免未捕获的异常

4. 注意资源释放：确保在 'done' 或 'error' 事件中正确关闭连接

5. 文档先行：在使用不熟悉的 API 时，仔细阅读文档，理解各种模式的行为差异

总结

node-mssql 的流式查询功能强大，但需要正确理解其工作方式才能有效使用。关键在于认识到在流式模式下，query() 返回的 Promise 表示查询完成而非开始。通过遵循本文介绍的模式，开发者可以避免常见陷阱，编写出高效可靠的数据库查询代码。