Файловая система (FS) в Node.js

Node.js FS

Node FS является内置ным модулем Node.js, который помогает вам обрабатывать файлы и выполнять с ними операции.

Операции с файлами NodeJs FS

Используя Node FS, вы можете выполнять следующие операции с файлами:

• Чтение файла

• Создавать или заменять файл

• Обновлять файл

• удаление файла

• Переименовывать файл

Node.js предоставляет набор API для файловых операций, аналогичных стандартам UNIX (POSIX). Синтаксис импорта модуля файловой системы Node.js (fs) показан следующим образом:

var fs = require("fs")

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

Модуль файловой системы Node.js (модуль fs) предоставляет методы как асинхронного, так и синхронного выполнения, например, функции чтения содержимого файла имеют асинхронный fs.readFile() и синхронный fs.readFileSync().

В последнем параметре функции асинхронного метода находится回调 функция, в которой первый параметр содержит информацию об ошибках (error).

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

Пример

Создайте файл input.txt с следующим содержимым:

Адрес официального сайта базового руководства: ru.oldtoolbag.com
Пример чтения файла

Создайте файл file.js с следующим кодом:

var fs = require("fs");
// Асинхронное чтение
fs.readFile('input.txt', function(err, data) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Асинхронное чтение: " + data.toString());
});
// Синхронное чтение
var data = fs.readFileSync('input.txt');
console.log("Синхронное чтение: " + data.toString());
console.log("Программа выполнена.");

Результат выполнения кода выше:

$ node file.js　
Синхронное чтение: адрес основного учебника: ru.oldtoolbag.com
Пример чтения файла
Программа выполнена.
Асинхронное чтение: адрес основного учебника: ru.oldtoolbag.com
Пример чтения файла

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

Открытие файла

синтаксис

Ниже приведен синтаксис открытия файла в асинхронном режиме:

fs.open(path, flags[, mode], callback)

параметр

Инструкции по использованию параметров:

• путь - Путь файла.

• flags - Поведение файла при открытии. Конкретные значения см. в разделе ниже.

• режим - Установка файла модели (права доступа), по умолчанию при создании файла права доступа 0666 (читаемый, قابل записи).

• callback - Callback функция, которая принимает два параметра, такие как: callback(err, fd).

Параметр flags может принимать следующие значения:

Пример

Далее мы создадим файл file.js и откроем файл input.txt для чтения и записи, код следующий:

var fs = require("fs");
// Асинхронное открытие файла
console.log("Подготовка к открытию файла!");
fs.open('input.txt', 'r+', function(err, fd) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　console.log("Файл успешно открыт!");　　　　　
});

Результат выполнения кода выше:

$ node file.js　
Подготовка к открытию файла!
Успешно открыт файл!

Получение информации о файле

синтаксис

Ниже приведен синтаксис получения информации о файле асинхронным способом:

fs.stat(path, callback)

параметр

Инструкции по использованию параметров:

• путь - Путь к файлу。

• callback - Callback функция, которая принимает два параметра, такие как: (err, stats), stats Это объект fs.Stats.

После выполнения fs.stat(path) будет возвращен экземпляр класса stats для его回调 функции. можно использовать методы класса stats для определения свойств файла. Например, определить, является ли это файлом:

var fs = require('fs');
fs.stat('/Users/liuht/code/itbilu/demo/fs.js', function err, stats) {
　　　　console.log(stats.isFile()); // true
})

Методы в классе stats:

Пример

Далее мы создаем файл file.js с следующим кодом:

var fs = require("fs");
console.log("Подготовка к открытию файла!");
fs.stat('input.txt', function err, stats) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log(stats);
　　　console.log("Успешно прочитана информация о файле!");
　　　
　　　// Проверка типа файла
　　　console.log("Я ли файл (isFile)? " + stats.isFile());
　　　console.log("Я ли директория (isDirectory)? " + stats.isDirectory());　　　　
});

