Платформы : 1С:Предприятие 8.3, 1С:Предприятие 8.2, 1С:Предприятие 8.1
Конфигурации : Все конфигурации

2012-11-25
34938

XDTO - это механизм, который необходим при создании и работы web-сервисов. С помощью пакетов XDTO осуществляется описание структуры требуемого файла XML, необходимого для изменения данных из XML и в XML.

XML - это способ позволяющий в обыкновенном текстовом файле описать сложную структуру данных. В нем описываются не только непосредственно данные, но и поля, где они хранятся.
Вот базовый пример XML файла:

XML for dummies

Имена (тэги), использованные в данном файле - root, list, name, el - могут быть абсолютно произвольными. Основные правила образования XML файла видны сразу по его структуре:
- Возможно вложение элементов;

Начало элемента <Имя>, окончание - то же самое имя, но с присоединением символа «/».

Находиться внутри элемента могут:
- Вложенные элементы;
- Текст.

У каждого элемента возможно присутствие свойств (атрибутов), у них указывается значение и имя. В XML запрещается использовать какие-либо символы, потому как несколько из них заняты непосредственно для XML, пример «<» и «>». Способ описания в XML очень удобен для использования при обмене с другими сторонними программами и используется он в 1С механизме обмена данными.

Пространство имен

Файл XML начинается с заголовка, описывающем версию XML, кодировку и т.п… Заголовок в XML не совсем обязателен и очень часто его просто не применяют. В заголовке также возможно определение - пространства имен.

XML файлы передаются через интернет и воспринимаются многими различными программами. Воспринимаются - это значит, что в их коде имеется зашита - если встретишь в файле XML определенное имя элемента, то необходимо воспринимать его именно так-то и делать именно вот это. Поэтому при использовании нами тэга IBM, то существует достаточно высокий шанс того, что другая программа подумает, что это IBM, известный ей, в то время как мы подразумевали под этим что-то свое.

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

Определить пространство имен (namespace) можно следующим образом — xmlns:Префикс (ИмяПространства) = “URL”, пример:
xmlns:store = "http://site.ru"

Зачем же необходим URL? Кто уже подумал и смотрит дальше - конечно пространство имен, нами придуманное, может быть также не уникально, т.е. кто-либо другой также может его использовать. Именно поэтому указывается особый уникальный идентификатор, который определяет заодно и исполнителя пространства имен.

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

DOM

Объектом называется конкретная структура данных, являющаяся самодостаточной и которая содержит в себе все свои данные.

В связи с тем, что в XML файле происходит описание структурированных данных, то есть данных в виде структуры, которая имеет свои свойства и прочее, соответственно на них смотреть можно как на объекты. В рассмотренном примере может использоваться объект LIST со свойствами и вложенным элементом.

DOM является способом рассмотрения XML файла не как текста в конкретном формате, а в качестве набора объектов с полями, свойствами и прочее.

К минусам данного способа работы, относится высокие требования к производительности ПК, т.к. DOM обрабатывает (формирует структуру в виде объектов) сразу весь XML файл, не зависимо от его размера, и файлы большого размера (более 4Гб) он просто не сможет "переварить".

Для разбора больших файлов, используется SAX, этот способ разбора файла основан на последовательном чтении файла, а не на построении вразу всей его структуры.

Описание XML файла

Если мы применяем файл конкретной структуры постоянно для осуществления обмена между 2- мя программами, то мы бы вероятно хотели следующее:

Чтобы использованы были конкретные названия;
- Чтобы использовались лишь те элементы, ожидаемые нами (которые «должны существовать для применения в обмене»);
- Чтобы в атрибутах указывались лишь те типы, ожидаемые нами (число, строка, и прочее).

Для описания XML структуры бывают следующие форматы файлов (хранящиеся также в простом текстовом файле):

Расширение DTD это Document Type Definition;
- Расширение XSD это XML Shema.

Эти форматы описывают каким должен быть документ. Процедуру проверки соответствия XML, который описывается в подобном файле стандарта, называют верификация.

