Модуль fs (File System) в Node.js — это мощный инструмент для работы с файловой системой, позволяющий взаимодействовать с файлами и каталогами на вашем сервере. Он встроен в Node.js, поэтому для его использования не нужно устанавливать ничего дополнительного. Давайте рассмотрим, как работает fs и ее ключевые функции.

1. Что такое модуль fs?

Модуль fs предоставляет API для взаимодействия с файловой системой способом, близким к стандартным функциям POSIX. Этот модуль используется для таких задач, как чтение и запись файлов, создание каталогов и т. д.

2. Базовая настройка

Чтобы использовать модуль fs, вам необходимо указать его в начале скрипта Node.js:

const fs = require('fs');

3. Чтение файлов

Существует два основных способа чтения файлов: асинхронно и синхронно.

Асинхронное чтение

Этот метод неблокирующий, то есть он не останавливает выполнение вашей программы во время чтения файла.

fs.readFile('example.txt', 'utf8', (err, data) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log(data);
});

• 'example.txt': файл, который вы хотите прочитать.
• 'utf8': указывает используемую кодировку.
• Функция обратного вызова: обрабатывает ошибку и данные файла.

Синхронное чтение

Этот метод является блокирующим, то есть он останавливает выполнение вашей программы до тех пор, пока файл не будет прочитан.

try {
    const data = fs.readFileSync('example.txt', 'utf8');
    console.log(data);
} catch (err) {
    console.error(err);
}

4. Запись файлов

Подобно чтению файлов, запись также может выполняться асинхронно или синхронно.

Асинхронное письмо

fs.writeFile('example.txt', 'Hello, World!', (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('File has been saved!');
});

Синхронное письмо

try {
    fs.writeFileSync('example.txt', 'Hello, World!');
    console.log('File has been saved!');
} catch (err) {
    console.error(err);
}

5. Добавление к файлам

Если вы хотите добавить контент в существующий файл, не перезаписывая его, используйте метод AppendFile.

Асинхронное добавление

fs.appendFile('example.txt', '\nAppended Content', (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('Content has been appended!');
});

Синхронное добавление

try {
    fs.appendFileSync('example.txt', '\nAppended Content');
    console.log('Content has been appended!');
} catch (err) {
    console.error(err);
}

6. Удаление файлов

Чтобы удалить файл, используйте метод отключения.

Асинхронное удаление

fs.unlink('example.txt', (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('File deleted!');
});

Синхронное удаление

try {
    fs.unlinkSync('example.txt');
    console.log('File deleted!');
} catch (err) {
    console.error(err);
}

7. Работа с каталогами

Создание каталога

fs.mkdir('newDir', { recursive: true }, (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('Directory created!');
});

Чтение каталога

fs.readdir('newDir', (err, files) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('Files in directory:', files);
});

Удаление каталога

fs.rmdir('newDir', { recursive: true }, (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('Directory deleted!');
});

8. Просмотр файлов

Отслеживать изменения в файле можно с помощью метода fs.watch:

fs.watch('example.txt', (eventType, filename) => {
    if (filename) {
        console.log(`${filename} file Changed!`);
    }
});

9. Работа с потоками

Node.js предоставляет потоки файловой системы для обработки больших файлов, которые могут не помещаться в памяти.

Чтение с потоками

const readStream = fs.createReadStream('example.txt', 'utf8');
readStream.on('data', (chunk) => {
    console.log(chunk);
});

Написание с помощью потоков

const writeStream = fs.createWriteStream('example.txt');
writeStream.write('Hello, ');
writeStream.write('World!');
writeStream.end();

10. Копирование файлов

Node.js предоставляет простой метод копирования файлов:

fs.copyFile('source.txt', 'destination.txt', (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log('File copied successfully!');
});

11. Обещанный фс

Модуль fs также содержит методы на основе промисов, упрощающие работу с современными функциями JavaScript, такими как async/await.

const fsPromises = require('fs').promises;

async function readFile() {
    try {
        const data = await fsPromises.readFile('example.txt', 'utf8');
        console.log(data);
    } catch (err) {
        console.error(err);
    }
}

readFile();

12. Практические примеры использования

• Файлы конфигурации: чтение или запись файлов конфигурации (например, файлов JSON) для хранения настроек.
• Файлы журналов: добавляйте в файлы журналов для отслеживания событий приложений.
• Загрузка файлов: сохранение и извлечение загруженных файлов.
• Обработка данных: эффективное чтение, обработка и запись больших наборов данных с использованием потоков.

13. Обработка ошибок и лучшие практики

• Всегда обрабатывайте ошибки в функциях обратного вызова или используйте блоки try-catch с синхронным кодом.
• В большинстве случаев для повышения производительности используйте асинхронные методы.
• Рассмотрите возможность использования fs.promises для более чистого и современного кода.
• Будьте осторожны с синхронными методами, поскольку они могут блокировать цикл событий.
• Используйте fs.constants для флагов файловой системы (например, fs.constants.O_RDONLY для доступа только для чтения).

14. Вопросы безопасности

• Проверка и очистка путей к файлам для предотвращения атак с обходом каталога.
• Будьте осторожны при работе с именами файлов и путями, предоставленными пользователем.
• Используйте соответствующие права доступа к файлам при создании или изменении файлов и каталогов.

15. Заключение

Модуль fs является универсальным и незаменимым для любого приложения Node.js, которому необходимо взаимодействовать с файловой системой. Понимая его различные методы, эффективно обрабатывая потоки и применяя лучшие практики, вы будете хорошо подготовлены к эффективному и безопасному управлению файловыми операциями в Node.js.

Не забудьте ознакомиться с официальной документацией Node.js для получения самой последней информации и дополнительных функций модуля fs.