Как создать JSON в 1С Предприятие: методы и примеры

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

Процесс создания JSON-документа в 1С может варьироваться от использования визуального конструктора для разовых операций до написания программного кода для автоматизации бизнес-процессов. Выбор конкретного метода зависит от требований к производительности, гибкости структуры и частоты выполнения операции. Сериализация данных в 1С происходит с учетом типов данных платформы, что позволяет корректно передавать даты, числа и булевы значения без потери информации.

В этой статье мы детально разберем основные способы создания JSON в 1С, уделив особое внимание объектам метаданных ЗаписьJSON и ЧтениеJSON. Вы узнаете, как избежать распространенных ошибок при кодировании специальных символов и как оптимизировать объем передаваемых данных. Правильная настройка параметров записи обеспечит совместимость вашего продукта с внешними сервисами и мобильными приложениями.

Использование Конструктора JSON для быстрой выгрузки

Для разработчиков, которые не хотят погружаться в написание кода для разовых задач или тестирования структур, платформа 1С предлагает встроенный инструмент — Конструктор JSON. Этот механизм позволяет визуально спроектировать структуру будущего документа, выбрав необходимые поля из существующих объектов метаданных или запросов. Доступ к нему осуществляется через меню конфигуратора или непосредственно из окна отладки при работе с переменными.

Основное преимущество данного подхода заключается в скорости получения результата. Вам не нужно вручную прописывать пути к свойствам или worrying о синтаксисе скобок и запятых. Конструктор автоматически сформирует корректный текст запроса или код процедуры, который можно сразу использовать в обработке или внешнем отчете. Это особенно полезно при создании прототипов интеграции, когда важно быстро проверить, какие данные доступны для передачи.

⚠️ Внимание: Конструктор JSON генерирует код, ориентированный на конкретную структуру метаданных на момент создания. Если вы добавите новые реквизиты в справочник или измените имена полей, сгенерированный ранее код может потребовать ручной доработки, так как он не обновляется автоматически.

При работе с конструктором важно правильно выбрать режим работы: запись значений null или их исключение. По умолчанию система может выгружать пустые значения, что увеличивает объем файла, но сохраняет структуру. Для оптимизации трафика рекомендуется настроить фильтрацию пустых полей, если принимающая сторона не требует их обязательного присутствия. Также стоит обратить внимание на кодировку, чтобы кириллические символы отображались корректно во всех системах.

Программная запись JSON через объект ЗаписьJSON

Наиболее гибким и производительным способом создания JSON-документов является использование встроенного объекта ЗаписьJSON. Этот объект позволяет пошагово формировать структуру документа, открывая и закрывая контексты объектов и массивов. Такой подход дает полный контроль над процессом сериализации и позволяет динамически изменять структуру вывода в зависимости от условий выполнения программы.

Для начала работы необходимо создать экземпляр объекта и связать его с потоком данных. Это может быть файл на диске, строка в памяти или сетевой поток. Важно указать параметры записи, такие как использование отступов для читаемости (в режиме отладки) или компактный режим (для продакшена). Правильная настройка параметров ПараметрыЗаписиJSON влияет на итоговый размер файла и скорость его обработки принимающей стороной.

Запись = Новый ЗаписьJSON();
Запись.УстановитьСтроку();
Параметры = Новый ПараметрыЗаписиJSON();
Параметры.Отступы = 2;
Запись.ЗаписатьНачалоОбъекта(Параметры);

В процессе записи вы последовательно вызываете методы для добавления свойств и значений. Метод ЗаписатьИмяСвойства определяет ключ объекта, а последующий метод записи значения (например, ЗаписатьЗначение) заполняет его содержанием. Система автоматически экранирует специальные символы в строках, что избавляет разработчика от необходимости ручной обработки кавычек или обратных слешей. Это существенно снижает риск возникновения синтаксических ошибок в итоговом JSON.

Завершение формирования документа требует вызова метода ЗаписатьКонецОбъекта, который закрывает последнюю открытую скобку. После этого можно получить результат через метод Запись.ЗакрытьИЗавершить(), который вернет строку или сохранит данные в файл в зависимости от типа используемого потока. Не забудьте освободить ресурсы, если работа велась с файловыми потоками, чтобы избежать блокировок файлов операционной системой.

Автоматическая сериализация объектов 1С в JSON

