ФабрикаXDTO.ПрочитатьJSON

Методы · ReadJSON

Читает элемент данных XDTO указанного типа из объекта чтения JSON.

Синтаксис

ПрочитатьJSON(<ЧтениеJSON>, <Тип>, <ИмяФункцииВосстановления>, <МодульФункцииВосстановления>, <ДополнительныеПараметрыФункцииВосстановления>, <ТипыДляОбработкиВосстановления>, <ИменаСвойствДляВосстановления>, <НазначениеТипа>)
Полное описание, параметры и ограничения

ФабрикаXDTO.ПрочитатьJSON (XDTOFactory.ReadJSON)

ФабрикаXDTO (XDTOFactory)

ПрочитатьJSON (ReadJSON)

Доступен, начиная с версии 8.3.7.

Синтаксис:
ПрочитатьJSON(<ЧтениеJSON>, <Тип>, <ИмяФункцииВосстановления>, <МодульФункцииВосстановления>, <ДополнительныеПараметрыФункцииВосстановления>, <ТипыДляОбработкиВосстановления>, <ИменаСвойствДляВосстановления>, <НазначениеТипа>)
Параметры:

<ЧтениеJSON> (обязательный)
Тип: ЧтениеJSON.
Объект чтения JSON.

<Тип> (необязательный)
Тип: ТипЗначенияXDTO, ТипОбъектаXDTO.
Тип элемента данных XDTO. Если тип не указан, то будет сделана попытка определить тип данных по текущему состоянию объекта ЧтениеJSON.

<ИмяФункцииВосстановления> (необязательный)
Тип: Строка.
Имя функции восстановления значения.
Функция должна иметь следующие параметры:
<Свойство> - значение типа Строка,

<Тип> - значение типа ТипОбъектаXDTO,

<Значение> - значение допустимого для сериализации типа,

<ДополнительныеПараметры>.
Возвращаемое значение - допустимого для XDTO сериализации типа.
Значение по умолчанию: Неопределено.

<МодульФункцииВосстановления> (необязательный)
Тип: ФормаКлиентскогоПриложения, КомандаКомандногоИнтерфейса, ОбщийМодуль.
Указывает модуль, процедура которого будет использована для восстановления значения. В зависимости от типа параметра будет вызван соответствующий метод:
ФормаКлиентскогоПриложения - будет вызван метод модуля указанной формы клиентского приложения.

КомандаКомандногоИнтерфейса - будет вызван метод модуля команды командного интерфейса.

ОбщийМодуль - будет вызван метод неглобального общего модуля.

Значение по умолчанию: Неопределено.

<ДополнительныеПараметрыФункцииВосстановления> (необязательный)
Тип: Произвольный.
Дополнительные параметры для функции восстановления.
Значение по умолчанию: Неопределено.

<ТипыДляОбработкиВосстановления> (необязательный)
Тип: Массив.
Массив объектов ТипОбъектаXDTO, соответствующих типам XDTO, для которых требуется вызвать функцию восстановления.
Если функция восстановления не задана, то параметры <ТипыДляОбработкиВосстановления> и <ИменаСвойствДляВосстановления> игнорируются.

<ИменаСвойствДляВосстановления> (необязательный)
Тип: Массив.
Имена свойств, для которых нужно вызвать функцию восстановления.
Если функция восстановления не задана, то параметры <ТипыДляОбработкиВосстановления> и <ИменаСвойствДляВосстановления> игнорируются.

<НазначениеТипа> (необязательный)
Тип: НазначениеТипаXML.
Назначение типа данных произвольных свойства при чтении.
Значение по умолчанию: Неявное.
Возвращаемое значение:
Тип: ОбъектXDTO.

Описание:

Читает элемент данных XDTO указанного типа из объекта чтения JSON.

Доступность:

Тонкий клиент, мобильный клиент, сервер, толстый клиент, внешнее соединение, мобильное приложение (клиент), мобильное приложение (сервер), мобильный автономный сервер.