XDTO

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

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

Фабрика XDTO включает в себя несколько пакетов. Начальные типы описываются в пакете с названиемwww.w3.org Типы данных в конфигурации описываются в пакетеhttp://v8.1c.ru/8.1/data/enterprise/current-config

Эти типы именуются в соответствии с названиями в конфигураторе с прибавлением англоязычного вида (CatalogRef, DocumentObject, CatalogObject, DocumentRef), к примеру:

CatalogObject.Контрагенты

Добавление XDTO пакета

Мы дошли до темы XSLT - способа преобразования файлов XML во что-либо другое, например в файлы HTML. Тема XML крайне большая и по ней написанно не одна книга.

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

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

Этот текстовый файл, Вы можете отредактировать в блокноте Windows, при этом убрав лишние объекты (ненужные Вам). Добавить готовую схему XSD в 1С возможно путем нажатия правой кнопкой мыши на ветку Общие - XDTO-пакеты и выбрав в меню пункт "Импорт XML-схемы".

Работой с XDTO в 1С называется преобразование значений из XML и в XML. Это производится при помощи объектов 1С языка Чтение XML/XMLЗапись .

При работе с XDTO надо указать пакет, с которым непосредственно и работаете. Им может быть как типовой пакет (см. в обсуждении выше, XDTO), так и пакет, добавленный в конфигурацию.

Идентификация пакета осуществляется по URL, который указан в пакете. Есть два способа работы, являющиеся основными - это:

Сериализация - автоматическое изменение значений из XML в 1С и наоборот;

Заполнение полей объекта, его создание и запись в XML (а также соответственно чтение из XML и в дальнейшем чтение его полей).

Представим пример сериализации значения:

Сериализатор = Новый XDTO Сериализатор (XDTO Фабрика);
XML Файл = Новый XML Запись();
XMLФайл.ОткрытьФайл(«ИмяФайла»);
Сериализатор.ЗаписатьXML(XMLФайл, 1С Значение);

Обратная функция - Сериализатор. XMLЧтение (), используется с объектов 1С языка ЧтениеXML.
Пример записи /чтения объекта:

Справочник XDTOОбъект = ФабрикаXDTO.Создать(XDTOФабрика. Тип("http://v8.1c.ru/8.1/data/enterprise/current-config", "CatalogObject.Контрагенты"));
ЗаполнитьЗначенияСвойств(СправочникXDTOОбъект, Справочник.Контрагенты.НайтиПоРеквизиту("Имя", "Иванов).Ссылка);

Потом можно произвести запись созданного объекта в XML абсолютно так же, как и сериализация. Во время чтения XML таким же способом, что рассматривался выше, может возвратиться не XDTO значение, а именно такой объект.

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

Формат XML пользуется большой популярностью при обмене различными текстовыми документами между информационными системами. Возможность создания уникальной структуры у документов позволяет ее использовать во многих областях – электронные библиотеки, WEB, импорт/экспорт, а также многих других. Без возможности удобной работы с этим форматом системы 1С не смогли бы получить такую популярность. Поскольку 1С активно использует WEB-технологии, каждый разработчик должен уметь читать XML и записывать в них информацию.

Представление файла XML и его чтение

Одним из ключевых преимуществ языка разметки XML является достаточно удобная и интуитивно понятная структура и синтаксис. При его создании авторы ставили цель создать язык разметки, который был бы удобен для чтения и человеком, и ЭВМ. На сегодняшний день XML получил широкое развитие в другие форматы, но остается популярным и широко используемым. Структура XML файла строится по следующей схеме:

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

Одним из популярных способов работы с XML размером до 100 МБ в 1С считается использование объектной модели документа (DOM). Его смысл заключается в поочередной обработке всех узлов документа, представленных в XML. На встроенном языке 1С этот алгоритм выглядит так:

1. Объявление механизмов, с помощью которых происходит чтение XML файла; Цикл для обхода узлов;
2. Считывания данных и атрибутов в узле;
3. Вывод информации. Если есть необходимость, на этом этапе может происходить запись в переменные или сразу в нужные таблицы;
4. Завершение работы механизма.

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

Для выгрузки информации нам также пригодится взаимодействие с файлами формата XML. Рассмотрим пример записи с помощью объекта платформы 1С ЗаписьXML и выгрузим данные по номенклатуре. Главными его преимуществами являются простота кода и скорость обработки данных. Серверный алгоритм записи файла XML можно представить в виде нескольких последовательных шагов:

1. Подключаемся к файлу xml;
2. Создаем головные элементы и в них записываем данные. Если вы хотите выгрузить в XML файл большой объем информации, то на этом этапе у вас будут использоваться циклы. Будьте аккуратны и не забывайте, что запрос данных нужно делать до цикла, а не в нем;
3. Закрываем файл.

Механизм XDTO в 1С

Разработчики компании 1С для обмена информацией через XML создали собственный механизм – XDTO (XML Data Transfer Objects). Начиная с версии 8.1, в платформе появляется возможность обмениваться данными с другими системами, не вникая в вопросы формирования файла XML. Большинство технических вопросов берет на себя 1С, а нам остается только указывать данные, необходимые, чтобы сформировать XML. Правда, для этого разработчику необходимо заранее проделать некоторые манипуляции.

Чтобы загрузить файл XML, используя XDTO, мы должны сообщить 1С структуру файла. Она передается через набор схем, которые можно создать в редакторе текста или воспользоваться специализированной программой. В результате должен получиться файл, описывающий общую структуру и типы данных, используемые в файле XML. Перед тем как считывать или записывать новый XML, разработчик должен загрузить его схему в конфигурацию в раздел «ПакетыXDTO».

В данном случае создадим руками простой пакет, чтобы 1С понимала структуру нашего файла для примера. Чтобы формирование файла закончилось успешно, нам нужно отразить в схеме, что у нас присутствует головной элемент и вложение с атрибутами. Созданную схему нужно экспортировать в файл формата xsd и передать вместе с xml, чтобы другой стороне не понадобилось разбираться со структурой и опять создавать пакет xdto.

Сохранить новый XML на жесткий диск поможет серверный алгоритм, похожий на предыдущий. Отличие состоит лишь в необходимости добавления данных по 1 товару в фабрику XDTO – специальный механизм платформы 8.3 1С. Если есть необходимость делать больше уровней вложенности – придется описывать каждый головной элемент.

Рассмотренные механизмы являются достаточно универсальными и при правильной настройке могут решить большинство задач. Однако во взаимодействии 1С и XML достаточно много нюансов. Изучать их намного эффективнее в реальных условиях, а не на тестовых задачах, в которых обработка XML файла решает достаточно узкие задачи.

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

Документа XML

Давайте посмотрим на этот XML - документ под названием "shiporder.xml" :

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="shiporder.xsd">
John Smith

Ola Nordmann

Документ XML выше состоит из корневого элемента, "shiporder" , который содержит обязательный атрибут под названием "orderid" . "shiporder" элемент содержит три различных дочерних элемента: "orderperson" , "shipto" и "item" . "item" элемент появляется дважды, и он содержит "title" , необязательный "note" элемент, "quantity" , и "price" элемент.

Линия выше: Xmlns: XSI = "http://www.w3.org/2001/XMLSchema-instance" говорит XML-анализатору, что этот документ должен быть проверен на схеме. Линия: XSI: noNamespaceSchemaLocation = "shiporder.xsd" указывает, где находится схемы что и (here it is in the same folder as "shiporder.xml") .

Создание XML-схемы

Теперь мы хотим создать схему для документа XML выше.

Мы начнем с открытия нового файла, который мы будем называть "shiporder.xsd" . Для того, чтобы создать схему мы могли бы просто следовать структуре в документе XML и определите каждый элемент, как мы находим его. Мы начнем со стандартной декларации XML с последующим хз: элемент схемы, который определяет схему:

...

В схеме выше мы используем стандартные пространства имен (xs) , и URI , связанный с этим пространством имен является определение языка схемы, который имеет стандартное значение http://www.w3.org/2001/XMLSchema.

Далее, мы должны определить "shiporder" элемент. Этот элемент имеет атрибут и содержит другие элементы, поэтому мы рассматриваем его как сложный тип. Дочерние элементы "shiporder" элемент окружен хз: элемент последовательности, которая определяет упорядоченную последовательность субэлементов:

...

Затем мы должны определить "orderperson" элемент в качестве простого типа (так как она не содержит каких - либо атрибутов или других элементов). В типа (xs:string) с префиксом префикс пространства имен, связанного с XML - схемы, которая указывает заранее определенный тип данных схемы:

С помощью схем, которые мы можем определить количество возможных появлений для элемента с MaxOccurs и атрибутами MinOccurs. MaxOccurs определяет максимальное число вхождений для элемента и MinOccurs определяет минимальное число вхождений для элемента. Значение по умолчанию для обоих MaxOccurs и MinOccurs 1!

Теперь мы можем определить "item" элемент. Этот элемент может появляться несколько раз внутри "shiporder" элемента. Это определяется установкой maxOccurs атрибут "item" элемента "unbounded" , что означает, что там может быть много вхождений "item" элемент, как автор хочет. Обратите внимание на то, что "note" элемент не является обязательным. Мы определили это, установив minOccurs атрибут к нулю:

Теперь мы можем объявить атрибут "shiporder" элемента. Поскольку это обязательный атрибут мы указываем использование = "требуется".

Note: Заявления атрибутов всегда должны прийти в последний раз:

Вот полный список файла схемы под названием "shiporder.xsd" :

Разделите схемы

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

Следующий метод дизайн основан на определении всех элементов и атрибутов, а затем ссылаясь на них, используя ref атрибут.

Вот новый дизайн файла схемы ("shiporder.xsd") :

Использование именованных типов

Способ третий дизайн определяет классы или типы, что позволяет повторно использовать определения элементов. Это делается путем именования элементов simpleTypes и complexTypes, а затем указать на них через type атрибута элемента.

Вот уже третий дизайн файла схемы ("shiporder.xsd") :

Элемент ограничение указывает на то, что тип данных был получен из пространства имен типа данных XML-схемы W3C. Таким образом, следующий фрагмент означает, что значение элемента или атрибута должно быть значение строки:

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

Это указывает на то, что значение элемента или атрибута должно быть строкой, оно должно быть ровно шесть символов в строке, и эти символы должны быть числом от 0 до 9.

XDTO – механизм 1С, который нужен при создании и использовании веб-сервисов в 1С.

Пакеты XDTO 1С позволяют описать структуру требуемого файла XML для преобразования данных в XML и из XML.

Кому интересно – разберем вопрос подробнее.

Файлы XML передаются через интернет, воспринимаются многими программами.

Воспринимаются – значит в их коде зашито – если встретишь в XML файле определенное имя элемента – воспринимай его вот так-то и делай вот это.

Поэтому если мы будем использовать имя элемента Apple, то достаточно большой шанс, что какая-либо другая программа может «подумать», что это известный ей Apple, но мы то имели ввиду что-то свое.

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

Определяется пространство имен (по английски namespace) вот так — xmlns:ИмяПространства = “URL”, например:
xmlns:store = "http://store.ru"

Зачем нужен URL?

Поэтому указывается некий уникальный идентификатор, определяющий заодно и автора пространства имен.

Естественно подразумевается, что указавший пространство имен исключительно честный человек и указал свой сайт и не использует с одним сайтом несколько разных пространств имен.

Кстати, обычно указывают не только URL сайта, но URL конкретной папки на сайте, чтобы если что, можно было создать другое пространство имен в другой папочке на сайте для его использования в другой ситуации.

Объект – это определенная структура данных, самодостаточная, содержащая все свои данные.

Так как в XML описаны структурированные данные, то есть в виде структуры, имеющие свои свойства и т.п., то на них можно смотреть как на объекты.

В приведенном примере это может быть объект LIST со свойством и вложенным элементом.

DOM – это способ рассмотрения файла XML не как текст в определенном формате, а как набор объектов со свойствами, полями и так далее.

Описание файла XML

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

• Чтобы были использованы определенные названия
• Чтобы были те элементы, которые мы ожидаем (которые «должны быть для использования в нашем обмене»)
• Чтобы в атрибутах были указаны те типы, которые мы ожидаем (строка, число и т.п.).

Для описания структуры XML существуют следующие стандарты форматов файлов (которые также хранятся в обычном текстовом файле):

• Расширение DTD – Document Type Definition
• Расширение XSD – XML Shema.

Оба формата описывают каков должен быть документ. Процедура проверки соответствия XML описанному в таком файле стандарту называют верификация.

XDTO 1С – это , который позволяет в конфигурацию добавить описание XML файла. Вернее описывается не файл, а конкретные структуры XML.

Чтобы указать типы, возможные к использованию – используется список, библиотека типов – которую называют фабрика XDTO 1С.

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

Фабрика XDTO 1С сама состоит из нескольких пакетов. Базовые типы описаны в пакете с именем www.w3.org

Типы данных текущей конфигурации описаны в пакете http://v8.1c.ru/8.1/data/enterprise/current-config

Сами типы называются в соответствии с именем в конфигураторе с добавлением англоязычного вида (CatalogRef, CatalogObject, DocumentRef, DocumentObject), например:

CatalogObject.Номенклатура

Добавление пакета XDTO 1С

Безусловно все это круто звучит. И мы не дошли еще до темы XSLT – способа преобразовывать файлы XML во что-то другое, например в HTML. Тема XML исключительно большая и ее сложно включить даже в отдельную книгу.

Наша задача – понять, что XDTO 1С позволяет описать какие элементы должны быть у пакета XML, который нужно сформировать или считать.

Пакеты XDTO 1С находятся в конфигурации в ветке Общие/Пакеты XDTO 1С.

Добавить пакет XDTO в 1С можно вручную (круто!), но лучше достать соответствующий XSD файл с готовым описанием схемы.

Описание XSD схемы объектов любой конфигурации можно получить нажатием на ветку Общие/Пакеты XDTO 1С и выбрав пункт меню Экспорт XML схемы конфигурации.

Файл текстовый, Вы можете отредактировать его в блокноте Windows, убрав лишние, ненужные Вам объекты.

Добавить готовую XSD схему в 1С можно нажав правой кнопкой на ветку Общие/XDTO 1С пакеты и выбрав пункт меню Импорт XML схемы.

Использование механизма XDTO 1С

Работа с XDTO 1С – это преобразование значений в XML и из XML.

Работа ведется с помощью объектов языка 1С ЧтениеXML/ЗаписьXML .

При работе с механизмом XDTO 1С Вы должны указать пакет, с которым работаете. Это может быть типовой пакет (обсуждали выше, см. XDTO) или добавленный в конфигурацию пакет. Идентификация пакета производится по URL, указанному в пакете.

Два основных простых способа работы – это:

• Сериализация – автоматическое преобразование значений из 1С в XML и наоборот
• Создание объекта, заполнение его полей, запись в XML (и соответственно чтение из XML и потом чтение его полей).

Пример сериализации значения:
Сериализатор = Новый СериализаторXDTO(ФабрикаXDTO);
ФайлXML = Новый ЗаписьXML();
ФайлXML.ОткрытьФайл(«ИмяФайла»);
Сериализатор.ЗаписатьXML(ФайлXML, Значение1С);

Пример чтения/записи объекта:

СправочникОбъектXDTO = ФабрикаXDTO.Создать(ФабрикаXDTO.Тип("http://v8.1c.ru/8.1/data/enterprise/current-config", "CatalogObject.Склады"));
ЗаполнитьЗначенияСвойств(СправочникОбъектXDTO, СправочникСсылка1С);