Json.md

JSON

Visão Geral do JSON

JSON (JavaScript Object Notation) é um formato leve de intercâmbio de dados que é fácil de ser lido e escrito por humanos, e fácil de ser interpretado e gerado por máquinas. JSON é frequentemente usado para trocar dados entre um servidor e uma aplicação web, bem como para arquivos de configuração e armazenamento de dados.

Método JSON.stringify()

O método JSON.stringify() em JavaScript é usado para converter um objeto ou valor JavaScript em uma string JSON. Este método aceita três parâmetros:

1. valor: O objeto JavaScript ou valor a ser convertido em uma string JSON.
2. substituidor (opcional): Uma função ou array que determina como os valores dentro do objeto devem ser transformados antes de serem incluídos na string JSON.
3. espaço (opcional): Uma string ou número que especifica a formatação da indentação de objetos aninhados na string JSON resultante, tornando-a mais legível para humanos.

Uso Básico

const dados = {
  nome: 'João',
  idade: 30,
  cidade: 'Nova York'
};

const jsonString = JSON.stringify(dados);
console.log(jsonString);

Utilizando a Função Substituidora

Você pode usar uma função substituidora para personalizar o processo de serialização:

const dados = {
  nome: 'João',
  idade: 30,
  cidade: 'Nova York',
  infoSensivel: 'Isso deve ser oculto'
};

const jsonString = JSON.stringify(dados, (chave, valor) => {
  if (chave === 'infoSensivel') {
    return undefined; // Oculta dados sensíveis
  }
  return valor;
});

console.log(jsonString);

Impressão Formatada (com espaço)

Você pode tornar a string JSON mais legível para humanos especificando um nível de indentação usando o parâmetro espaço:

const dados = {
  nome: 'João',
  idade: 30,
  cidade: 'Nova York'
};

const jsonString = JSON.stringify(dados, null, 2); // Indentação com 2 espaços
console.log(jsonString);

Parseando JSON

Para converter uma string JSON de volta em um objeto JavaScript, você pode usar o método JSON.parse():

const jsonString = '{"nome":"João","idade":30,"cidade":"Nova York"}';
const dadosParseados = JSON.parse(jsonString);
console.log(dadosParseados);

Leitura e Edição de Arquivos JSON

JavaScript oferece maneiras simples de ler e editar arquivos JSON. JSON é um formato de dados muito utilizado para armazenar informações estruturadas, como configurações e dados.

Leitura de Arquivo JSON

const fs = require('fs');

fs.readFile('arquivo.json', 'utf8', (err, data) => {
    if (err) {
        console.error('Erro ao ler o arquivo JSON:', err);
        return;
    }

    const objetoJSON = JSON.parse(data);
    console.log(objetoJSON);
});

Escrita em Arquivo JSON

const fs = require('fs');

const objetoJSON = {
    nome: 'Alice',
    idade: 30,
    profissao: 'Desenvolvedora'
};

fs.writeFile('arquivo.json', JSON.stringify(objetoJSON, null, 2), err => {
    if (err) {
        console.error('Erro ao escrever o arquivo JSON:', err);
    } else {
        console.log('Arquivo JSON escrito com sucesso.');
    }
});

Edição de Valores

const fs = require('fs');

fs.readFile('arquivo.json', 'utf8', (err, data) => {
    if (err) {
        console.error('Erro ao ler o arquivo JSON:', err);
        return;
    }

    const objetoJSON = JSON.parse(data);
    objetoJSON.idade = 31;

    fs.writeFile('arquivo.json', JSON.stringify(objetoJSON, null, 2), err => {
        if (err) {
            console.error('Erro ao escrever o arquivo JSON:', err);
        } else {
            console.log('Arquivo JSON editado com sucesso.');
        }
    });
});

Lembre-se de que, ao trabalhar com leitura e escrita de arquivos, é importante lidar com possíveis erros e adotar boas práticas para evitar perda de dados ou interrupções não planejadas em sua aplicação.

Casos de Uso Comuns

• Enviando dados para um servidor: Converta um objeto JavaScript em uma string JSON antes de enviá-lo por meio de uma solicitação HTTP.
• Armazenando dados: Armazene dados de configuração ou de aplicação no formato JSON.
• Leitura de arquivos de configuração: Analise arquivos de configuração JSON para aplicações.
• Interação com APIs: Muitas APIs retornam dados no formato JSON, que podem ser analisados e usados em JavaScript.

Lembre-se de que JSON.stringify() e JSON.parse() funcionam com dados JSON válidos. JSON inválido resultará em erros. Certifique-se sempre de que seus dados estejam em conformidade com o formato JSON ao usar esses métodos.