Результат выполнения кода выше:

$ node file.js　
Подготовка к открытию файла!
{ dev: 16777220,
　　mode: 33188,
　　nlink: 1,
　　uid: 501,
　　gid: 20,
　　rdev: 0,
　　blksize: 4096,
　　ino: 40333161,
　　size: 61,
　　blocks: 8,
　　atime: Пн Sep 07 2015 17:43:55 GMT+0800 (CST),
　　mtime: Пн Sep 07 2015 17:22:35 GMT+0800 (CST),
　　ctime: Пн Sep 07 2015 17:22:35 GMT+0800 (CST)
Успешно прочитано информацию о файле!
Является ли это файлом (isFile) ? true
Является ли это каталогом (isDirectory) ? false

Запись файла

синтаксис

Ниже приведен формат синтаксиса записи файла в асинхронном режиме:

fs.writeFile(file, data[, options], callback)

writeFile по умолчанию открывает файл в w режим, поэтому если файл существует, содержимое, записанное этим методом, будет overwrite старого файла.

параметр

Инструкции по использованию параметров:

• file - Имя файла или дескриптор файла.

• data - Данные для записи в файл, может быть String (строка) или Buffer (буфер).

• options - Этот параметр является объектом, содержащим {encoding, mode, flag}. По умолчанию кодировка utf8, режим 0666, flag 'w'.

• callback - Кallback функция, которая содержит только параметр ошибки (err), возвращается при ошибке записи.

Пример

Далее мы создаем файл file.js с следующим кодом:

var fs = require("fs");
console.log("Подготовка к записи файла");
fs.writeFile('input.txt', 'Содержимое файла, записанного через fs.writeFile', function(err) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Успешно записано!");
　　　console.log("--------Я являюсь разделителем-------------")
　　　console.log("Чтение записанных данных!");
　　　fs.readFile('input.txt', function(err, data) {
　　　　　　if (err) {
　　　　　　　　　return console.error(err);
　　　　　　}
　　　　　　console.log("Асинхронное чтение данных файла: " + data.toString());
　　　});
});

Результат выполнения кода выше:

$ node file.js　
Подготовка к записи файла
Успешно записано!
--------Я являюсь разделителем-------------
Чтение записанных данных!
Асинхронное чтение данных файла: содержимое файла, записанного через fs.writeFile

Чтение файла

синтаксис

Ниже приведен формат синтаксиса чтения файла в асинхронном режиме:

fs.read(fd, buffer, offset, length, position, callback)

Этот метод использует файловый дескриптор для чтения файла.

параметр

Инструкции по использованию параметров:

• fd - Файловый дескриптор, возвращаемый методом fs.open().

• buffer - Буфер для записи данных.

• offset - Смещение записи в буфере.

• length - Количество байт для чтения из файла.

• position - Начальная позиция чтения файла, если значение position равно null, то чтение будет производиться с текущей позиции указателя файла.

• callback - Кallback функция,有三个参数err, bytesRead, buffer，err это информация об ошибке, bytesRead это количество считанных байт, buffer это объект буфера.

Пример

Содержимое файла input.txt:

Адрес официального сайта базового руководства: ru.oldtoolbag.com

Далее мы создаем файл file.js с следующим кодом:

var fs = require("fs");
var buf = new Buffer.alloc(1024);
console.log("Подготовка к открытию существующего файла!");
fs.open('input.txt', 'r+', function(err, fd) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Файл успешно открыт!");
　　　console.log("Подготовка к чтению файла:");
　　　fs.read(fd, buf, 0, buf.length, 0, function(err, bytes) {
　　　　　　if (err) {
　　　　　　　　　console.log(err);
　　　　　　}
　　　　　　console.log(bytes + "    байт было считано");
　　　　　　
　　　　　　// Выводить только считанные байты
　　　　　　if (bytes > 0) {
　　　　　　　　　console.log(buf.slice(0, bytes).toString());
　　　　　　}
　　　});
});

