Sistema de Arquivos (FS) Node.js

Node.js FS

O Node FS é um módulo integrado do Node.js que pode ajudar você a lidar com arquivos e operá-los.

Operações de arquivo NodeJs FS

Usando o Node FS, você pode executar as seguintes operações em arquivos:

• Ler arquivo

• Criar ou sobrescrever arquivo

• Atualizar arquivo

• 删除文件

• Renomear arquivo

O Node.js oferece um conjunto de API de operação de arquivo semelhante ao padrão UNIX (POSIX). A sintaxe de importação do módulo de sistema de arquivos (fs) do Node é como mostrado a seguir:

var fs = require("fs")

Assíncrono e síncrono

Todos os métodos do módulo de sistema de arquivos do Node.js (módulo fs) têm versões assíncronas e síncronas, por exemplo, as funções de leitura de conteúdo de arquivo têm fs.readFile() assíncrono e fs.readFileSync() síncrono.

O último parâmetro da função do método assíncrono é a função de chamada de volta, o primeiro parâmetro da função de chamada de volta contém informações de erro (error).

Recomenda-se usar métodos assíncronos, pois eles têm melhor desempenho e velocidade em comparação com métodos síncronos, além de não bloquear.

Exemplo

Criar arquivo input.txt, o conteúdo é o seguinte:

Endereço do site do tutorial básico: pt.oldtoolbag.com
Exemplo de leitura de arquivo

Criar arquivo file.js, o código é o seguinte:

var fs = require("fs");
//　Leitura assíncrona
fs.readFile('input.txt', function(err, data) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Leitura assíncrona: ");　+　data.toString());
});
//　Leitura síncrona
var data = fs.readFileSync('input.txt');
console.log("Leitura síncrona: ");　+　data.toString());
console.log("Execução do programa concluída.");

O resultado da execução do código acima é o seguinte:

$ node file.js　
Leitura síncrona: Endereço do site do tutorial básico: pt.oldtoolbag.com
Exemplo de leitura de arquivo
Execução do programa concluída.
Leitura assíncrona: Endereço do site do tutorial básico: pt.oldtoolbag.com
Exemplo de leitura de arquivo

A seguir, vamos entender melhor os métodos do sistema de arquivos do Node.js.

Abrir arquivo

Sintaxe

A seguir está o formato de sintaxe para abrir um arquivo em modo assíncrono:

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

Parâmetros

Instrução de uso dos parâmetros conforme abaixo:

• path - Caminho do arquivo.

• flags - Comportamento de abertura de arquivo. Valores específicos podem ser encontrados no texto a seguir.

• mode - Definir o modo de arquivo (permissões), a permissão padrão de criação de arquivo é 0666(leitura, escrita).

• callback - Função de callback, com dois parâmetros como: callback(err, fd).

Os valores do parâmetro flags podem ser os seguintes:

Exemplo

A seguir criamos o arquivo file.js e abrimos o arquivo input.txt para leitura e escrita, o código é o seguinte:

var fs = require("fs");
//　Abertura assíncrona de arquivo
console.log("Preparando para abrir arquivo!");
fs.open('input.txt', 'r+', function(err, fd) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　console.log("Arquivo aberto com sucesso!");　　　　　
});

O resultado da execução do código acima é o seguinte:

$ node file.js　
准备打开文件！
文件打开成功！

Obter informações do arquivo

Sintaxe

A seguir está o formato de sintaxe para obter informações de arquivo de forma assíncrona:

fs.stat(path, callback)

Parâmetros

Instrução de uso dos parâmetros conforme abaixo:

• path - Caminho do arquivo.

• callback - Função de callback, com dois parâmetros como: (err, stats), stats é um objeto fs.Stats.

Após a execução de fs.stat(path), uma instância da classe Stats será retornada para a função de callback. Pode-se usar os métodos fornecidos pela classe stats para determinar as propriedades do arquivo. Por exemplo, determinar se é um arquivo:

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

Os métodos da classe stats incluem:

Exemplo

A seguir, criamos o arquivo file.js, conforme mostrado a seguir:

var fs = require("fs");
console.log("Preparando para abrir arquivo!");
fs.stat('input.txt', function(err, stats) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log(stats);
　　　console.log("Sucesso na leitura das informações do arquivo!");
　　　
　　　//　Detecção do tipo de arquivo
　　　console.log("É um arquivo (isFile) ? "　+　stats.isFile());
　　　console.log("É um diretório (isDirectory) ? "　+　stats.isDirectory());　　　　
});

O resultado da execução do código acima é o seguinte:

$ node file.js　
准备打开文件！
{ dev:　16777220,
　　mode:　33188,
　　nlink:　1,
　　uid:　501,
　　gid:　20,
　　rdev: 0,
　　blksize:　4096,
　　ino:　40333161,
　　size:　61,
　　blocks:　8,
　　atime: Seg Mon Sep 07　2015　17:43:55　GMT+0800 (CST),
　　mtime: Seg Mon Sep 07　2015　17:22:35　GMT+0800 (CST),
　　ctime: Seg Mon Sep 07　2015　17:22:35　GMT+0800 (CST)}
Sucesso na leitura das informações do arquivo!
É um arquivo (isFile) ? true
É um diretório (isDirectory) ? false