Начиная с определенных версий платформы, 1С Предприятие поддерживает возможность автоматической записи значений непосредственно в объект ЗаписьJSON. Это означает, что вам не нужно вручную перебирать свойства структуры или объекта справочника, если их имена совпадают с требуемыми ключами JSON. Метод ЗаписатьЗначение способен самостоятельно проанализировать переданный объект и рекурсивно записать его содержимое в соответствии с правилами платформы.

Такой подход значительно упрощает код обработки данных. Вместо десятков строк с вызовами методов записи для каждого поля, вы можете передать целый объект документа или структуру одним вызовом. Система сама определит типы данных, преобразует даты в строковый формат ISO 8601 и корректно обработает вложенные коллекции. Это особенно актуально при передаче сложных иерархических данных, таких как заказы с табличными частями.

• 🚀 Скорость разработки: сокращение объема кода в 5-10 раз за счет автоматического обхода свойств.
• 🛡️ Безопасность типов: платформа гарантирует корректное преобразование типов данных 1С в типы JSON.
• 🔄 Гибкость: возможность легкой модификации структуры объекта 1С без изменения кода сериализации.

Однако при автоматической сериализации следует учитывать особенности именования полей. Имена свойств в JSON будут соответствовать именам реквизитов в конфигурации 1С. Если внешняя система ожидает ключи на английском языке (например, invoiceDate), а в базе они названы по-русски или иначе (например, ДатаСчета), потребуется предварительное преобразование объекта в структуру с нужными именами ключей. Игнорирование этого требования приведет к ошибкам парсинга на стороне клиента.

⚠️ Внимание: При автоматической записи циклических ссылок (когда объект ссылается сам на себя или образует цикл через другие объекты) система выдаст ошибку переполнения стека. Всегда проверяйте структуру передаваемых данных на наличие циклических зависимостей перед сериализацией.

Работа с коллекциями и массивами в JSON

Массивы являются неотъемлемой частью формата JSON и широко используются для передачи списков товаров, перечня услуг или истории изменений. В 1С для записи массивов используется метод ЗаписатьНачалоМассива, после которого следует цикл записи значений элементов. Важно понимать, что JSON-массив — это упорядоченная коллекция, индексы в которой не именуются, в отличие от объектов, где каждый элемент имеет ключ.

При формировании массива из табличной части документа 1С необходимо последовательно проходить по строкам таблицы и записывать значения каждой строки как отдельный объект внутри массива. Это создает структуру вида [{...}, {...}, {...}], которая стандартна для представления списков в веб-разработке. Ошибка в последовательности вызовов методов (например, попытка записать имя свойства внутри массива без открытия объекта) приведет к невалидному JSON.

Метод 1С	Действие в JSON	Пример результата
ЗаписатьНачалоМассива()	Открывает квадратную скобку	[
ЗаписатьЗначение(100)	Записывает числовое значение	100
ЗаписатьКонецМассива()	Закрывает квадратную скобку	]
ЗаписатьИмяСвойства("Key")	Недопустимо внутри чистого массива	Ошибка структуры

Вложенные массивы позволяют создавать многомерные структуры данных, что может потребоваться для передачи матриц или сложных классификаторов. Логика записи остается той же: внутри метода записи значения вы можете инициировать новый массив или объект. Главное — строго соблюдать баланс открывающих и закрывающих вызовов. Нарушение этого баланса является самой частой причиной, по которой сгенерированный файл не читается внешними системами.

Обработка специальных символов и кодировок

Одной из критических задач при создании JSON является корректная обработка текстовых данных, содержащих специальные символы. Формат JSON требует экранирования кавычек, обратных слешей, символов перевода строки и табуляции. Объект ЗаписьJSON в 1С выполняет эту операцию автоматически, преобразуя символ " в последовательность \" внутри строковых значений. Это защищает структуру документа от разрушения при наличии кавычек в тексте описания товаров или комментариев.

Вопрос кодировки стоит особенно остро при интеграции с системами, работающими в разных языковых средах. По умолчанию 1С использует кодировку UTF-8, которая является стандартом для веба и полностью поддерживает кириллицу, эмодзи и символы большинства языков мира. При записи в файл важно убедиться, что поток также настроен на использование UTF-8 без BOM (Byte Order Mark), так как наличие BOM может вызвать проблемы у некоторых парсеров на стороне JavaScript или PHP.

В версиях платформы 1С:Предприятие 8.3.18 и выше улучшена поддержка суррогатных пар Unicode, что позволяет корректно выгружать редкие символы и эмодзи без искажений.