Использование в версии:

Доступен, начиная с версии 8.3.7.

Описание изменено в версии 8.3.25.

Методическая информация

Практические примеры

Записать собственный заказ в XDTO-JSON и прочитать независимую копию

Используется именно фабрика своей схемы, с явным ожидаемым типом Order при чтении. Формат XDTO-JSON не объявляется контрактом Avito или любого другого бизнес-API.

Где и как запускать

Полный серверный общий модуль собственной отдельной учебной конфигурации.

Подготовка

  1. Создайте отдельную собственную конфигурацию с именем УчебнаяКонфигурацияСинтаксиса. Не используйте рабочую КА2, УНФ, УТ или БП.

  2. Создайте неглобальный общий модуль УчебнаяМодельXDTO85 с флагом Сервер. Вставьте весь выбранный пример, включая вспомогательные функции, если они присутствуют.

  3. Из серверной команды своей учебной обработки вызовите УчебнаяМодельXDTO85.ВыполнитьПример(). Передавать неизвестный объект или реквизиты чужой конфигурации не нужно.

  4. XSD целиком встроена в код: артикул Sku, цвет Color, список артикулов, объединение, абстрактный Base, строка Item, производный Order и смешанный Note.

  5. Справочники, документы и пакеты XDTO метаданных создавать не нужно. Схема и фабрика принадлежат только этому выполнению в памяти.

  6. urn:guide:model85 и URI стандартной XML Schema — идентификаторы пространств имён. Код не загружает их из Интернета; import/include, DTD и внешних файлов нет.

  7. Проверки Истина относятся к приведённой неизменённой учебной XSD. После её изменения сначала пересмотрите ожидаемые типы, границы и обязательность.

  8. Это полный учебный исходник с проверенными статически API, но запуск в 1С не проверялся. Ошибку подготовки схемы не следует принимать за успешную проверку данных.

