关于node.js:如何正确使用async / await读取文件?

How to read file with async/await properly?

我无法弄清楚async / await的工作方式。 我有点理解,但无法使其正常工作。

1
2
3
4
5
6
7
8
9
function loadMonoCounter() {
    fs.readFileSync("monolitic.txt","binary", async function(err, data) {
       return await new Buffer( data);
  });
}

module.exports.read = function() {
  console.log(loadMonoCounter());
};

我知道我可以使用readFileSync,但是如果这样做,我知道我永远不会理解async / await,而我只会埋葬这个问题。

目标:调用loadMonoCounter()并返回文件的内容。

每次调用incrementMonoCounter()(每个页面加载)时,该文件都会递增。 该文件包含二进制缓冲区的转储,并存储在SSD中。

无论我做什么,我都会在控制台中收到错误或undefined


由于Node v11.0.0 fs promises可以直接在没有promisify的情况下使用:

1
2
3
4
5
const fs = require('fs').promises;
async function loadMonoCounter() {
    const data = await fs.readFile("monolitic.txt","binary");
    return new Buffer(data);
}


要使用await / async,您需要返回promise的方法。如果没有promisify这样的包装器,核心API函数就不会这样做:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
const fs = require('fs');
const util = require('util');

// Convert fs.readFile into Promise version of same    
const readFile = util.promisify(fs.readFile);

function getStuff() {
  return readFile('test');
}

// Can't use `await` outside of an async function so you need to chain
// with then()
getStuff().then(data => {
  console.log(data);
})

注意,readFileSync不会进行回调,它会返回数据或引发异常。您没有得到想要的值,因为您提供的函数将被忽略,并且您没有捕获实际的返回值。


这是@Joel答案的TypeScript版本。在节点11.0之后可用:

1
2
3
4
5
6
import { promises as fs } from 'fs';

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

您可以像这样用promise轻松包装readFile命令:

1
2
3
4
5
6
7
8
9
10
async function readFile(path) {
    return new Promise((resolve, reject) => {
      fs.readFile(path, 'utf8', function (err, data) {
        if (err) {
          reject(err);
        }
        resolve(data);
      });
    });
  }

然后使用:

1
await readFile("path/to/file");


您可以使用从Node v11.0.0开始本地可用的fs.promises

1
2
3
4
5
6
7
8
9
10
11
import fs from 'fs';

const readFile = async filePath => {
  try {
    const data = await fs.promises.readFile(filePath, 'utf8')
    return data
  }
  catch(err) {
    console.log(err)
  }
}


有一个fs.readFileSync( path, options )方法,该方法是同步的。


为了使其简洁并保留fs的所有功能:

1
2
3
4
5
6
7
const fs = require('fs');
const fsPromises = fs.promises;

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

分别导入fsfs.promises将提供对整个fs API的访问权限,同时还使其更具可读性...因此,很容易完成下一个示例。

1
2
3
4
// the 'next example'
fsPromises.access('monolitic.txt', fs.constants.R_OK | fs.constants.W_OK)
    .then(() => console.log('can access'))
    .catch(() => console.error('cannot access'));