Як правильно читати файл з асинхронізуванням / очікувати?


120

Я не можу зрозуміти, як async/ awaitробіт. Я трохи розумію це, але не можу змусити його працювати.

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.js з async / await
KyleMit

Відповіді:


165

Для використання await/ asyncвам потрібні методи, які повертають обіцянки. Основні функції API не обходяться без обгортки типу promisify:

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зворотний виклик не приймає, він повертає дані або викидає виняток. Ви не отримуєте потрібне значення, оскільки функція, яку ви надаєте, ігнорується, і ви не фіксуєте фактичне повернене значення.


3
Дякую, я не знав, що мені потрібно завернути основний API. Ти надзвичайний.
Джеремі Дікайр

4
Основний API заздалегідь датує сучасну специфікацію Promise та прийняття async/ await, тому це необхідний крок. Хороша новина, як promisifyправило, змушує працювати без бардаку.
тадман

1
Це справляється з безладом неможливості нормально використовувати асинхрон-очікування за допомогою FS. Дякую за це! Ти врятував мене тонною! Немає відповіді, яка насправді вирішує таке, як ваше.
jacobhobson

3
Також чекайте, що це щось надлишкове, оскільки його можна заразити. Тільки якщо ви хочете, щоб явно чекали, наприклад, ви можете це зробити const file = await readFile...; return file;.
bigkahunaburger

1
@shijin Доки API API Node не перейде на обіцянки, що на даний момент навряд чи, тоді так. Однак є обгортки NPM, які роблять це за вас.
тадман

150

Оскільки обіцянки Node v11.0.0 fs доступні в оригіналі без promisify:

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

4
немає додаткових вуст, чистих і простих - на це слід краще відповісти
Адам Бубела

2
Станом на 21 жовтня 2019 року v12 є активною версією LTS
cbronson

16
import { promises as fs } from "fs";якщо ви хочете використовувати синтаксис імпорту.
tr3online

21

Це версія TypeScript відповіді @ Джоела. Він може бути використаний після Вузла 11.0:

import { promises as fs } from 'fs';

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

18

Ви можете легко обернути команду readFile такою обіцянкою:

async function readFile(path) {
    return new Promise((resolve, reject) => {
      fs.readFile(path, 'utf8', function (err, data) {
        if (err) {
          reject(err);
        }
        resolve(data);
      });
    });
  }

тоді використовуйте:

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

Не чекає, що використовується всередині функції async?
VikasBhat

@VikasBhat Так, рядок очікування вище буде використаний всередині іншої функції асинхронізації, оскільки специфікація вимагає, щоб це було так.
whoshotdk

8

Ви можете використовувати fs.promisesнаявні з Node v11.0.0

import fs from 'fs';

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

Якщо ви хочете використовувати лише обіцянки, ви можете зробити щось на кшталтconst fs = require('fs').promises
nathanfranke

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.