Если вы формируете JSON строку вручную (без использования объекта ЗаписьJSON), вы обязаны самостоятельно реализовать функцию экранирования. Игнорирование этого правила приведет к тому, что любой текст, содержащий кавычку, "сломает" весь документ. Использование встроенных средств платформы не только безопасно, но и производительнее, так как реализовано на низкоуровневом коде движка.

Как экранировать символы вручную?

Если вы все же вынуждены формировать строку вручную, используйте функцию СтрЗаменить() для замены двойной кавычки на \" и обратного слэша на \\. Также необходимо заменить символы перевода строки (Символы.ПС) на \n.

Оптимизация размера JSON и производительность

При передаче больших объемов данных размер JSON-файла становится фактором, влияющим на скорость работы всей системы. Излишние отступы, пробелы и переносы строк, которые удобны для чтения человеком, увеличивают размер файла на 20-30% и замедляют его передачу по сети. Для продуктивной среды рекомендуется использовать компактный режим записи, отключив форматирование в параметрах объекта ЗаписьJSON.

Еще одним способом оптимизации является фильтрация передаваемых данных. Не стоит выгружать весь объект документа, если внешней системе нужны только три реквизита. Формирование легкой структуры или использование запроса с отбором только необходимых полей перед сериализацией существенно снижает нагрузку на канал связи и процессор сервера. Это особенно важно для мобильных клиентов, работающих через нестабильный интернет.

• 📉 Отключение отступов: параметр Отступы = 0 убирает все пробелы и переносы строк.
• 🗑️ Исключение null: настройка ЗаписыватьNullЗначения = Ложь убирает пустые поля.
• 📦 Сжатие: использование gzip-сжатия на уровне HTTP-протокола при передаче готового JSON.

Производительность записи также зависит от количества вызовов методов. Группировка данных и запись их крупными блоками (например, запись целой структуры вместо поочередной записи каждого свойства) работает быстрее. В высоконагруженных системах, где генерация JSON происходит тысячи раз в минуту, даже микросекундная экономия на одной операции дает существенный выигрыш в масштабах дня.

⚠️ Внимание: Интерфейсы и методы работы с JSON могут незначительно отличаться в зависимости от конкретной версии платформы 1С и конфигурации. Перед внедрением решения в промышленную эксплуатацию обязательно сверьте синтаксис методов в справочнике разработчика для вашей актуальной версии.

Часто задаваемые вопросы (FAQ)

Как преобразовать готовую строку JSON обратно в объект 1С?

Для обратного преобразования (парсинга) используется объект ЧтениеJSON. Вы создаете экземпляр этого объекта, открываете строку или файл, а затем используете метод Прочитать(). Результатом будет структура 1С или массив, полностью соответствующие исходному JSON-документу, с сохранением типов данных.

Можно ли записать JSON сразу в HTTP-соединение без сохранения в файл?

Да, это наиболее эффективный сценарий для веб-сервисов. Объект ЗаписьJSON может быть инициализирован потоком, полученным из метода ПолучитьПотокЗаписи() объекта HTTPСоединение. Данные будут отправляться непосредственно в сеть по мере их генерации, что экономит дисковое пространство и ускоряет ответ сервера.

Почему даты в JSON выглядят как "/Date(1678886400000)/"?

Это стандартное представление даты в некоторых реализациях JSON для .NET, но 1С по умолчанию записывает дату в формате ISO 8601 (например, "2023-03-15T10:00:00"). Если вы видите формат "/Date(...)/", возможно, используется сторонняя библиотека или специфические настройки сериализации. В стандартном объекте ЗаписьJSON даты выгружаются в читаемом строковом формате.

Как обработать ошибку, если JSON невалиден?

При чтении невалидного JSON объект ЧтениеJSON выбросит исключение. Оберните процедуру чтения в блок Попытка...Исключение. В блоке обработки исключения вы можете записать текст ошибки (доступен через ОписаниеОшибки()) в журнал регистрации, чтобы проанализировать причину сбоя, например, отсутствие закрывающей скобки.

Поддерживает ли 1С запись комментариев внутри JSON?

Стандарт RFC 8259, описывающий формат JSON, не поддерживает комментарии. Объект ЗаписьJSON в 1С также не имеет методов для вставки комментариев. Попытка вставить текст комментария вручную сделает документ невалидным для большинства парсеров. Если необходимо хранить метаданные о структуре, используйте специальные служебные поля (начинающиеся с нижнего подчеркивания).