Безопасный парсинг и валидация JSON в Node.js

Быстрый ответ

Для того чтобы преобразовать JSON в объект в Node.js, используйте JSON.parse():

const obj = JSON.parse('{"name":"Джейн","age":25}');
console.log(obj); // Вывод: { name: 'Джейн', age: 25 }

При чтении файла JSON обязательно укажите кодировку utf8:

const fs = require('fs');

fs.readFile('путь/до/json/файла.json', 'utf8', (err, jsonString) => {
  if (err) {
    console.error("Ошибка при чтении файла:", err);
    return;
  }

  try {
    const data = JSON.parse(jsonString);
    console.log("Данные:", data);
  } catch (err) {
    console.error("Ошибка при парсинге:", err);
  }
});

Безопасный разбор JSON и обработка ошибок

Обрабатываем ошибки парсинга с помощью try/catch

Используйте JSON.parse() непременно в сочетании с блоком try/catch для предотвращения ошибок при парсинге:

let jsonString = '{"невалидный JSON"}';

try {
  let data = JSON.parse(jsonString);
} catch (error) {
  console.error("Ошибка при парсинге:", error);
}

Подробнее об этом расскажет наш спикер на видео

Применение потоков для больших JSON-файлов

Для работы с большими файлами JSON можно использовать потоки, что поможет снизить потребление памяти:

const { createReadStream } = require('fs');
const { parse } = require('JSONStream');

const jsonStream = createReadStream('большой-файл.json')
  .pipe(parse('*'));

jsonStream.on('data', (data) => {
  console.log(data);
});

Защита данных

Никогда не храните конфиденциальные данные в файлах JSON. Для обеспечения безопасности используйте переменные окружения.

Парадигмы, выходящие за рамки простого разбора

Require против JSON.parse

При работе с JSON предпочтительней использовать JSON.parse(), а не require(). Это позволит избежать кэширования и всегда получать актуальные данные:

const fs = require('fs');

const data = JSON.parse(fs.readFileSync('config.json', 'utf8'));

Валидация структуры данных

Важно проверить корректность структуры полученных данных, подобно тому как охранник проверяет посетителей на входе в клуб:

const validateJSON = (data) => {
  // Определяем схему данных
  const schema = {
    type: 'object',
    properties: {
      name: { type: 'string' },
      age: { type: 'number' }
    },
    required: ['name', 'age']
  };

  // Валидируем данные с помощью надежной библиотеки, например, AJV.
};

Оптимизация парсинга JSON

Чтобы улучшить эффективность разбора JSON, следуйте советам из официальной документации Node.js.

Визуализация

Можно представить данные JSON как таинственный сундук, а парсинг – как процесс подбора подходящего ключа для его открытия:

Строка JSON (🔒🧰): '{"name": "Джон", "age": 30}'

Использование JSON.parse() аналогично подбору ключа:

const obj = JSON.parse('{"name": "Джон", "age": 30}');

Теперь сундук открыт, и вы можете работать с содержимым:

Распарсенный объект (🔓🧰, 💎): { name: 'Джон', age: 30 }

Полезные материалы

1. JSON.parse() – JavaScript | MDN — подробное руководство и документация по JSON.parse().
2. Файловая система | Node.js v21.6.1 Документация — информация о том, как читать файлы в Node.js.
3. javascript – Используя Node.JS, как мне считать JSON файл в (серверную) память? – Stack Overflow — рекомендации сообщества по чтению файлов JSON в Node.js.
4. JSON.parse() — руководство по использованию блоков try-catch для обработки ошибок JSON.parse().
5. Методы JSON, toJSON — обзор объекта JSON и его использования.
6. Понимание потоков в Node.js – NodeSource — обзор потоков для более эффективной работы с большими JSON-данными.
7. Async/await — урок по асинхронному программированию в контексте JSON-операций.