Методы работы с файлами в Node.js

Модуль fs Node.js

Для работы с файлами в Node.js предназначен модуль fs, который позволяет взаимодействовать с файловой системой по образцу стандартных функций POSIX (Portable Operating System Interface — переносимый интерфейс операционных систем, набор стандартов, описывающих интерфейсы между операционной системой и прикладной программой (системный API), библиотеку языка C и набор приложений и их интерфейсов).

Документация...

Читай также Работа с модулями в Node.JS

Для использования API модуля fs его необходимо импортировать:

на основе Promise (Promises API подробнее):

import * as fs from 'fs/promises';

1	import * as fs from 'fs/promises';

на основе API обратного вызова (Callback API подробнее) и синхронных функций (API подробнее):

import * as fs from 'fs';

1	import * as fs from 'fs';

Все операции файловой системы имеют API формы синхронных функций, формы функций обратного вызова и Promises, и доступны с использованием как синтаксиса CommonJS, так и модулей ES6 (ESM).

Версии API-интерфейсов модуля fs на основе обратного вызова (callback) предпочтительнее использования API-интерфейсов обещаний, когда требуется максимальная производительность (как с точки зрения времени выполнения, так и с точки зрения выделения памяти).

Пример на основе Promise

Операции на основе Promise возвращают promise, которое выполняется после завершения асинхронной операции (пример):

import { unlink } from 'fs/promises';

try {
  await unlink('/tmp/hello');
  console.log('successfully deleted /tmp/hello');
} catch (error) {
  console.error('there was an error:', error.message);
}

import { unlink } from 'fs/promises';

try {

await unlink('/tmp/hello');

console.log('successfully deleted /tmp/hello');

} catch (error) {

console.error('there was an error:', error.message);

}

[свернуть]

Пример на основе фyнкции обратного вызова (callback)

Форма на основе callback принимает функцию обратного вызова в качестве последнего аргумента и вызывает операцию асинхронно (первый аргумент всегда зарезервирован для исключения). Аргументы, передаваемые в callback, зависят от метода.

Если операция завершена успешно, то первый аргумент имеет значение null или undefined.

import { unlink } from 'fs';

unlink('/tmp/hello', (err) => {
  if (err) throw err;
  console.log('successfully deleted /tmp/hello');
});

import { unlink } from 'fs';

unlink('/tmp/hello', (err) => {

if (err) throw err;

console.log('successfully deleted /tmp/hello');

});

[свернуть]

Пример на основе синхронных вызовов

Синхронные вызовы блокируют цикл событий Node.js и дальнейшее выполнение JavaScript до завершения операции. Исключения генерируются немедленно и могут быть обработаны с помощью try…catch или могут всплывать.

import { unlinkSync } from 'fs';

try {
  unlinkSync('/tmp/hello');
  console.log('successfully deleted /tmp/hello');
} catch (err) {
  // handle the error
}

import { unlinkSync } from 'fs';

try {

unlinkSync('/tmp/hello');

console.log('successfully deleted /tmp/hello');

} catch (err) {

// handle the error

}

[свернуть]

Чтение из файла в Node.js

Допустим, в папке с файлом приложения app.js расположен текстовый файл hello.txt. Перед использованием методов необходимо импортировать нужную функциональность, например:

import { writeFile, readFileSync, readFile } from "fs";

1	import { writeFile, readFileSync, readFile } from "fs";

Для чтения текстового файла hello.txt в синхронном варианте применяется функция fs.readFileSync("path" [, options]):

let fileContent = readFileSync("./node/hello.txt", "utf8");
console.log(fileContent);

1 2	let fileContent = readFileSync("./node/hello.txt", "utf8"); console.log(fileContent);

где

"path" - имя или дескриптор файла (например, путь к файлу относительно файла приложения app.js);
[, options] (например, "utf8" - кодировка для получения текстового содержимого файла).

Функция fs.readFileSync() вернет считанный текст.

Для асинхронного чтения файла применяется функция fs.readFile(path[, options], callback) (подробнее):

import { readFile } from "fs";
readFile("hello.txt", "utf8", function(error,data){ });

1 2	import { readFile } from "fs"; readFile("hello.txt", "utf8", function(error,data){ });

где

"path" - имя или дескриптор файла (например, путь к файлу относительно файла приложения app.js);
[, options] (например, "utf8" - кодировка для получения текстового содержимого файла);
function(error,data){ } - функция обратного вызова, которая выполняется после завершения чтения (первый параметр функции хранит информацию об ошибке при её наличии, а второй - собственно считанные данные).

Например:

import { readFile } from 'node:fs/promises';

readFile("./node/hello.txt", "utf8", function (error, data) {
  console.log("Асинхронное чтение файла");
  if (error) throw error; // если возникла ошибка
  console.log(data); // выводим прочитанные данные (содержимое hello.txt)
});

import { readFile } from 'node:fs/promises';

readFile("./node/hello.txt", "utf8", function (error, data) {

console.log("Асинхронное чтение файла");

if (error) throw error; // если возникла ошибка

console.log(data); // выводим прочитанные данные (содержимое hello.txt)

});

Вычисление hash-суммы файла (асинхронное чтение)

// Функция, которая вычисляет хэш SHA256 для файла fileToHash.txt и записывает его в консоль как hex
import { createHash } from 'crypto'
import { readFile } from 'node:fs/promises';
import { fileURLToPath } from 'url';
import * as path from 'path'

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename)

