Гайд по XDTO для чайников

Глава 1. Основы XDTO: Введение в механизм

1.1. Что такое XDTO: концепция и назначение

Представьте, что вы зашли в магазин за картошкой, а продавец вместо привычного мешка протягивает вам свёрток, где каждая картофелина аккуратно завернута в подарочную упаковку. Это, конечно, мило, но немного сложно. Теперь представьте, что этот свёрток — это XML-документ, а каждая картофелина — данные, которые нужно передать от одной системы к другой. Вот тут на сцену выходит XDTO (XML Data Transfer Objects) — механизм, который делает передачу данных через XML более удобной. В 1С он позволяет работать с этими данными не как с запутанным текстом, а как с привычными объектами: сотрудник, счет, таблица значений.

XDTO нужен, чтобы:

1. Обмениваться данными между разными системами (например, 1С и внешней CRM).
2. Создавать удобные бизнес-объекты, которыми легко манипулировать в коде.
3. Упростить работу с веб-сервисами, где XML — основной язык общения.

В общем, XDTO — это ваш персональный переводчик с языка XML на язык 1С.

1.2. История создания и роль в экосистеме 1С

XDTO появился с выходом платформы 8.1. В те времена программисты часто морщились, пытаясь вручную собирать и разбирать XML-файлы. Это было похоже на попытку разобрать гигантский пазл без картинки. Компания 1С решила, что надо упрощать жизнь разработчикам, и придумала XDTO. Это такой супергерой, который превращает запутанные XML-данные в аккуратные объекты, к которым можно обращаться через точку: Сотрудник.ФИО, Сотрудник.Должность и так далее.

Сегодня XDTO используется для интеграции с веб-сервисами, обмена данными между конфигурациями и решения других задач, где требуется работать с XML.

1.3. Основные задачи, решаемые механизмом XDTO

Вот несколько примеров, где XDTO спасает мир (и нервы программистов):

1. Обмен данными между системами. Допустим, ваша 1С обменивается информацией о заказах с сайтом интернет-магазина. XDTO помогает завернуть данные в нужный формат XML и отправить их, а потом разобрать ответ от сайта.
2. Упрощение работы с XML. Вместо того чтобы ковыряться в узлах XML-документа, вы работаете с привычными объектами. Это как разница между поеданием орехов в скорлупе и уже очищенных.
3. Создание моделей данных. Вы можете описать структуру объектов (например, “Сотрудник”) и затем легко с ними работать. Это особенно полезно, если нужно строго соблюдать формат данных.

1.4. Преимущества и ограничения

Преимущества:

• Простота. XML превращается в объекты, с которыми легко работать.
• Гибкость. Вы сами определяете, какие данные нужны и в каком виде.
• Автоматизация. 1С сама заботится о создании и чтении XML, вам остаётся только описать модель данных.

Ограничения:

• Требуется заранее продумывать структуру данных (создание схем XML).
• Работа с механизмом требует знаний XML и особенностей XDTO.
• Иногда возникают сюрпризы в поведении (например, особенности работы со списками), которые нужно учитывать.

1.5. Устройство XDTO: обзор ключевых понятий

Чтобы понять, как работает XDTO, давайте разберём его основные компоненты:

1. XML-схема. Это как чертёж здания. Она описывает, какие данные и в каком виде можно хранить в XML-документе. Например, схема может сказать: “У сотрудника есть ФИО (строка) и ДатаРождения (дата).”
2. Модель данных. Это совокупность всех схем XML, которые вы используете. Она объединяет чертежи в единую картину.
3. Фабрика XDTO. Это инструмент для создания объектов на основе схем. Она знает, как создать объект “Сотрудник” или список сотрудников, и позволяет обращаться к их свойствам через точку.
4. Объекты XDTO. Это ваши бизнес-объекты: сотрудник, счёт, заказ. Они описываются схемой и позволяют работать с данными так, будто вы работаете с обычными переменными в 1С.
5. Список XDTO. Если у объекта есть повторяющиеся элементы (например, список заказов), вы работаете с ними через специальные методы.
6. Сериализация и десериализация. Это процесс превращения объекта в XML и обратно. XDTO автоматически заботится о корректности данных на этом этапе.

Глава 2. Работа с XML-схемами и моделями данных XDTO

2.1. Понятие XML-схемы: базовые концепции и структура