Результат выполнения кода выше:

$ node file.js　
Подготовка к открытию существующего файла!
Успешно открыт файл!
Подготовка к чтению файла:
Чтены 42 байта
Адрес официального сайта базового руководства: ru.oldtoolbag.com

Закрывать файл

синтаксис

Следующий формат синтаксиса для закрытия файла в асинхронном режиме:

fs.close(fd, callback)

Этот метод использует файловый дескриптор для чтения файла.

параметр

Инструкции по использованию параметров:

• fd - Файловый дескриптор, возвращаемый методом fs.open().

• callback - Функция回调, без параметров.

Пример

Содержимое файла input.txt:

Адрес официального сайта базового руководства: ru.oldtoolbag.com

Далее мы создаем файл file.js с следующим кодом:

var fs = require("fs");
var buf = new Buffer.alloc(1024);
console.log("Подготовка к открытию файла!");
fs.open('input.txt', 'r+', function(err, fd) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Файл успешно открыт!");
　　　console.log("Подготовка к чтению файла!");
　　　fs.read(fd, buf, 0, buf.length, 0, function(err, bytes) {
　　　　　　if (err) {
　　　　　　　　　console.log(err);
　　　　　　}
　　　　　　// Выводить только считанные байты
　　　　　　if (bytes > 0) {
　　　　　　　　　console.log(buf.slice(0, bytes).toString());
　　　　　　}
　　　　　　// Закрывать файл
　　　　　　fs.close(fd, function(err) {
　　　　　　　　　if (err) {
　　　　　　　　　　　　console.log(err);
　　　　　　　　　}　
　　　　　　　　　console.log("Файл успешно закрыт");
　　　　　　});
　　　});
});

Результат выполнения кода выше:

$ node file.js　
Подготовка к открытию файла!
Успешно открыт файл!
Подготовка к чтению файла!
Адрес официального сайта базового руководства: ru.oldtoolbag.com
Успешно закрыт файл

Вырезать файл

синтаксис

Следующий формат синтаксиса для вырезания файла в асинхронном режиме:

fs.ftruncate(fd, len, callback)

Этот метод использует файловый дескриптор для чтения файла.

параметр

Инструкции по использованию параметров:

• fd - Файловый дескриптор, возвращаемый методом fs.open().

• len - Длина вырезаемого файла.

• callback - Функция回调, без параметров.

Пример

Содержимое файла input.txt:

site:ru.oldtoolbag.com

Далее мы создаем файл file.js с следующим кодом:

var fs = require("fs");
var buf = new Buffer.alloc(1024);
console.log("Подготовка к открытию файла!");
fs.open('input.txt', 'r+', function(err, fd) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Файл успешно открыт!");
　　　console.log("Удалены все содержимое файла за пределами 10 байт.");
　　　
　　　// Вырезать файл
　　　fs.ftruncate(fd, 10, function(err) {
　　　　　　if (err) {
　　　　　　　　　console.log(err);
　　　　　　}　
　　　　　　console.log("Успешно вырезан файл.");
　　　　　　console.log("Файл успешно считан.");　
　　　　　　fs.read(fd, buf, 0, buf.length, 0, function(err, bytes) {
　　　　　　　　　if (err) {
　　　　　　　　　　　　console.log(err);
　　　　　　　　　}
　　　　　　　　　// Выводить только считанные байты
　　　　　　　　　if (bytes > 0) {
　　　　　　　　　　　　console.log(buf.slice(0, bytes).toString());
　　　　　　　　　}
　　　　　　　　　// Закрывать файл
　　　　　　　　　fs.close(fd, function(err) {
　　　　　　　　　　　　if (err) {
　　　　　　　　　　　　　　　console.log(err);
　　　　　　　　　　　　}　
　　　　　　　　　　　　console.log("Файл успешно закрыт!");
　　　　　　　　　});
　　　　　　});
　　　});
});