Escrever arquivo

Sintaxe

A seguir está o formato de sintaxe para escrita assíncrona de arquivo:

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

O writeFile abre diretamente o arquivo por padrão é w O modo, portanto, se o arquivo existir, o conteúdo escrito pelo método writeFile substituirá o conteúdo antigo do arquivo.

Parâmetros

Instrução de uso dos parâmetros conforme abaixo:

• file - O nome do arquivo ou o descritor do arquivo.

• data - Os dados a serem escritos no arquivo, podem ser String (string) ou objeto Buffer (buffer).

• options - Este parâmetro é um objeto que contém {encoding, mode, flag}. A codificação padrão é utf8, o modo é 0666 , o flag é 'w'

• callback - A função de callback, contém apenas o parâmetro de erro (err), e retorna ao falhar na escrita.

Exemplo

A seguir, criamos o arquivo file.js, conforme mostrado a seguir:

var fs = require("fs");
console.log("Preparando para escrever arquivo");
fs.writeFile('input.txt', 'Sou o conteúdo escrito por fs.writeFile', function(err) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Escrita de dados bem-sucedida!");
　　　console.log("--------Sou uma linha divisória-------------")
　　　console.log("Ler dados escritos!");
　　　fs.readFile('input.txt', function(err, data) {
　　　　　　if (err) {
　　　　　　　　　return console.error(err);
　　　　　　}
　　　　　　console.log("Leitura assíncrona de dados do arquivo: ",　+　data.toString());
　　　});
});

O resultado da execução do código acima é o seguinte:

$ node file.js　
Preparando para escrever arquivo
Escrita de dados bem-sucedida!
--------Sou uma linha divisória-------------
Ler dados escritos!
Leitura assíncrona de dados do arquivo: sou o conteúdo do arquivo escrito através de fs.writeFile

Ler arquivo

Sintaxe

A seguir está o formato de sintaxe para ler arquivo em modo assíncrono:

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

Este método usa o descriptor de arquivo para ler o arquivo.

Parâmetros

Instrução de uso dos parâmetros conforme abaixo:

• fd - Descriptor de arquivo retornado pelo método fs.open().

• buffer - Buffer de dados para escrita.

• offset - Deslocamento de escrita no buffer.

• length - Número de bytes a serem lidos do arquivo.

• position - Posição de leitura do arquivo, se o valor de position for null, será lido a partir da posição atual do ponteiro do arquivo.

• callback - função de callback, com três parâmetros err, bytesRead, buffer, err para informações de erro, bytesRead para o número de bytes lidos, buffer para o objeto de buffer.

Exemplo

input.txt 文件内容为：

Endereço do site do tutorial básico: pt.oldtoolbag.com

A seguir, criamos o arquivo file.js, conforme mostrado a seguir:

var fs = require("fs");
var buf = new Buffer.alloc(1024);
console.log("Preparando para abrir arquivo existente!");
fs.open('input.txt', 'r+', function(err, fd) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Arquivo aberto com sucesso!");
　　　console.log("Preparando para ler arquivo:");
　　　fs.read(fd,　buf,　0,　buf.length,　0,　function(err,　bytes){
　　　　　　if (err) {
　　　　　　　　　console.log(err);
　　　　　　}
　　　　　　console.log(bytes　+　"Bytes lidos");
　　　　　　
　　　　　　//　仅输出读取的字节
　　　　　　if (bytes > 0) {
　　　　　　　　　console.log(buf.slice(0,　bytes).toString());
　　　　　　}
　　　});
});

O resultado da execução do código acima é o seguinte:

$ node file.js　
Preparando para abrir arquivo existente!
文件打开成功！
Preparando para ler arquivo:
42　　Bytes lidos
Endereço do site do tutorial básico: pt.oldtoolbag.com

关闭文件

Sintaxe

A seguir está o formato de sintaxe para fechar arquivo em modo assíncrono:

fs.close(fd, callback)

Este método usa o descriptor de arquivo para ler o arquivo.

Parâmetros

Instrução de uso dos parâmetros conforme abaixo:

• fd - Descriptor de arquivo retornado pelo método fs.open().

• callback - Função de callback, sem parâmetros.

Exemplo

input.txt 文件内容为：

Endereço do site do tutorial básico: pt.oldtoolbag.com

A seguir, criamos o arquivo file.js, conforme mostrado a seguir:

var fs = require("fs");
var buf = new Buffer.alloc(1024);
console.log("Preparando para abrir arquivo!");
fs.open('input.txt', 'r+', function(err, fd) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Arquivo aberto com sucesso!");
　　　console.log("Preparando para ler arquivo!");
　　　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("Arquivo fechado com sucesso");
　　　　　　});
　　　});
});

O resultado da execução do código acima é o seguinte:

$ node file.js　
准备打开文件！
文件打开成功！
Preparando para ler arquivo!
Endereço do site do tutorial básico: pt.oldtoolbag.com
文件关闭成功

