XSD-схема. Создание XSD-схемы
У вас есть проблема с открытием.XSD-файлов? Мы собираем информацию о файловых форматах и можем рассказать для чего нужны файлы XSD. Дополнительно мы рекомендуем программы, которые больше всего подходят для открытия или конвертирования таких файлов.
Для чего нужен файловый формат.XSD?
Файловое расширение .xsd относится к типу файлов "Определение схемы XML" (XML Schema Definition, XSD). XML Schema — это международный стандарт со статусом рекомендации консорциума W3C, а тип файлов XSD служит типовым обозначением файлов схем XML. XSD является подмножеством XML, и его основная концепция схожа с более ранним механизмом DTD (Document Type Definition - Определение типа документа) в том, что XSD — это метаязык, используемый для построения и применения правил произвольного XML-языка.
Файл .xsd представляет собой текстовый листинг исходного кода XML. В нем дается определение схемы XML — структурированной прототипной модели обычных XML-документов. Файлы схем XML (.xsd ) можно использовать для создания собственных языков на базе XML и проверки (валидации) XML-документов на соответствие правилам, введенным той или иной схемой XSD.
Схемы XML (.xsd ) используются целым рядом современного ПО с поддержкой XML, включая веб-браузеры, операционные системы, офисные пакеты, интегрированные среды разработки и др. Кроме того, при наличии практических знаний синтаксиса XML Schema любой файл .xsd можно вручную открыть и отредактировать в текстовом редакторе.
Без всякого отношения к вышеописанному, расширение .xsd также ассоциируется с типом и форматом файлов "Файл данных схемы вышивки крестом Pattern Maker" (XSD). Pattern Maker является платным приложением (Майкрософт Windows) для создания подробных схем вышивки "крестиком" на основе цифровых растровых изображений. Файл .xsd — это представление схемы вышивки, созданный при помощи Pattern Maker. Такие файлы XSD можно открывать, просматривать и печатать при помощи как Pattern Maker, так и утилиты Pattern Viewer, в то время как редактирование возможно только в среде Pattern Maker.
Программы для открытия или конвертации XSD файлов
Вы можете открыть файлы XSD с помощью следующих программ: Наиболее часто встречаемой проблемой, из-за которой пользователи не могут открыть этот файл, является неверно назначенная программа. Чтобы исправить это в ОС Windows вам необходимо нажать правой кнопкой на файле, в контекстном меню навести мышь на пункт "Открыть с помощью", а выпадающем меню выбрать пункт "Выбрать программу...". В результате вы увидите список установленных программ на вашем компьютере, и сможете выбрать подходящую. Рекомендуем также поставить галочку напротив пункта "Использовать это приложение для всех файлов XSD".
Другая проблема, с которой наши пользователи также встречаются довольно часто - файл XSD поврежден. Такая ситуация может возникнуть в массе случаев. Например: файл был скачан не польностью в результате ошибки сервера, файл был поврежден изначально и пр. Для устранения данной проблемы воспользуйтесь одной из рекомендаций:
- Попробуйте найти нужный файл в другом источнике в сети интернет. Возможно вам повезет найти более подходящую версию. Пример поиска в Google: "Файл filetype:XSD" . Просто замените слово "файл" на нужное вам название;
- Попросите прислать вам исходный файл еще раз, возможно он был поврежден при передаче;
Хотелось бы в одном месте рассказать о вполне типичной задаче при работе с XML , а именно, о создании XML на основе существующего. Данная операция будет состоять из нескольких этапов, при выполнении которых, будут решены дополнительные задачи, такие как:
- Создание XML на основе XSD , и наоборот.
- Сериализация и десериализация объектов.
- Создание класса, для будущей сериализации из XML или XSD .
XSD - это язык, для описания XML . И если вы посмотрите содержимое файла содержащего это описание, то возникнет вопрос, зачем же описывать казалось бы очевидные теги вашего XML ? Но представьте, что вы интегрируетесь с какой то внешней системой, и для обмена данных хотите использовать формат XML . Так вот, XSD позволяет описать для каждого элемента его именя, возможные атрибуты, обязательность полей или атрибутов, дать понять, что содержимое какого то тега может содержать лишь один внутренний элемент () и не более, либо узел может иметь последовательность элементов (< a> ... ). Когда внешняя система является вашей, тогда проблем может не возникнуть, но когда это сторонняя организация, тогда данное описание через XSD , будет инструментом урегулирования споров с форматом, а так же, используя утилиты, можно проверить соответствие любой XML изначальному формату.Итак, что же мы будем делать, для того, что бы научиться штамповать XML на основе вашего эталона? Опишу всё по порядку.
Имеется:
Какой то XML (xmlfile.xml)
, сохраненный в текстовом формате в файл. Ниже приведу текст:
<
catalog
>
<
book
id
=
"
bk101
"
>
<
author
>
Gambardella, Matthew
<
title
>
XML Developer"s Guide
<
genre
>
Computer
<
price
>
44.95
<
publish_date
>
2000-10-01
<
description
>
An in-depth look at creating applications
with XML.
<
book
id
=
"
bk102
"
>
<
author
>
Ralls, Kim
<
title
>
Midnight Rain
<
genre
>
Fantasy
<
price
>
5.95
<
publish_date
>
2000-12-16
<
description
>
A former architect battles corporate zombies,
an evil sorceress, and her own childhood to become queen
of the world.
Действия для создание нового:
- Сначала используя утилиту XSD.exe , либо воспользовавшись онлайн сервисами (искать "xml to xsd" один из них www.freeformatter.com/xsd-generator.html), мы будем создавать из имеющейся XML ее примитивное XSD описание. На выходе мы будем иметь полностью, автоматическим образом, созданный output.xsd файл, который уже подходит к использованию но может быть не полным.
- Далее, на основе output.xsd , будут созданы классы на языке C# xmlclass.cs. После чего, мы добавляем его в наш проект. Создавать класс можно используя XSD.exe, либо xsd2code утилитой, или же любым онлайн сервисом.
- Теперь мы готовы использовать классы файла xmlclass.cs . Поэтому создадим и наполним данными экземпляры xmlclass , а потом, используя процесс сериализации, будем преобразовывать объекты в XML строку, и после чего сохраним ее в новый файл. Тем самым получим XML на основе имеющегося.
Шаг 1. Создание XSD из XML.
Итак, приведу способы, которыми пользуюсь сам:- Утилита xsd.exe - создатель Microsoft .
- Утилита xsd2code.exe - стороннее приложение, которое умеет все тоже самое, что и xsd.exe , но доступно для скачивания напрямую (на данный момент стала платной с Trial периодом).
- Использование любых онлайн сервисов.
Ссылка для скачивания и установки одного из SDK
:
Windows SDK for Windows 7 and .NET Framework 4 .
Воспользуемся поиском, и найдем файл xsd.exe , после чего (что бы упростить себе работу), скопируем его в созданную в корне диска папку C:\xmltoxsd . Далее в эту же папку мы копируем наш xmlfile.xml и все готово к началу.
Отрываем "Командную строку" (Пуск -> "Выполнить" -> "cmd"), переходим в наш каталог и вызываем с параметрами по умолчанию xsd.exe
, передавая наш xmlfile.xml параметром:
И видим, что рядом появился файл xmlfile.xsd с содержимым.
Вот и все! Этих действий достаточно, для создания примитивного XSD файла, с которым можно работать. Но стоит понимать, что сам xsd.exe , как и любая другая утилита, ничего не знает про типы ваших полей (поэтому почти всегда тип полей будет string ), а так же о всех вариациях атрибутов и параметров. То есть, если у какого-то тега нет атрибута в вашей XML , тогда его и не будет в описании. Поэтому XML должен быть наиболее полным и в случае, если элемент может содержать несколько дочерних полей, лучше добавить как минимум два, что бы xsd.exe понял, что это коллекция.
Синтаксис XSD не очень сложный, поэтому, если пишется достаточно серьезное описание, возможно придется поработать и напильником.
Шаг 2. Создание Class из XSD.
Для создания класса на языке C#, нам понадобится вновь использоваться xsd.exe но уже с другим параметром /classes , передав путь к нашему xmlfile.xsd .
После выполнения появится файл xmlfile.cs, содержимое которого приведено ниже в сжатом виде:
Как видите, для внутреннего элемента catalog был создан класс catalogBook , у которого поля соответствуют полям в XML , а поле Id помечено как атрибут. Xsd.exe корректно понял, что внутри catalog хранится коллекция книг, поэтому появилось свойство Items , для наполнения дочерней коллекции.
Замечание: xsd.exe не умеет добавлять комментарии к получившимся классам и полям. В описании XSD существует элемент под названием < xs:annotation > , который чаще всего содержит < xs:documentation >, внутри которого размещено описание поля. По идее, оно должно быть размещено в /// описании, но на текущий момент xsd.exe отказывается добавлять текст в описание, поэтому приходится прибегать к альтернативам, таким как xsd2code или онлайн сервисам.
Шаг 3. Сериализация объектов в XML.
Получившиеся классы у нас лежат в файле xmlfile.cs . Далее его содержимое или сам файл добавляем в проект Visual Studio , после чего можно с ним работать. Я создам демонстративный объекты книг, после чего сохраню в файл в формате XML .Private
void
Example()
{
// Создание первой книги
var
book1 = new
catalogBook
()
{
author = "King"
,
description = "Very interesting book"
,
genre = "Fantasy"
,
price = 22.ToString(),
id = "42011"
,
title = "It"
};
// Создание второй книги
var
book2 = new
catalogBook
()
{
author = "O"Brien, Tim"
,
description = "Microsoft"s .NET initiative is explored in detail in this deep programmer"s reference."
,
genre = "Computer"
,
price = 36.ToString(),
id = "30012"
,
title = "Microsoft .NET: The Programming Bible"
};
// Создание корневого элемента каталога, содержащего две книги выше
var
catalog = new
catalog
()
{
Items = new
{ book1, book2 }
};
// Содержит XML объекта catalog
var
xmlCatalog = Serialize(catalog);
// Записываем строку в файл
//
TODO Сделано для демонстрации. Желательно вызывая метод Serialize передавать Stream к файлу
File
.WriteAllText("Output.xml"
, xmlCatalog);
}
private
string
Serialize
В этой главе будет показано, как написать XML-схемы. Вы также узнаете, что схема может быть записана по-разному.
Документа XML
Давайте посмотрим на этот XML - документ под названием "shiporder.xml" :
xsi:noNamespaceSchemaLocation="shiporder.xsd">
Langgt 23
Документ 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.
Очень часто при автоматизации бизнес процессов требуется формировать электронные документы на основе структурированных данных. Источником структурированных данных обычно являются справочники системы DIRECTUM. Потребность формирования электронных документов возникает по следующим причинам:
- Электронный документ - удобное представление для согласования информации. Возможность отображать данные из нескольких источников данных;
- Возможность установки ЭЦП - дополнительная защита результатов согласования;
Обычно для формирования документов пользуются разработкой интегрированных отчетов, которые после формирования можно сохранять как электронные документы в архив. Недостатки такого подхода, на мой взгляд, следующие:
- Высокая трудоемкость разработки, которая обычно связана с необходимостью программирования визуальной части отчета. Это относится к rtf и Excel/html отчетам в системе DIRECTUM.
- Шаблон отчета находится в разработке, что не позволяет пользователям системы изменять настройку представления. Например, заказчики часто хотят добавлять в отчеты, генерируемые системой, свой логотип.
Предлагаю использовать альтернативный вариант формирования электронных документов на основе Excel шаблона, который решает описанные выше недостатки. Механизм основан на возможности Excel использовать элементы присоединенной XSD схемы данных для разметки шаблона. Возможность доступна начиная с версии Excel 2003.
Приведу пример разметки шаблона документа «Выписка по счету» в Excel 2007. Путь до опции подключения XSD схемы данных: Вкладка разработчик(на риббоне)\Источник\Карты XML…\Добавить. Откроется диалоговое окно для выбора файла с описанием схемы данных. После подключения схемы в разделе «Источник XML» появится элементы подключенной XSD схемы, которые можно перенести в любую ячейку шаблона:
XSD схема – это обычный XML файл, в котором описаны элементы данных. XSD схема для приведенного примера выглядит следующим образом:
После того, как шаблон настроен и выполнена разметка полей данных его можно сохранить в системе и в установки вынести параметр, к которому можно будет привязаться в разработке ISBL. Для того, чтобы программно создать электронный документ на основе настроенного шаблона, нужно сделать следующее:
1. Подготовить XML файл с данными, соответствующий подключенной XSD схеме шаблона. XML данные для описанной в примере XSD схемы будут выглядеть следующим образом:
Формирование XML документа на ISBL нужно выполнить с помощью библиотеки msxml.dll:
… REPORT_NAME = “ВыпискаПоСчету_карта” XMLDocument = CreateObject("MSXML.DOMDocument") ProcInstruction = XMLDocument.CreateProcessingInstruction("xml"; "version="1.0" encoding="windows-1251" standalone="yes"") XMLDocument.appendChild(ProcInstruction) RootElement = XMLDocument.CreateElement(REPORT_NAME) XMLDocument.appendChild(RootElement) …
2. Получить шаблон документа и экспортировать его на диск.
… TemplateID = Конст(‘xxx’) Template = Edocuments.GetObjectByID(TemplateID) Template.Export(VersionNumber; Path; FALSE) …
3. Открыть экспортированный шаблон в Excel и передать в него подготовленные данные:
… Excel = CreateObject("Excel.Application") Book = Excel.WorkBooks.Open(Path) Sheet = Book.WorkSheets(1) // Загрузка данных в Excel XmlMap = Book.XmlMaps(REPORT_NAME) XmlMap.ImportXML(XMLDocument.xml) Book.Save Book.Close Excel.Quit …
4. При необходимости открыть документ для просмотра либо сразу сохранить документ в хранилище системы DIRECTUM.
Пример сформированного документа «Выписка по счету»:
Кроме экспорта данных в шаблон Excel можно выполнить и обратное действие – импортировать данные из полей разметки шаблона. Т.е. в этом сценарии работы шаблон Excel будет выступать в качестве электронной формы для ввода данных, которые можно будет импортировать в систему DIRECTUM.