在 node.js 中使用带有 async / await 的文件系统

Question

我想在一些文件系统操作中使用 async/await。通常 async/await 工作正常，因为我使用babel-plugin-syntax-async-functions。

但是使用这段代码，我遇到了names 未定义的 if 情况：

import fs from 'fs';

async function myF() {
  let names;
  try {
    names = await fs.readdir('path/to/dir');
  } catch (e) {
    console.log('e', e);
  }
  if (names === undefined) {
    console.log('undefined');
  } else {
    console.log('First Name', names[0]);
  }
}

myF();

当我将代码重建为回调地狱版本时，一切正常，我得到了文件名。 感谢您的提示。

Answer 1

自 Node 11 起对 async await fs 函数的原生支持

从 Node.JS 11.0.0（稳定版）和 10.0.0 版（实验版）开始，您可以访问已经承诺的文件系统方法，并且可以将它们与 try catch 异常处理一起使用，而不是检查如果回调的返回值包含错误。

API 非常简洁优雅！只需使用fs 对象的.promises 成员：

import fs from 'fs';
const fsPromises = fs.promises;

async function listDir() {
  try {
    return fsPromises.readdir('path/to/dir');
  } catch (err) {
    console.error('Error occured while reading directory!', err);
  }
}

listDir();

Answer 2

从节点 8.0.0 开始，你可以使用这个：

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

const readdir = util.promisify(fs.readdir);

async function myF() {
  let names;
  try {
    names = await readdir('path/to/dir');
  } catch (err) {
    console.log(err);
  }
  if (names === undefined) {
    console.log('undefined');
  } else {
    console.log('First Name', names[0]);
  }
}

myF();

见https://nodejs.org/dist/latest-v8.x/docs/api/util.html#util_util_promisify_original

Answer 3

Node.js 8.0.0

本机异步/等待

承诺

从这个版本开始，您可以使用 util 库中的原生 Node.js 函数。

const fs = require('fs')
const { promisify } = require('util')

const readFileAsync = promisify(fs.readFile)
const writeFileAsync = promisify(fs.writeFile)

const run = async () => {
  const res = await readFileAsync('./data.json')
  console.log(res)
}

run()

---

承诺包装

const fs = require('fs')

const readFile = (path, opts = 'utf8') =>
  new Promise((resolve, reject) => {
    fs.readFile(path, opts, (err, data) => {
      if (err) reject(err)
      else resolve(data)
    })
  })

const writeFile = (path, data, opts = 'utf8') =>
  new Promise((resolve, reject) => {
    fs.writeFile(path, data, opts, (err) => {
      if (err) reject(err)
      else resolve()
    })
  })

module.exports = {
  readFile,
  writeFile
}

...


// in some file, with imported functions above
// in async block
const run = async () => {
  const res = await readFile('./data.json')
  console.log(res)
}

run()

建议

如果您不想重新抛出异常，请始终将 try..catch 用于等待块。

Answer 4

从 v10.0 开始，您可以使用fs.Promises

使用readdir 的示例

const { promises: fs } = require("fs");

async function myF() {
    let names;
    try {
        names = await fs.readdir("path/to/dir");
    } catch (e) {
        console.log("e", e);
    }
    if (names === undefined) {
        console.log("undefined");
    } else {
        console.log("First Name", names[0]);
    }
}

myF();

使用readFile 的示例

const { promises: fs } = require("fs");

async function getContent(filePath, encoding = "utf-8") {
    if (!filePath) {
        throw new Error("filePath required");
    }

    return fs.readFile(filePath, { encoding });
}

(async () => {
    const content = await getContent("./package.json");

    console.log(content);
})();

Answer 5

您可能会产生错误的行为，因为 File-Api fs.readdir 不返回承诺。它只需要一个回调。如果你想使用 async-await 语法，你可以像这样“承诺”这个函数：

function readdirAsync(path) {
  return new Promise(function (resolve, reject) {
    fs.readdir(path, function (error, result) {
      if (error) {
        reject(error);
      } else {
        resolve(result);
      }
    });
  });
}

改为调用它：

names = await readdirAsync('path/to/dir');

Answer 6

这是问题的 TypeScript 版本。在Node 11.0之后可以使用：

import { promises as fs } from 'fs';

async function loadMonoCounter() {
    const data = await fs.readFile('monolitic.txt', 'binary');
    return Buffer.from(data);
}

Answer 7

节点 v14.0.0 及更高版本

你可以这样做：

import { readdir } from "fs/promises";

就像你从"fs"导入一样

查看此 PR 了解更多详情：https://github.com/nodejs/node/pull/31553

Answer 8

我有这个小帮助模块，可以导出 promisified 版本的 fs 函数

const fs = require("fs");
const {promisify} = require("util")

module.exports = {
  readdir: promisify(fs.readdir),
  readFile: promisify(fs.readFile),
  writeFile: promisify(fs.writeFile)
  // etc...
};

Answer 9

这对我有用：

const fsp = require('fs-promise');

(async () => {
  try {
    const names = await fsp.readdir('path/to/dir');
    console.log(names[0]);
  } catch (e) {
    console.log('error: ', e);
  }
})();

当启用harmony flag 时，此代码在没有 babel 的节点 7.6 中工作：node --harmony my-script.js。从节点 7.7 开始，you don't even need this flag!

开头包含的fsp 库只是fs（和fs-ext）的承诺包装器。

我真的很高兴这些天你可以在没有 babel 的情况下在 node 中做什么！原生async/await 让写代码成为一种享受！

2017-06 更新： fs-promise 模块已弃用。使用 fs-extra 代替相同的 API。

Answer 10

与自定义函数相比，建议使用 npm 包，例如 https://github.com/davetemplin/async-file。例如：

import * as fs from 'async-file';

await fs.rename('/tmp/hello', '/tmp/world');
await fs.appendFile('message.txt', 'data to append');
await fs.access('/etc/passd', fs.constants.R_OK | fs.constants.W_OK);

var stats = await fs.stat('/tmp/hello', '/tmp/world');

其他答案已过时

Answer 11

您可以使用简单轻量级的模块https://github.com/nacholibre/nwc-l，它同时支持异步和同步方法。

注意：这个模块是我创建的。