Результат выполнения кода выше:

$ node file.js　
Подготовка к открытию файла!
Успешно открыт файл!
Вырезано содержимое файла в 10 байтах, превышающие часть будет удалена.
Успешно вырезан файл.
Чтение того же файла
site:www.r
Успешно закрыт файл

удаление файла

синтаксис

Ниже приведен формат синтаксиса для удаления файла:

fs.unlink(path, callback)

параметр

Инструкции по использованию параметров:

• путь - Путь к файлу。

• callback - Функция回调, без параметров.

Пример

Содержимое файла input.txt:

site:ru.oldtoolbag.com

Далее мы создаем файл file.js с следующим кодом:

var fs = require("fs");
console.log("Подготовка к удалению файла!");
fs.unlink('input.txt', function(err) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Удаление файла успешно!");
});

Результат выполнения кода выше:

$ node file.js　
Подготовка к удалению файла!
Удаление файла успешно!

Затем проверьте файл input.txt, и вы会发现, что он больше не существует.

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

синтаксис

Ниже приведен формат синтаксиса для создания каталога:

fs.mkdir(path[, options], callback)

параметр

Инструкции по использованию параметров:

• путь - Путь к файлу。

• Параметр options может быть:

• recursive - Создание каталога с помощью рекурсии, по умолчанию false.

• режим - Установка прав доступа к каталогу, по умолчанию 0777.

• callback - Функция回调, без параметров.

Пример

Далее мы создаем файл file.js с следующим кодом:

var fs = require("fs");
// Каталог /tmp должен существовать
console.log("Создайте каталог /tmp/test/");
fs.mkdir("/tmp/test/", function(err) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Каталог успешно создан.");
});

Результат выполнения кода выше:

$ node file.js　
Создайте каталог /tmp/test/
Каталог успешно создан.

Можно добавить параметр recursive: true, и не важно, существуют ли каталоги /tmp и /tmp/a:

fs.mkdir('/tmp/a/apple', { recursive: true }, (err) => {
　　if (err) throw err;
});

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

синтаксис

Ниже приведен формат синтаксиса для чтения каталога:

fs.readdir(path, callback)

параметр

Инструкции по использованию параметров:

• путь - Путь к файлу。

• callback - Функция回调, которая принимает два параметра err, files, где err - это информация об ошибке, а files - это список файлов в каталоге.

Пример

Далее мы создаем файл file.js с следующим кодом:

var fs = require("fs");
console.log("Просмотрите каталог /tmp");
fs.readdir("/tmp/",function(err, files){
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　files.forEach(function(file){
　　　　　　　console.log(file);
　　　});
});

Результат выполнения кода выше:

$ node file.js　
Просмотрите каталог /tmp
input.out
output.out
test
test.txt

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

синтаксис

Ниже приведен формат синтаксиса для удаления каталога:

fs.rmdir(path, callback)

параметр

Инструкции по использованию параметров:

• путь - Путь к файлу。

• callback - Функция回调, без параметров.

Пример

Далее мы создаем файл file.js с следующим кодом:

var fs = require("fs");
// Создание пустого каталога /tmp/test перед выполнением
console.log("Подготовка к удалению каталога /tmp/test");
fs.rmdir("/tmp/test",function(err){
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Чтение каталога /tmp");
　　　fs.readdir("/tmp/",function(err, files){
　　　　　　if (err) {
　　　　　　　　　　return console.error(err);
　　　　　　}
　　　　　　files.forEach(function(file){
　　　　　　　　　　console.log(file);
　　　　　　});
　　　});
});

Результат выполнения кода выше:

$ node file.js　
Подготовка к удалению каталога /tmp/test
Чтение каталога /tmp
……

Руководство по методам модуля файлов

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

更多内容，请查看官网文件模块描述：文件系统。