Node.js中如何取消WriteFile操作？

原生的fs.promises.writeFile没有内置取消机制，因为它的Promise封装不支持中断正在进行的IO操作，但可以通过以下方式实现取消功能：

1. Node.js 18+ 用内置AbortController实现 #

从Node.js 18开始，fs.promises.writeFile支持传入AbortSignal参数，借助AbortController可直接中断写入：

const { writeFile } = require('fs').promises;

// 创建控制器与信号
const abortController = new AbortController();
const { signal } = abortController;

// 启动写入任务
const writeTask = writeFile('./target.txt', '待写入内容', { signal });

// 模拟延迟取消（可根据业务场景触发）
setTimeout(() => {
  abortController.abort();
}, 100);

// 处理结果或取消错误
try {
  await writeTask;
  console.log('写入完成');
} catch (err) {
  if (err.name === 'AbortError') {
    console.log('写入操作已取消');
  } else {
    console.error('写入失败:', err);
  }
}

2. 低版本Node.js用p-cancelable封装可取消Promise #

如果你的Node.js版本低于18，可使用p-cancelable库封装writeFile实现取消能力：

先安装依赖：

npm install p-cancelable

封装并使用：

const { writeFile } = require('fs').promises;
const PCancelable = require('p-cancelable');

const cancelableWriteFile = (path, data, options = {}) => {
  return new PCancelable((resolve, reject, onCancel) => {
    const controller = new AbortController();
    const signal = controller.signal;

    // 注册取消回调
    onCancel(() => controller.abort());

    // 执行写入
    writeFile(path, data, { ...options, signal })
      .then(resolve)
      .catch(reject);
  });
};

// 使用示例
const writeTask = cancelableWriteFile('./target.txt', '待写入内容');

// 主动取消操作
writeTask.cancel(new Error('主动取消写入'));

// 处理结果
try {
  await writeTask;
} catch (err) {
  if (err.message === '主动取消写入') {
    console.log('写入已取消');
  } else {
    console.error('写入出错:', err);
  }
}

关键注意点 #

• 取消操作只能中断未完成的写入部分，已写入的内容会保留在文件中。
• 如果需要原子性写入（要么完全成功，要么无残留），可以先写临时文件，成功后重命名为目标文件，取消时删除临时文件：

const { writeFile, rename, unlink } = require('fs').promises;
const path = require('path');

const atomicCancelableWrite = (targetPath, data, options = {}) => {
  const tempPath = `${targetPath}.tmp`;
  const controller = new AbortController();
  const { signal } = controller;

  const writePromise = (async () => {
    try {
      await writeFile(tempPath, data, { ...options, signal });
      await rename(tempPath, targetPath);
    } catch (err) {
      if (err.name === 'AbortError') {
        // 取消时清理临时文件
        try {
          await unlink(tempPath);
        } catch (cleanupErr) {
          console.warn('清理临时文件失败:', cleanupErr);
        }
      }
      throw err;
    }
  })();

  return {
    promise: writePromise,
    cancel: () => controller.abort()
  };
};

// 使用示例
const { promise, cancel } = atomicCancelableWrite('./test.txt', '原子写入内容');

// 取消操作
cancel();

try {
  await promise;
} catch (err) {
  if (err.name === 'AbortError') {
    console.log('原子写入已取消，无残留文件');
  }
}

内容的提问来源于stack exchange，提问作者imv