Como ler arquivos JSON em Node.js?

Este blog explica as abordagens para ler arquivos JSON via Node.js.

Como ler arquivos JSON em Node.js?

Existem três abordagens pelas quais os dados do arquivo JSON selecionado podem ser lidos em Node.js. Os dados recuperados podem ser exibidos no console ou no site no número da porta específico. Esta seção compreende todos os métodos possíveis para ler os arquivos JSON.

Pré-requisitos:

Antes de passar para a implementação prática, primeiro observe o arquivo do tipo JSON que precisa ser lido usando Node.js. No nosso caso, é “ jsonData ”Arquivo com os seguintes dados:

Método 1: use o método “require()” para ler o arquivo JSON em Node.js

Para ler os dados armazenados em um arquivo aleatório do tipo JSON, use o “ exigir() ”Método que recupera as funções ou métodos residentes nos módulos externos. Ele coloca o nome do módulo entre parênteses e retorna um objeto que contém o método, propriedades ou eventos desse módulo.

Da mesma forma, ignorar o caminho do arquivo JSON para este método retorna um objeto que contém todos os dados do arquivo. É a maneira mais simples e fácil de ler qualquer tipo de arquivo em Node.js.

Primeiro, crie um arquivo chamado “read.js” e adicione o código abaixo ao arquivo para uma demonstração prática deste método:

No código acima:

• O caminho do arquivo JSON é fornecido dentro do “ exigir() ”Como parâmetro para recuperar seus dados e armazená-los no objeto “jsonReadData”.
• O ' console.log() ”O método é usado para exibir os dados recuperados no console.

Execute o arquivo “read.js” usando o “ nó ”comando:

A saída abaixo mostra que os dados do arquivo JSON foram recuperados usando o “ exigir() ”método:

Método 2: use a função “readFile()” para ler o arquivo JSON em Node.js

O ' lerArquivo() ”É outra função que lê os dados do arquivo do Sistema de arquivos (fs) sem bloquear o processo de execução devido à sua natureza assíncrona. Ele também usa a função de retorno de chamada para executar alguma função adicional nos dados recuperados. Por exemplo, é usado para recuperar os dados de um arquivo JSON.

Sintaxe

A sintaxe para “ lerArquivo() ' função de ' fs ”O módulo é declarado como:

Na sintaxe acima:

• O ' fsObj ”é o objeto ou instância para invocar o módulo “fs” para usar a função “readFile()”.
• O ' nome do arquivo ”é o arquivo específico que precisa ser “lido”.
• O ' tipo de codificação ”É um parâmetro opcional que especifica o tipo de codificação como utf8. Se não for fornecido, os dados retornarão como um “buffer”.
• O ' função de retorno de chamada personalizada ”É a função executada depois que o arquivo é lido com sucesso.

Percorra o bloco de código abaixo no qual o conteúdo do mesmo arquivo JSON “ jsonData ”É recuperado e exibido no console usando o“ lerArquivo() ”método:

A explicação do código acima é apresentada abaixo:

• Primeiro, o “ fs ”módulo é importado para o atual“ leia.js ”arquivo e seu objeto é armazenado na variável chamada“ fsObj ”.
• Em seguida, invoque o “ lerArquivo() ”Método usando o“ fsObj ”variável que passa o arquivo JSON como seu primeiro parâmetro e a função de retorno de chamada como seu segundo parâmetro. Além disso, a função de retorno de chamada possui dois parâmetros “ ocorreuErr ' e ' contente ”.
• Dentro da função de retorno de chamada, utilize o “ se ”Instrução para realizar o tratamento de erros.
• Depois disso, passe o “ contente ”Parâmetro no“ JSON.parse() ”Método para converter os dados no formato JSON para melhorar a legibilidade.
• No final, fora do ” lerArquivo() ”O método exibe texto aleatório no console para confirmar que não bloqueia o próximo processo até a execução do processo anterior.

Agora, execute o arquivo “read.js” usando o comando abaixo:

A saída mostra que os dados JSON foram recuperados com sucesso sem bloquear a execução do próximo processo:

Método 3: use a função “readFileSync()” para ler o arquivo JSON em Node.js

O ' readFileSync() ”A função também é fornecida pelo Sistema de arquivos (fs) módulo que lê o arquivo de forma síncrona. Ele interrompe a execução do programa até que a tarefa atribuída seja concluída. Em outras palavras, segue a metodologia do primeiro a chegar, primeiro a servir. É totalmente oposto ao discutido “ lerArquivo() ”função.

Sintaxe

A sintaxe do método “readFileSync()” está escrita abaixo:

Na sintaxe acima:

• O ' caminho de arquivo ”contém o caminho do arquivo selecionado.
• O ' tipo de codificação ”especifica o tipo de codificação de acordo com os requisitos.

A implementação do método definido é declarada no código abaixo:

A descrição do bloco de código acima está escrita aqui:

• Primeiro, importe o “ fs ”módulo e armazene-o como um objeto na variável“ fsObj ”.
• Em seguida, invoque o “ readFileSync() ”função e passe o nome do arquivo JSON como seu parâmetro. Ele retornará os dados do arquivo especificado que estão armazenados na variável “ jsonData ”.
• Para exibir os dados em um formato legível, aplique o “ JSON.parse() ”Método no conteúdo do arquivo armazenado no“ contente ”variável e, em seguida, exibi-la no console.

Por fim, execute o arquivo para ver a saída:

Pode-se observar que a saída mostra os dados do arquivo JSON bloqueando todos os processos futuros:

Este guia explicou as abordagens para leitura de arquivos JSON em Node.js.

Conclusão

Para ler os dados do arquivo JSON em Node.js, use o “ exigir ”Método pois recupera os dados de qualquer tipo de arquivo ou módulos externos. Além disso, o“ lerArquivo() ' e ' readFileSync() ”Funções do“ fs ”O módulo também pode ser usado para executar esta tarefa. Depois que os dados do arquivo forem recuperados usando essas funções, aplique o “ JSON.parse() ”Método para tornar o conteúdo legível. Este guia explicou os métodos e funções que auxiliam na leitura dos arquivos JSON em Node.js.