截取文件

Sintaxe

A seguir está o formato de sintaxe para cortar arquivos em modo assíncrono:

fs.ftruncate(fd, len, callback)

Este método usa o descriptor de arquivo para ler o arquivo.

Parâmetros

Instrução de uso dos parâmetros conforme abaixo:

• fd - Descriptor de arquivo retornado pelo método fs.open().

• len - Tamanho de corte do conteúdo do arquivo.

• callback - Função de callback, sem parâmetros.

Exemplo

input.txt 文件内容为：

site:pt.oldtoolbag.com

A seguir, criamos o arquivo file.js, conforme mostrado a seguir:

var fs = require("fs");
var buf = new Buffer.alloc(1024);
console.log("Preparando para abrir arquivo!");
fs.open('input.txt', 'r+', function(err, fd) {
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Arquivo aberto com sucesso!");
　　　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("文件关闭成功！");
　　　　　　　　　});
　　　　　　});
　　　});
});

O resultado da execução do código acima é o seguinte:

$ node file.js　
准备打开文件！
文件打开成功！
截取10字节内的文件内容，超出部分将被去除。
文件截取成功。
读取相同的文件
site:www.r
文件关闭成功

删除文件

Sintaxe

以下为删除文件的语法格式：

fs.unlink(path,　callback)

Parâmetros

Instrução de uso dos parâmetros conforme abaixo:

• path - Caminho do arquivo.

• callback - Função de callback, sem parâmetros.

Exemplo

input.txt 文件内容为：

site:pt.oldtoolbag.com

A seguir, criamos o arquivo file.js, conforme mostrado a seguir:

var fs = require("fs");
console.log("准备删除文件！");
fs.unlink('input.txt',　function(err)　{
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("文件删除成功！");
});

O resultado da execução do código acima é o seguinte:

$ node file.js　
准备删除文件！
文件删除成功！

再去查看 input.txt 文件，发现已经不存在了。

创建目录

Sintaxe

以下为创建目录的语法格式：

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

Parâmetros

Instrução de uso dos parâmetros conforme abaixo:

• path - Caminho do arquivo.

• options 参数可以是：

• recursive - 是否以递归的方式创建目录，默认为 false。

• mode - 设置目录权限，默认为 0777.

• callback - Função de callback, sem parâmetros.

Exemplo

A seguir, criamos o arquivo file.js, conforme mostrado a seguir:

var fs = require("fs");
//　tmp　目录必须存在
console.log("创建目录　/tmp/test/");
fs.mkdir("/tmp/test/
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("目录创建成功。");
});

O resultado da execução do código acima é o seguinte:

$ node file.js　
创建目录　/tmp/test/
目录创建成功。

可以添加 　recursive: true 参数，不管创建的目录 　/tmp 和 /tmp/a 是否存在：

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

Ler diretório

Sintaxe

A seguir, o formato de sintaxe para ler diretório é:

fs.readdir(path, callback)

Parâmetros

Instrução de uso dos parâmetros conforme abaixo:

• path - Caminho do arquivo.

• callback - Função de callback, a função de callback possui dois parâmetros err, files, err é a mensagem de erro, files é a lista de arrays de arquivos no diretório.

Exemplo

A seguir, criamos o arquivo file.js, conforme mostrado a seguir:

var fs = require("fs");
console.log("Ver　/Pasta tmp
fs.readdir("/tmp/",function(err, files){
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　files.forEach(function(file){
　　　　　　　console.log(file);
　　　});
});

O resultado da execução do código acima é o seguinte:

$ node file.js　
Ver　/Pasta tmp
input.out
output.out
test
test.txt

Excluir diretório

Sintaxe

A seguir, o formato de sintaxe para exclusão de diretório é:

fs.rmdir(path, callback)

Parâmetros

Instrução de uso dos parâmetros conforme abaixo:

• path - Caminho do arquivo.

• callback - Função de callback, sem parâmetros.

Exemplo

A seguir, criamos o arquivo file.js, conforme mostrado a seguir:

var fs = require("fs");
//　Antes de executar, crie um diretório vazio　/tmp/Pasta test
console.log("Preparar para excluir diretório　/tmp/test");
fs.rmdir("/tmp/test", function(err){
　　　if (err) {
　　　　　　　return console.error(err);
　　　}
　　　console.log("Ler　/Pasta tmp
　　　fs.readdir("/tmp/",function(err, files){
　　　　　　if (err) {
　　　　　　　　　　return console.error(err);
　　　　　　}
　　　　　　files.forEach(function(file){
　　　　　　　　　　console.log(file);
　　　　　　});
　　　});
});

O resultado da execução do código acima é o seguinte:

$ node file.js　
Preparar para excluir diretório　/tmp/test
Ler　/Pasta tmp
……

Manual de referência de métodos do módulo de arquivo

A seguir, lista de métodos do módulo de arquivo do Node.js:

Para mais informações, consulte a descrição do módulo do Sistema de Arquivos no site oficial:Sistema de Arquivos.