承诺将文件写入文件系统

Question

我有兴趣了解如何 Promisfy 这段代码：

const http = require('http');
const fs = require('fs');

const download = function(url, dest, cb) {
  let file = fs.createWriteStream(dest);
  const request = http.get(url, function(response) {
    response.pipe(file);
    file.on('finish', function() {
      file.close(cb);  // close() is async, call cb after close completes.
    });
  }).on('error', function(err) { // Handle errors
    fs.unlink(dest); // Delete the file async. (But we don't check the result)
    if (cb) cb(err.message);
  });
};

我对此的第一个看法是：

const http = require('http');
const fs = require('fs');

const download = async (url, dest, cb) => {
  let file = fs.createWriteStream(dest);
  const request = http.get(url, function(response) {
    response.pipe(file);
    file.on('finish', function() {
      const closed = await file.close(cb);  // close() is async, await here?
      if (closed) {
          // handle cleanup and retval
      }
    });
  }).on('error', function(err) { // Handle errors
    const deleted = await fs.unlink(dest); // Delete the file async. 
    if (!deleted) { ... }
  });
};

上面的实现显然是错误的。什么是正确的方法来删除回调并只使用 async/await？

Answer 1

这是一种在 Promise 中手动包装管道操作的方法。不幸的是，其中大部分只是错误处理，以涵盖所有可能发生错误的地方：

const http = require('http');
const fs = require('fs');

const download = function(url, dest) {
  return new Promise((resolve, reject) => {
      const file = fs.createWriteStream(dest);

      // centralize error cleanup function
      function cleanup(err) {
          reject(err);
          // cleanup partial results when aborting with an error
          file.on('close', () => {
            fs.unlink(dest);
          });
          file.end();
      }

      file.on('error', cleanup).on('finish', resolve);

      const request = http.get(url, function(response) {
        if (response.status < 200 || response.status >= 300) {
            cleanup(new Error(`Unexpected Request Status Code: ${response.status}`);
            return;
        }
        response.pipe(file);
        response.on('error', cleanup);

      }).on('error', cleanup);
  });
};

download(someURL, someDest).then(() => {
  console.log("operation complete");
}).catch(err => {
  console.log(err);
});

这不会等待文件在错误条件下被关闭或删除，然后再拒绝（认为如果这些清理操作无论如何都存在错误，通常没有任何建设性可做）。如果需要，只需从这些清理操作的异步回调中调用 reject(err) 或使用这些函数的 fs.promises 版本并等待它们即可轻松添加。

---

有几点需要注意。这主要是错误处理，因为在三个可能的地方可能会出现错误，并且某些错误需要进行一些清理工作。

1. 添加了必需的错误处理。

2. 在 OP 的原始代码中，他们调用 file.close()，但 file 是一个流，并且 writeStream 上没有 .close() 方法。你调用.end()关闭写流。

3. 您可能还需要检查适当的 response.status，因为即使状态为 4xx 或 5xx，http.get() 仍会返回响应对象和流。

Answer 2

以下是我如何将您的节点样式回调 API 重写为异步函数：

const http = require('http');
const fs = require('fs');

async function download (url, dest) {
  const response = await new Promise((resolve, reject) => {
    http.get(url, resolve).once('error', reject);
  });

  if (response.status < 200 || response.status >= 300) {
    throw new Error(`${responses.status} ${http.STATUS_CODES[response.status]}`);
  }

  const file = await fs.promises.open(dest, 'w');

  try {
    for await (const data of response) {
      await file.write(data);
    }
  } catch (error) {
    await file.close();
    await fs.promises.unlink(dest);
    throw error;
  }

  await file.close();
}

请注意，此方法使用fs.promises 命名空间中的FileHandle 类，以及在Readable 流类上定义的Symbol.asyncIterator 接口，它允许您使用@ 的data 事件987654332@ 和 for await...of 循环，并通过隐式拒绝底层异步迭代器返回的承诺，将错误处理从 response 的 error 事件传播到 catch 块。