Итак, вы решили начать использовать XDTO. С чего начать? Конечно, с XML-схемы. Это как паспорт для данных — в ней описано, что допустимо, а что нет. Например, у сотрудника должно быть имя (обязательно строка) и дата рождения (в формате даты). Если данных нет в схеме — их просто не примут.

XML-схема — это текстовый файл, который описывает структуру и правила для XML-документа. Она говорит: “Тут должна быть строка длиной не больше 255 символов, а вот здесь — число от 1 до 100”.

Пример: вот как выглядит простая схема для сотрудника:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">

    <xs:element name="Сотрудник">

        <xs:complexType>

            <xs:sequence>

                <xs:element name="ФИО" type="xs:string" />

                <xs:element name="ДатаРождения" type="xs:date" />

            </xs:sequence>

        </xs:complexType>

    </xs:element>

</xs:schema>

Здесь описан объект “Сотрудник”, который состоит из двух свойств: ФИО (строка) и ДатаРождения (дата).

2.2. Простые и составные типы данных

В XDTO все данные делятся на два типа: простые и составные.

1. Простые типы — это строки, числа, даты и другие значения, которые нельзя разбить на части. Например, "25.01.2025" — это простая дата, а "Иванов Иван" — простая строка.
2. Составные типы — это структуры, которые состоят из других данных. Например, объект "Сотрудник" состоит из ФИО и даты рождения. Внутри составного типа могут быть как простые, так и другие составные данные.

Пример:

• Простое: "xs:string"
• Составное: объект "Сотрудник", который состоит из свойств "ФИО" и "ДатаРождения".

2.3. Пространства имен и их роль в моделях данных

Пространства имен в XML — это как фамилии у людей. Они нужны, чтобы объекты с одинаковыми именами не путались. Например, если есть объект "Сотрудник" в одной компании и в другой, у каждого будет своё пространство имен.

Пространство имен выглядит как URL, например: http://example.com/employees. На самом деле это не ссылка, а просто уникальный идентификатор.

2.4. Создание XML-схем с помощью Liquid XML Studio

Liquid XML Studio — это инструмент, который упрощает работу с XML-схемами.

Вы можете тыкать мышкой, а он создаёт схему за вас. Вот как это работает:

1. Установите программу и создайте новый проект.
2. Добавьте корневой элемент, например, "Сотрудник".
3. Укажите свойства: ФИО (строка), ДатаРождения (дата).
4. Экспортируйте схему в файл .xsd.

2.5. Импорт схем XML в конфигурацию 1С

Когда схема готова, её нужно подключить в 1С:

1. В дереве конфигурации откройте "Пакеты XDTO".
2. Щёлкните правой кнопкой и выберите "Импорт схемы XML".
3. Укажите файл схемы.
4. Теперь схема доступна в конфигурации, и вы можете использовать её для работы с объектами.

Редактирование XDTO пакета осуществляется в специальном окне, отображающем иерархическую структуру XDTO-пакета:

Вот и всё! Теперь вы знаете, как создать XML-схему, подключить её к 1С и начать использовать. В следующей главе мы разберём, как создавать и манипулировать объектами XDTO.

Глава 3. Работа с фабрикой XDTO: создание и манипуляция объектами

3.1. Фабрика XDTO: что это и зачем она нужна

Фабрика XDTO — это как волшебный повар, который превращает рецепт (XML-схему) в готовое блюдо (объект XDTO). Она знает, как создавать объекты, описанные в вашей модели данных, и позволяет вам работать с ними в коде.

Например, вы описали в XML-схеме, что у вас есть объект «Сотрудник» с полями ФИО и ДатаРождения. С помощью фабрики вы можете создать объект этого типа и заполнить его данными.

Фабрика умеет:

• Создавать объекты на основе типов.
• Добавлять объекты в списки.
• Проверять, соответствует ли объект заданной модели данных.

3.2. Создание объектов XDTO: типы данных, типы объектов

Создание объекта XDTO начинается с выбора типа. В 1С это делается с помощью метода ФабрикаXDTO.Тип. Вы указываете пространство имен и имя типа, и фабрика возвращает вам объект, с которым можно работать.

Пример:

ТипОбъекта = ФабрикаXDTO.Тип("http://example.com/employees", "Сотрудник");
ОбъектСотрудник = ФабрикаXDTO.Создать(ТипОбъекта);
ОбъектСотрудник.ФИО = "Иванов Иван Иванович";
ОбъектСотрудник.ДатаРождения = '1980-01-01';

Здесь мы создали объект типа «Сотрудник» и заполнили его свойства.

3.3. Использование объектов XDTO в коде: работа через точки доступа

Объекты XDTO работают как обычные объекты 1С. Вы можете обращаться к их свойствам через точку:

• Прочитать значение: ФИО = ОбъектСотрудник.ФИО;
• Изменить значение: ОбъектСотрудник.ФИО = "Петров Петр Петрович";

Если объект содержит списки (например, список телефонов), то вы можете добавлять в них элементы:

Телефон = ФабрикаXDTO.Создать(ФабрикаXDTO.Тип("http://example.com/employees", "Телефон"));
Телефон.Номер = "+7-999-123-45-67";

ОбъектСотрудник.Телефоны.Добавить(Телефон);

3.4. Особенности списков XDTO: работа с коллекциями

Списки XDTO — это особый тип объектов, который позволяет хранить несколько элементов одного типа. Например, у сотрудника может быть список телефонов или адресов.

Для работы со списками есть следующие методы:

• Добавить(Объект): добавляет элемент в список.
• Получить(Индекс): возвращает элемент списка по индексу.
• Количество(): возвращает количество элементов в списке.

Пример:

Для Номера = 0 По ОбъектСотрудник.Телефоны.Количество() - 1 Цикл
    Телефон = ОбъектСотрудник.Телефоны.Получить(Номера);
    Сообщить(Телефон.Номер);
КонецЦикла;

3.5. Уникальные аспекты фабрики: валидность объектов, контроль моделей данных

Фабрика XDTO строго следит за соответствием объектов их типам. Если вы попытаетесь добавить свойство, которого нет в схеме, или указать значение неверного типа, то получите ошибку.

Пример ошибки:

ОбъектСотрудник.НеизвестноеПоле = "Что-то лишнее"; // Ошибка

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

Теперь вы знаете, как создавать и использовать объекты XDTO, а также работать со списками. В следующей главе мы разберём, как записывать эти объекты в XML и читать их обратно.

Глава 4. Сериализация и десериализация XDTO

4.1. Разделение XML- и XDTO-сериализации: основная концепция

Сериализация — это процесс превращения объекта в XML-документ, а десериализация — обратный процесс. Представьте, что ваш объект XDTO — это красивая мебель, которую нужно упаковать для отправки. XML-документ — это такая упаковка. Когда данные нужно использовать снова, их распаковывают.

В XDTO есть два типа сериализации:

• XML-сериализация. Превращает объект XDTO в текстовый XML.
• XDTO-сериализация. Преобразует объект XDTO в объекты 1С и наоборот.

Эти процессы тесно связаны, но выполняют разные задачи. Например, XML-сериализация нужна для передачи данных по сети, а XDTO-сериализация — для работы с ними внутри программы.

4.2. Чтение XML и запись объектов XDTO

Чтобы записать объект XDTO в XML, используется метод ЗаписатьXML, а чтобы прочитать — ПрочитатьXML.

Пример записи:

Запись = Новый ЗаписьXML;
Запись.ОткрытьФайл("Сотрудник.xml");
ФабрикаXDTO.ЗаписатьXML(Запись, ОбъектСотрудник);

Запись.Закрыть();

Этот код создаёт XML-документ, который можно передать другому приложению или сохранить на диск.

Пример чтения:

Чтение = Новый ЧтениеXML;
Чтение.ОткрытьФайл("Сотрудник.xml");

ОбъектСотрудник = ФабрикаXDTO.ПрочитатьXML(Чтение);

Этот код считывает XML-документ и восстанавливает объект XDTO.

4.3. Сериализация и десериализация

&НаСервере

Процедура СериализироватьВXMLНаСервере();

    тСериализаторXDTO = Новый СериализаторXDTO(ФабрикаXDTO);
    тЗаписьXML = Новый ЗаписьXML;
    тЗаписьXML.ОткрытьФайл("C:\test.xml");
    тСериализаторXDTO.ЗаписатьXML(тЗаписьXML, Справочники.Тест.НайтиПоНаименованию("Тест 1").ПолучитьОбъект(), НазначениеТипаXML.Явное);

