Использование xsd. Файл в формате XSD – что это и чем открыть XSD-схему. Как конвертировать файл XSD
В этой главе будет показано, как написать 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.
XSD файлы часто используются вкупе с XML документами. В них представлены описания XML файла и правила, которым он подчиняется. У пользователей часто встает вопрос, чем открыть XSD. Для просмотра подойдут базовые утилиты, предустановленные на ПК, а вот для редактирования понадобится дополнительное ПО.
Общее описание формата xsd
Расширение «.xsd» – аббревиатура от XML Schema Definition. Главная задача файлов с таким расширением – описать XML. В них могут содержаться описания структуры, отдельных элементов, атрибутов. Информацию содержит текст, изложенный языком описания XML Schema. На этом языке создают программное обеспечение для работы с XML. В «.xsd» могут быть интегрированы элементы других словарей, не только XML Schema.
История возникновения
Впервые формат был введен в эксплуатацию в 2001 году. Его порекомендовал Консорциум Всемирной паутины. Эта организация внедряет технологические стандарты интернета. Цель Консорциума – достичь совместимости файлов и оборудования производителей из разных стран.
Стартовая разработка языка XML Schema 1.0, применяемого в расширении «.xsd», использовалась на протяжении 11 лет. 5 апреля 2012 года Консорциум одобрил введение новой – 1.1.
Как и чем открыть файл xsd расширения
Можно выбрать из трех вариантов, чем открыть файл XSD. Просматривать содержимое документа можно даже без ПК, используя опции браузера.
Онлайн
Для просмотра онлайн используется браузер. Подойдет как ПК, так и мобильный браузер.
XSD схема – чем открыть онлайн :
- другие браузеры.
Чтобы просмотреть содержимое, в строку поиска вбивают путь к файлу: «file:///D:/document.xsd». После «file:///» указывается путь на выбранном устройстве, а также название.
Главный недостаток онлайн-просмотра формата – невозможность вносить изменения в структуру.
На компьютере
При использовании установленных на ПК программ опций при работе с больше. Можно не только узнать содержимое, но и отредактировать текст.
Если постоянно работать с форматом не предстоит, для управления такими документами используют текстовые редакторы. Подойдут следующие программы:
- WordPad;
Принципиальных отличий в ПО нет. Microsoft Word удобнее с точки зрения редактирования, а WordPad тяжелее в освоении. Однако функционал программ при работе с данным форматом не меняется.
Самое простое ПО для просмотра формата – Блокнот. Для просмотра и редактирования в текстовом редакторе файл открывают командой «Открыть с помощью...», затем выбирают из списка программ нужный редактор. Также можно открыть файл через саму программу, выбрав функцию «Открыть» и указав путь к элементу.
Если с XML Schema Definition работают профессионально, то для просмотра и редактирования применяют более серьезные программы. Устанавливаются XML-редакторы, к которым относятся:
- и другие.
Профессионалы предпочитают вторую программу. Она подходит для работы на Windows, Linux, Microsoft и позволяет не только видоизменять, но и создавать файлы рассматриваемого формата. Для редактирования используется многофункциональная таблица.
Какие еще могут быть проблемы с xsd файлом
Даже если известно, что такое формат xsd, чем открыть файл такого типа, иногда возникают дополнительные проблемы. Главная сложность заключается в том, что бывает два варианта XML Schema Definition файлов. Первый – текстовые, в которых содержатся команды и описания. Их открывают при помощи приведенных выше способов. Но разработан и второй, менее распространенный тип – схемы для вышивки крестиком. Это изображения, а не текст.
Внешне файлы двух типов ничем не отличаются, у них одинаковое расширение. Если при попытке открыть документ онлайн или при помощи текстового редактора выдается ошибка, значит, перед пользователем изображение. Его открывают только одним способом – при помощи программы , специально заточенной под схемы для вышивки.
Утилиту устанавливают на ПК. Программу для открытия xsd можно скачать бесплатно и с русским переводом. В Pattern Maker For Cross Stitch доступен не только просмотр xsd схемы, но и редактирование, и создание собственных файлов.
Разобраться с форматом не сложно. Даже новичок сможет с первого раза открыть файл при помощи предустановленного на ПК текстового редактора или «Блокнота».
Все будет сухо, без лирики и т.п.
Итак. Мне принесли задание. Подружить 1С с внешним сервисом по приему отчетности в виде xml файла.
Сторонний сервис имеет свой API по приему файлов, на выходе выдает некий код «батч», по которому я смогу вызвать еще одну функцию и получить по этому батчу, всю развернутую информацию по ошибкам.
Файл схема xsd небольшая, но типов данных много, на основе этой схемы полностью сформированный XML файл занимает что-то около 200Мб.
В итоге я имел на руках некий файл с расширением «xsd».
На тот момент я даже понятия не имел, что это и с чем и как его едят.
Очень помог Инфостарт (не без этого, конечно, - огромное спасибо).
Для начала ниже материал, которым я пользовался, пока не завершил этот мини проект, и поэтому вот ссылки вам в помощь, которые могут понадобиться в дальнейшем, я думаю, это «маст-хэйв» для тех, кто хочет обучиться правилам XDTO:
Что в итоге.
Просьба смотреть «не в воду», а в суть.
Тут главные строки это:
Для получения каких-либо реквизитов свойства в схеме xsd пользуюсь такой конструкцией кода,
Но скажу, что видел и другие способы, тут, как говорится, дело ваше.
Результат рисунков с 7 по 12
Выглядит вот так в готовом файле:
И вот что я заметил (ну местные гуру, может, и знают давным-давно).
Это как бы и правила, и пометка.
Рассмотрим свойство «ContractCode»
Вот его описание:
Если это свойство имеет форму как «Элемент», то тогда код выглядит таким:
Т.е. я срази пишу значение в параметр, просто «= равно» и пошел.
Если свойство имеет форму как «Элемент», но он записан через знак «+»
Как вот тут
То его код выглядит немного иначе
Т.е. нужно сначала создать через фабрику этот тип, получить его подчиненные подтипы и уже им присваивать значения из ваших данных.
И в итоге получается вот что.
Если в схеме это свойство имеет форму «элемент»
То в готовом файле запишется такая запись:
Т.е. все будет записано внутри т.н. «тегов».
Т.е. у свойства «FundingType» есть подчиненный элемент «id», где его форма равна «Атрибут»
В этом случае код при написании НЕ изменится:
Замечу, что этот код похож на рис.16
Воот, а результат будет немножко другой:
Т.е. значение запишется сразу в сам «тег».
Есть такое свойство, как «Gender»
Обмениваясь данными между приложениями, пользователи обычно не задумываются, как именно осуществляется этот обмен и с какими трудностями он может быть связан. Сложность в том, что программы могут быть созданы на базе совершенно разных технологий и, следовательно, «говорить» на разных языках. Чтобы обменивающиеся информацией приложения могли понимать друг друга, данные должны быть переданы на некоем общем понятном им языке, каким является расширяемый язык разметки .
Для чего нужен формат XSD
Определенному формату должна соответствовать также и структура самого XML, для чего разработчиками был выработан общий набор правил. Набор этот получил название языка описания структуры XML-документа или попросту XSD схема. В сущности, это файл метаданных, в котором хранится информация о том, как должен быть структурирован XML-документ. Используются схемы XSD для валидации (проверки) файлов XML.
Расширение XSD также соответствует схеме вышивания крестиком, но это уже другой формат XSD, отличный от того, который используется для описания XML-документов. Файлы этого типа содержат псевдоизображение, цветовую легенду и описание вышивки. Открыть их можно только специальными приложениями, тогда как для просмотра содержимого предназначенных для валидации XML-документов файлов XSD подойдут простые текстовые редакторы.
Чем открыть файл со схемой XSD
Ну что же, надеемся, что это такое XSD-схема вам понятно, перейдем теперь к программному обеспечению, используемому для чтения файлов этого типа. Открыть XSD-файл валидации XML можно любым текстовым редактором, даже Блокнотом, но всё же удобнее использовать для этих целей соответствующие редакторы. Итак, представим, что у нас есть некая XSD схема. Чем ее открыть лучше всего?
Microsoft XML Notepad
Легкий и удобный текстовый редактор, заточенный под работу с XML-файлами. Отображает содержимое XML и XSD-файла в двух представлениях – в виде древовидной структуры и в виде последовательности строк. Для редактирования используется первый режим. XML Notepad поддерживает подсветку синтаксиса, поиск и замену, работу с регулярными выражениями и функцию XInclude. Основное преимущество этой программы заключается в ее простоте.
EditiX XML Editor
Если вы ищете, чем открыть файл XSD, и при этом вам нужен достаточно продвинутый инструмент, обратите внимание на программу EditiX XML Editor. Приложение включает в себя редактор и отладчик, может использоваться как полноценная среда разработки. Инструмент поддерживает работу с XML, XSD, XSLT, DTD, реляционными базами данных и т.п., проверку XML-документов на предмет ошибок, в программе имеется встроенный редактор XQuery, Grid и CSS. Отдельно стоит отметить наличие генератора схем, позволяющего просматривать содержимое XML-документов в виде таблицы связанных блоков.
Notepad++
Открыть файл XSD способен Notepad++ – текстовый редактор, который подойдет всем, и начинающим пользователям, и опытным программистам. Notepad++ поддерживает все базовые функции для работы с текстовыми данными, подсветку синтаксиса, расширенный поиск, регулярные выражения, автозавершение кода, запись макросов и многое другое. Редактор имеет небольшой вес и, в отличие от двух предыдущих программ, поддерживает русский язык интерфейса.
Pattern Maker
Теперь выясним, как открыть файл XSD-вышивки крестом. Даже самые продвинутые кодовые редакторы здесь бессильны, а потому для просмотра схем вышивок вам понадобится специальная программа Pattern Maker. Основное предназначение этого приложения – создание и редактирование схем вышивки, но использовать ее можно и в качестве их просмотрщика. Функционал Pattern Maker частично схож с функционалом растровых графических редакторов, но большая его часть представлена узкоспециализированными инструментами.
Ну хорошо, теперь мы знаем, что такое формат XSD и чем его открыть. Понимание назначения XSD-файлов может вам пригодиться при анализе одной довольно таки распространенной ошибки, с которой время от времени приходится сталкиваться пользователям при работе с XML-документами. Наряду с кодом в ее описании указывается, что файл или документ не соответствует XSD схеме. Фактически это означает, что в проверяемом XML-документе имеются ошибки или несоответствия шаблону, заданному в XSD-файле.
При этом неважно, какой программой был сформирован XML-файл и для чего. Это может быть отчет для налоговой службы или иной бухгалтерский документ, а также любой XML-файл с набором неких импортируемых данных. А вот причины несоответствия бывают разные, начиная от использования устаревшей версии программного обеспечения, в котором создается XML-файл, и заканчивая пропуском важных полей, к примеру, в той же бухгалтерской отчетности.
Хотелось бы в одном месте рассказать о вполне типичной задаче при работе с 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