const FILE_NAME = path.join(__dirname, 'files', 'fileToHash.txt')

const calculateHash = async () => {
      const inputData = await readFile(FILE_NAME)
      const fileHash = createHash('sha256').update(inputData).digest('hex')
      console.log("fileHash (hex)", fileHash)
};

await calculateHash();

// Функция, которая вычисляет хэш SHA256 для файла fileToHash.txt и записывает его в консоль как hex

import { createHash } from 'crypto'

import { readFile } from 'node:fs/promises';

import { fileURLToPath } from 'url';

import * as path from 'path'

const __filename = fileURLToPath(import.meta.url);

const __dirname = path.dirname(__filename)

const FILE_NAME = path.join(__dirname, 'files', 'fileToHash.txt')

const calculateHash = async () => {

const inputData = await readFile(FILE_NAME)

const fileHash = createHash('sha256').update(inputData).digest('hex')

console.log("fileHash (hex)", fileHash)

};

await calculateHash();

[свернуть]

Запись файла в Node.js

Для записи файла используются функции:

в синхронном варианте - writeFileSync(file, data[, options]);
в асинхронном варианте - writeFile(file, data[, options]).

Вышеуказанные методы полностью перезаписывают файл. Если надо дописать файл (присоединить данные к концу файла), то применяются методы appendFile() и appendFileSync().

Пример

appendFile("./node/hello.txt", "Привет? это добавка!", function (error) {
  if (error) throw error; // если ошибка
  
  console.log("Запись файла завершена. Содержимое файла:");
  let data = readFileSync("./node/hello.txt", "utf8");
  console.log(data); // выводим прочитанные данные
});

appendFile("./node/hello.txt", "Привет? это добавка!", function (error) {

if (error) throw error; // если ошибка

console.log("Запись файла завершена. Содержимое файла:");

let data = readFileSync("./node/hello.txt", "utf8");

console.log(data); // выводим прочитанные данные

});

Ещё пример:

Модуль constants.js

import * as path from 'path'
import url from 'url'

export const FILE_PATH = url.fileURLToPath(import.meta.url)
export const DIR_PATH = path.dirname(FILE_PATH)
export const ERROR_MSG = 'FS operation failed'
export const SUCCESS_MSG = 'FS operation success'

import * as path from 'path'

import url from 'url'

export const FILE_PATH = url.fileURLToPath(import.meta.url)

export const DIR_PATH = path.dirname(FILE_PATH)

export const ERROR_MSG = 'FS operation failed'

export const SUCCESS_MSG = 'FS operation success'

[свернуть]

import * as fs from 'node:fs/promises';
import { DIR_PATH, ERROR_MSG, SUCCESS_MSG } from './constants.js'

const FILE_NAME = 'fresh.txt'
const FILE_CONTENT = 'I am fresh and young'

const create = async () => {
    try {
        await fs.writeFile(`${DIR_PATH}/files/${FILE_NAME}`, FILE_CONTENT, { flag: 'wx' })
            .then(() => {
                console.info(SUCCESS_MSG)
            })
    } catch (error) {
        throw new Error(ERROR_MSG);
    }
}

await create();

import * as fs from 'node:fs/promises';

import { DIR_PATH, ERROR_MSG, SUCCESS_MSG } from './constants.js'

const FILE_NAME = 'fresh.txt'

const FILE_CONTENT = 'I am fresh and young'

const create = async () => {

try {

await fs.writeFile(`${DIR_PATH}/files/${FILE_NAME}`, FILE_CONTENT, { flag: 'wx' })

.then(() => {

console.info(SUCCESS_MSG)

})

} catch (error) {

throw new Error(ERROR_MSG);

}

await create();

[свернуть]

Удаление файла в Node.js

Для удаления файла используются функции:

в синхронном варианте - unlinkSync(path);
в асинхронном варианте - unlinkSync(path).

Пример (с promise)

import { unlink } from "fs/promises";

try {
  unlink("./node/hello.txt");
  console.log("успешное удаление ./node/hello.txt");
} catch (error) {
  console.error("there was an error:", error.message);
}

import { unlink } from "fs/promises";

try {

unlink("./node/hello.txt");

console.log("успешное удаление ./node/hello.txt");

} catch (error) {

console.error("there was an error:", error.message);

}

Еще пример:

import { existsSync, unlink } from "node:fs"

const delFilePath = './src/fs/files/fileToRemove.txt'

const remove = async (delFilePath) => {
    try {
        if (existsSync(delFilePath)) {
            unlink(delFilePath, (err) => {
                if (err) throw "Delete operation failed";
            })
        } else {
            throw "FS operation failed (file is missing)"
        }
    } catch (error) {
        console.error("ERROR: ", error)
    }
};

await remove(delFilePath);

import { existsSync, unlink } from "node:fs"

const delFilePath = './src/fs/files/fileToRemove.txt'

const remove = async (delFilePath) => {

try {

if (existsSync(delFilePath)) {

unlink(delFilePath, (err) => {

if (err) throw "Delete operation failed";

})

} else {

throw "FS operation failed (file is missing)"

}

} catch (error) {

console.error("ERROR: ", error)

}

};

await remove(delFilePath);

[свернуть]

Модуль fs Node.js

Для использования API модуля fs его необходимо импортировать:

Чтение из файла в Node.js

Запись файла в Node.js

Удаление файла в Node.js

Добавить комментарий Отменить ответ