КонецПроцедуры

Обратный процесс - десериализация:

&НаСервере

Процедура ДесериализоватьИзXMLНаСервере()

    тСериализаторXDTO = Новый СериализаторXDTO(ФабрикаXDTO);
    тЧтениеXML = Новый ЧтениеXML;
    тЧтениеXML.ОткрытьФайл("C:\test.xml");
    тСсылка = тСериализаторXDTO.ПрочитатьXML(тЧтениеXML);

КонецПроцедуры

4.4. Работа с любыми типами (anyType): примеры и нюансы

Иногда в XML встречаются поля, которые могут содержать данные любого типа. Такие поля называются anyType. В XDTO для них создаются объекты, которые нужно дополнительно обрабатывать.

Пример обработки:

Значение = ОбъектXDTO.ПолучитьXDTO("ПроизвольноеПоле");
Если Значение.Тип() = Тип("Число") Тогда
    Сообщить("Это число: " + Значение);
ИначеЕсли Значение.Тип() = Тип("Строка") Тогда
    Сообщить("Это строка: " + Значение);
КонецЕсли;

Работа с anyType требует дополнительных проверок, чтобы определить тип данных и обработать их корректно.

4.5. Отладка сериализации: поиск и устранение проблем

При работе с сериализацией могут возникать ошибки, например:

• Неверная структура XML-документа.
• Несоответствие типов данных в объекте XDTO и XML.
• Отсутствие обязательных полей в объекте.

Полезные советы для отладки:

1. Проверяйте структуру XML. Используйте программы для валидации XML, например, XMLSpy.
2. Проверяйте типы данных. Убедитесь, что значения полей соответствуют типам, указанным в XML-схеме.
3. Тестируйте модели данных. Создавайте тестовые случаи для проверки корректности объектов XDTO.

Теперь вы знаете, как сериализовать и десериализовать объекты XDTO, превращать их в XML и обратно. Это важный этап работы с данными в 1С, особенно при интеграции с другими системами. В следующей главе мы рассмотрим расширенные возможности XDTO и примеры их применения.

Глава 5. Расширенные возможности и примеры использования XDTO

5.1. Настройка объектов XDTO для интеграции с внешними системами

При интеграции с внешними системами важно, чтобы объекты XDTO соответствовали требованиям этих систем. Это может включать:

• Указание пространств имен.
• Настройку сериализации для соблюдения специфических форматов XML.
• Удаление необязательных данных для уменьшения объёма документа.

5.2. Пример реализации веб-сервиса с использованием XDTO

Допустим, вам нужно создать веб-сервис для приёма и обработки заказов. Используя XDTO, это можно сделать следующим образом:

1. Создайте XML-схему для объекта "Заказ".
2. Импортируйте её в 1С и настройте пакет XDTO.
3. Реализуйте обработчик веб-сервиса, который принимает XML, десериализует его в объект XDTO, обрабатывает заказ и возвращает ответ.

Пример:

Процедура ОбработкаВебСервиса(Запрос, Ответ)
 
   Чтение = Новый ЧтениеXML;
    Чтение.УстановитьСтроку(Запрос.Тело);
    Заказ = ФабрикаXDTO.ПрочитатьXML(Чтение);

    // Здесь идет обработка заказа

    Ответ.УстановитьТело("Заказ обработан успешно");

КонецПроцедуры;

5.3. Частые ошибки при работе с XDTO и их предотвращение

Вот несколько типичных ошибок и способов их избежать:

1. Отсутствие обязательных полей. Всегда проверяйте, что объект XDTO заполнен корректно.
2. Несоответствие типов данных. Убедитесь, что данные, которые вы передаёте в объект, соответствуют его схеме.
3. Неопределённые пространства имен. Убедитесь, что пространство имен указано правильно, особенно при интеграции с внешними системами.

5.4. Советы по оптимизации и улучшению кода

Чтобы сделать код с использованием XDTO более удобным и поддерживаемым:

• Используйте логирование для отладки.
• Создавайте вспомогательные процедуры для часто выполняемых операций (например, запись XML в файл).
• Регулярно тестируйте изменения в схемах данных.

Поздравляем! Вы освоили основные возможности XDTO. Теперь вы можете уверенно использовать этот инструмент для интеграции данных, создания веб-сервисов и других задач. Удачи в разработке!