Процедура ВыполнитьПример() Экспорт
    XSD = "<xs:schema xmlns:xs=""http://www.w3.org/2001/XMLSchema"" xmlns:g=""urn:guide:model85"" targetNamespace=""urn:guide:model85"" elementFormDefault=""qualified"" attributeFormDefault=""unqualified"">
    |<xs:simpleType name=""Sku""><xs:restriction base=""xs:string""><xs:length value=""4""/><xs:pattern value=""[A-Z][0-9]{3}""/></xs:restriction></xs:simpleType>
    |<xs:simpleType name=""Color""><xs:restriction base=""xs:string""><xs:enumeration value=""red""/><xs:enumeration value=""blue""/></xs:restriction></xs:simpleType>
    |<xs:simpleType name=""SkuList""><xs:list itemType=""g:Sku""/></xs:simpleType>
    |<xs:simpleType name=""QuantityOrCode""><xs:union memberTypes=""xs:positiveInteger g:Sku""/></xs:simpleType>
    |<xs:complexType name=""Base"" abstract=""true""><xs:attribute name=""code"" type=""g:Sku"" use=""required""/></xs:complexType>
    |<xs:complexType name=""Item""><xs:sequence><xs:element name=""name"" type=""xs:string""/><xs:element name=""quantity"" type=""xs:nonNegativeInteger""/></xs:sequence></xs:complexType>
    |<xs:complexType name=""Order""><xs:complexContent><xs:extension base=""g:Base""><xs:sequence><xs:element name=""item"" type=""g:Item"" minOccurs=""0"" maxOccurs=""unbounded""/></xs:sequence></xs:extension></xs:complexContent></xs:complexType>
    |<xs:complexType name=""Note"" mixed=""true""><xs:sequence><xs:element name=""amount"" type=""xs:decimal"" minOccurs=""0"" maxOccurs=""unbounded""/></xs:sequence></xs:complexType>
    |<xs:element name=""order"" type=""g:Order""/><xs:element name=""note"" type=""g:Note""/>
    |</xs:schema>";
    ЧтениеСхемы = Новый ЧтениеXML;
    ЧтениеСхемы.УстановитьСтроку(XSD);
    Попытка
        Дерево = Новый ПостроительDOM;
        ДокументСхемы = Дерево.Прочитать(ЧтениеСхемы);
    Исключение
        ОшибкаСхемы = ОписаниеОшибки();
        Попытка
            ЧтениеСхемы.Закрыть();
        Исключение
            ВызватьИсключение ОшибкаСхемы + Символы.ПС + "Закрытие: " + ОписаниеОшибки();
        КонецПопытки;
        ВызватьИсключение ОшибкаСхемы;
    КонецПопытки;
    ЧтениеСхемы.Закрыть();
    ПостроительСхем = Новый ПостроительСхемXML;
    Схема = ПостроительСхем.СоздатьСхемуXML(ДокументСхемы.ЭлементДокумента);
    Если Схема = Неопределено Тогда
        ВызватьИсключение "Не построена собственная схема коллекций";
    КонецЕсли;
    НаборСхем = Новый НаборСхемXML;
    НаборСхем.Добавить(Схема);
    Если НЕ НаборСхем.Проверить() Тогда
        ВызватьИсключение "Собственная схема не прошла проверку";
    КонецЕсли;
    Фабрика = Новый ФабрикаXDTO(НаборСхем);
    ТипЗаказа = Фабрика.Тип("urn:guide:model85", "Order");
    ТипСтроки = Фабрика.Тип("urn:guide:model85", "Item");
    Если ТипЗаказа = Неопределено ИЛИ ТипСтроки = Неопределено Тогда
        ВызватьИсключение "В собственной модели не найдены Order и Item";
    КонецЕсли;
    Заказ = Фабрика.Создать(ТипЗаказа);
    СвойствоКода = Заказ.Свойства().Получить("code");
    СвойствоСтрок = Заказ.Свойства().Получить("item");
    СвойствоИмени = ТипСтроки.Свойства.Получить("name");
    СвойствоКоличества = ТипСтроки.Свойства.Получить("quantity");
    Если СвойствоКода = Неопределено ИЛИ СвойствоСтрок = Неопределено
        ИЛИ СвойствоИмени = Неопределено ИЛИ СвойствоКоличества = Неопределено Тогда
        ВызватьИсключение "В собственной модели не найдены четыре описателя";
    КонецЕсли;
    Заказ.Установить(СвойствоКода, Фабрика.Создать(СвойствоКода.Тип, "A001"));
    СтрокиЗаказа = Заказ.ПолучитьСписок(СвойствоСтрок);
    Книга = Фабрика.Создать(ТипСтроки);
    Книга.Установить(СвойствоИмени, Фабрика.Создать(СвойствоИмени.Тип, "Книга"));
    Книга.Установить(СвойствоКоличества, Фабрика.Создать(СвойствоКоличества.Тип, "3"));
    Книга = СтрокиЗаказа.Добавить(Книга);
    Если ТипЗнч(Книга) <> Тип("ОбъектXDTO") Тогда
        ВызватьИсключение "Добавленная строка должна быть составным объектом";
    КонецЕсли;
    Заказ.Проверить();
    Запись = Новый ЗаписьJSON;
    Запись.УстановитьСтроку();
    Попытка
        Фабрика.ЗаписатьJSON(Запись, Заказ);
    Исключение
        ОшибкаЗаписи = ОписаниеОшибки();
        Попытка
            Запись.Закрыть();
        Исключение
            ВызватьИсключение ОшибкаЗаписи + Символы.ПС + "Закрытие записи: " + ОписаниеОшибки();
        КонецПопытки;
        ВызватьИсключение ОшибкаЗаписи;
    КонецПопытки;
    JSON = Запись.Закрыть();
    Сообщить(JSON);
    Чтение = Новый ЧтениеJSON;
    Чтение.УстановитьСтроку(JSON);
    Попытка
        Копия = Фабрика.ПрочитатьJSON(Чтение, ТипЗаказа);
    Исключение
        ОшибкаЧтения = ОписаниеОшибки();
        Попытка
            Чтение.Закрыть();
        Исключение
            ВызватьИсключение ОшибкаЧтения + Символы.ПС + "Закрытие чтения: " + ОписаниеОшибки();
        КонецПопытки;
        ВызватьИсключение ОшибкаЧтения;
    КонецПопытки;
    Чтение.Закрыть();
    Если ТипЗнч(Копия) <> Тип("ОбъектXDTO") Тогда
        ВызватьИсключение "Ожидалась составная копия собственного Order";
    КонецЕсли;
    Копия.Проверить();
    Сообщить(Копия.Тип() = ТипЗаказа);
    Сообщить(Копия.Получить(СвойствоКода) = "A001");
    КопияСтрок = Копия.ПолучитьСписок(СвойствоСтрок);
    Сообщить(КопияСтрок.Количество() = 1);
    КопияКниги = КопияСтрок.ПолучитьXDTO(0);
    Сообщить(КопияКниги.Получить(СвойствоИмени) = "Книга");
    Сообщить(КопияКниги.Получить(СвойствоКоличества) = 3);
    Книга.Установить(СвойствоКоличества, Фабрика.Создать(СвойствоКоличества.Тип, "4"));
    Заказ.Проверить();
    Сообщить(Книга.Получить(СвойствоКоличества) = 4);
    Сообщить(КопияКниги.Получить(СвойствоКоличества) = 3);
