валидация JSON¶

Валидация JSON — это процесс проверки структуры и содержимого данных, представленных в формате JSON (JavaScript Object Notation), на соответствие заданным правилам, схеме или спецификации. Целью валидации является подтверждение того, что данные не только синтаксически корректны (то есть могут быть успешно разобраны парсером), но и семантически правильны: содержат ожидаемые поля, значения допустимых типов и удовлетворяют бизнес-ограничениям (например, диапазонам чисел или длине строк). Валидация является критическим этапом в обработке данных, передаваемых между клиентом и сервером, в конфигурационных файлах, в API-запросах и ответах, а также в системах обмена данными.

¶Синтаксическая валидация

Синтаксическая валидация является первым и обязательным этапом проверки. Она устанавливает, соответствует ли текстовая строка формальным правилам грамматики JSON, определённым в стандарте RFC 7159 (ранее RFC 4627) и ECMA-404. Основные правила синтаксиса включают:

Структура данных: JSON-документ может быть либо объектом (заключён в фигурные скобки {}), либо массивом (заключён в квадратные скобки []).
Ключи и строки: Все строки (включая ключи объектов) должны быть заключены в двойные кавычки ("). Одинарные кавычки не допускаются.
Разделители: Пары «ключ-значение» в объекте разделяются запятыми, а ключ от значения отделяется двоеточием. Элементы массива также разделяются запятыми.
Допустимые типы данных: Значениями могут быть: строка, число (целое или с плавающей точкой), логическое значение (true или false), null, объект или массив.
Экранирование символов: Специальные символы (например, кавычки, обратная косая черта, управляющие символы) внутри строк должны быть экранированы обратной косой чертой (\", \\, \n, \t и т.д.).
Отсутствие комментариев: Стандарт JSON не поддерживает комментарии. Любые символы, не являющиеся частью данных, приводят к синтаксической ошибке.

Синтаксическая валидация обычно выполняется встроенными функциями языков программирования (например, JSON.parse() в JavaScript, json.loads() в Python, json_decode() в PHP) или специализированными онлайн-инструментами. Если строка не является синтаксически корректным JSON, парсер генерирует исключение (ошибку). Пример синтаксически некорректного JSON:

``json {name: "Иван"} // Ошибка: ключ не в двойных кавычках ``

¶Семантическая валидация (валидация по схеме)

Семантическая валидация выходит за рамки проверки грамматики и проверяет соответствие данных определённой структуре и ограничениям, заданным в схеме. Наиболее распространённым стандартом для описания схем JSON является JSON Schema (описан в черновиках IETF, наиболее актуальная версия — 2020-12). JSON Schema сама является документом в формате JSON, который определяет:

Тип ожидаемых данных: type (например, "object", "array", "string", "number").
Обязательные поля: required — массив строк с именами ключей, которые должны присутствовать в объекте.
Ограничения на значения: minimum / maximum (для чисел), minLength / maxLength (для строк), pattern (регулярное выражение для строки), enum (перечисление допустимых значений).
Структура вложенных объектов и массивов: properties (определение схем для каждого ключа объекта), items (определение схемы для элементов массива), additionalProperties (разрешение или запрет дополнительных ключей).
Комбинированные схемы: allOf, anyOf, oneOf, not для создания сложных условий валидации.

¶Пример схемы JSON Schema

Предположим, необходимо валидировать JSON-объект, представляющий пользователя:

``json { "$schema": "http://json-schema.org/draft-07/schema#";, "title": "Пользователь", "type": "object", "required": ["id", "name", "email"], "properties": { "id": { "type": "integer", "minimum": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "email": { "type": "string", "format": "email" }, "age": { "type": "integer", "minimum": 0, "maximum": 150 } }, "additionalProperties": false } ``

Эта схема требует, чтобы объект содержал обязательные поля id (целое число >=1), name (строка от 1 до 100 символов) и email (строка в формате электронной почты). Поле age является необязательным, но если оно присутствует, то должно быть целым числом от 0 до 150. Любые другие поля (additionalProperties: false) приведут к ошибке валидации.

¶Пример валидного JSON

``json { "id": 42, "name": "Иван Петров", "email": "ivan@example.com", "age": 30 } ``

¶Пример невалидного JSON (отсутствует обязательное поле `id`)

``json { "name": "Мария", "email": "maria@test.ru" } ``

¶Инструменты и библиотеки для валидации

Валидация JSON реализована в виде библиотек для большинства языков программирования:

JavaScript: Встроенная функция JSON.parse() для синтаксической проверки. Для валидации по схеме используются библиотеки Ajv (Another JSON Schema Validator) и is-my-json-valid.
Python: Модуль json для синтаксической проверки. Библиотека jsonschema (реализует JSON Schema) и fastjsonschema.
Java: Библиотеки everit-json-schema, networknt/json-schema-validator, fge/json-schema-validator.
PHP: Функции json_decode() и json_last_error() для синтаксической проверки. Библиотеки justinrainbow/json-schema и opis/json-schema.
Ruby: Библиотека json-schema.
Go: Пакет encoding/json для синтаксической проверки, библиотека gojsonschema.
C# (.NET): Класс JsonDocument.Parse() (синтаксис), библиотека Newtonsoft.Json.Schema (NJsonSchema) и JsonSchema.NET.

¶Применение валидации JSON

Валидация JSON широко применяется в различных областях разработки программного обеспечения:

Веб-API (REST, GraphQL): Сервер валидирует входящие запросы (POST, PUT, PATCH) на соответствие ожидаемой схеме перед обработкой, что предотвращает ошибки, вызванные некорректными данными, и повышает безопасность (защита от инъекций).
Конфигурационные файлы: Многие современные приложения и инструменты (например, package.json для npm, .eslintrc.json для ESLint, composer.json для PHP) используют JSON для хранения конфигурации. Валидация гарантирует, что конфигурация имеет правильную структуру.
Обмен данными между микросервисами: Валидация сообщений, передаваемых через очереди (RabbitMQ, Kafka) или по HTTP, обеспечивает согласованность форматов данных между независимыми сервисами.
Тестирование: Валидация JSON-ответов API в автоматических тестах позволяет убедиться, что сервер возвращает данные в ожидаемом формате.
Генерация документации: Схемы JSON Schema могут использоваться для автоматической генерации документации к API (например, с помощью OpenAPI/Swagger).

¶Ограничения и сложности

Производительность: Валидация сложных или очень больших JSON-документов может быть ресурсоёмкой операцией, особенно при использовании множества комбинированных схем (allOf, anyOf).
Сложность схем: Создание и поддержка сложных схем JSON Schema (например, с рекурсивными ссылками или условной валидацией) может быть нетривиальной задачей.
Неполнота проверок: JSON Schema не покрывает все возможные бизнес-правила. Например, проверка уникальности значений в массиве объектов или кросс-полевая валидация (зависимость одного поля от другого) может потребовать написания дополнительного кода.
Версионирование схем: При изменении формата данных необходимо управлять версиями схем и обеспечивать обратную совместимость, чтобы не сломать существующие клиенты.

¶Источники

RFC 7159 — The JavaScript Object Notation (JSON) Data Interchange Format.
ECMA-404 — The JSON Data Interchange Syntax.
JSON Schema Specification (draft 2020-12, draft-07 и др.).
Документация библиотек Ajv (JavaScript), jsonschema (Python), everit-json-schema (Java).
Статья «JSON Schema» на сайте json-schema.org.

Заметили ошибку или не согласны с информацией в статье? Напишите нам support@bfometr.ru