КонецПроцедуры

Разбор по шагам

  1. Создать свою фабрику и заполненный Order. Сериализация не исправляет незаполненные обязательные поля, поэтому сначала Проверить.

  2. Установить строковый приёмник ЗаписьJSON. Фабрика.ЗаписатьJSON получает именно свой Заказ, не обычную структуру внешнего сервиса.

  3. Закрыть запись и получить готовую строку JSON. При ошибке закрытие тоже выполняется, а ошибка не подавляется.

  4. Открыть ЧтениеJSON на только что полученной строке. Явно передать собственный ТипЗаказа, не рассчитывая на угадывание типа.

  5. Закрыть чтение при успехе и ошибке. Перед использованием копии проверить платформенный тип и полную модель объекта.

  6. Сравнить артикул, количество строк, название и количество Книги. Не сравнивать JSON посимвольно или порядок полей.

  7. Изменить исходную Книгу с 3 на 4 и убедиться, что прочитанная копия сохранила 3.

  8. Строка остаётся в памяти; отправки Avito, HTTP или записи документа нет. Для реальной интеграции нужен отдельный согласованный JSON-контракт.

Как проверить результат

  1. Показана строка XDTO-JSON, затем семь булевых сообщений Истина.

  2. Копия имеет тип Order, артикул A001, одну строку Книга с количеством 3.

  3. После изменения оригинала его количество 4, количество копии 3. Чтение и запись закрыты.

Ожидаемый результат

Собственная модель прошла круг XDTO → JSON → XDTO с проверкой полей и независимости копии.

На что обратить внимание

  1. ФабрикаXDTO.ЗаписатьJSON и глобальный ЗаписатьJSON не являются взаимозаменяемыми API.

  2. XDTO-JSON не обещает форму {id, title, price}, которую ожидает внешний бизнес-сервис.

  3. Не читайте неизвестный большой JSON без проверки размера, глубины, контракта и разрешённых типов. Здесь строка создана только своим кодом.

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

  5. Успешная статическая проверка источника не является доказательством выполнения сериализации в 1С.

Пример не запускался в вашей базе. Перед применением проверьте его в указанном учебном контексте.

Не хотите разбираться сами?

Адаптируем это решение под вашу базу. Оценка бесплатно.

Оставить задачу

1С, 1С:Предприятие — товарные знаки ООО «1С». Сайт не является официальным представительством фирмы «1С» и не аффилирован с ней.