Валидация xml с помощью xsd, jaxb и spring framework

Содержание:

Открываем файл при помощи «EditX Lite Version»
Правильно построенные и действительные документы XML
Verify the output
XSD — Simple Types
XSD — Complex Types
- Define a Complex Type and then create an element using type attribute.
- Define a Complex Type directly by naming.
Разделите схемы
Syntax
Поиск информации в XML файлах (XPath)¶
Using Named Types
Как открыть XML-файл
Что такое XSD
Divide the Schema
Как открыть xsd формат
Сущности¶
Создание XML-схемы

Открываем файл при помощи «EditX Lite Version»

Еще одним простым способом для прочтения файлов, имеющих столь распространенное расширение, является использование программы «EditX Lite Version». Данное приложение также является бесплатным и общедоступным, что сделало его одним из лучших в своем сегменте. Кроме того, быстрота функционирования программы является впечатляющей. Чтобы при помощи данной программы открыть необходимый документ, нужно:

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

Примечание! XML является одним из самых важных языков разметки, и на данное время без него трудно себе представить интернет. Благодаря ему происходит обмен данными среди всех возможных видов приложений. Данный язык гармонично дополняет HTML и служит лишь для того, чтобы «транспортировать» некие данные.

Правильно построенные и действительные документы XML

Валидация форм на стороне клиента

Стандартом определены два уровня правильности документа XML:

Правильно построенный (Well-formed). Правильно построенный документ соответствует всем общим правилам синтаксиса XML, применимым к любому XML-документу. И если, например, начальный тег не имеет соответствующего ему конечного тега, то это неправильно построенный документ XML. Документ, который неправильно построен, не может считаться документом XML; XML-процессор (парсер) не должен обрабатывать его обычным образом и обязан классифицировать ситуацию как фатальная ошибка.

Действительный (Valid). Действительный документ дополнительно соответствует некоторым семантическим правилам. Это более строгая дополнительная проверка корректности документа на соответствие заранее определённым, но уже внешним правилам, в целях минимизации количества ошибок, например, структуры и состава данного, конкретного документа или семейства документов. Эти правила могут быть разработаны как самим пользователем, так и сторонними разработчиками, например, разработчиками словарей или стандартов обмена данными. Обычно такие правила хранятся в специальных файлах — схемах, где самым подробным образом описана структура документа, все допустимые названия элементов, атрибутов и многое другое. И если документ, например, содержит не определённое заранее в схемах название элемента, то XML-документ считается недействительным; проверяющий XML-процессор (валидатор) при проверке на соответствие правилам и схемам обязан (по выбору пользователя) сообщить об ошибке.

Данные два понятия не имеют достаточно устоявшегося стандартизированного перевода на русский язык, особенно понятие valid, которое можно также перевести, как имеющий силу, правомерный, надёжный, годный, или даже проверенный на соответствие правилам, стандартам, законам. Некоторые программисты применяют в обиходе устоявшуюся кальку «Валидный».

Verify the output

Overview of .net framework

You’ll see the following result −

students.xml is valid against students.xsd

XSD — Simple Types

Microsoft .net framework

In this chapter, we’ll see Simple Types that XSD defines.

S.No.	Simple Type & Description
1	Simple Element can contain only text. It can not contain any other element.
2	Attribute is itself a type and is used in Complex Element.
3	Restriction defines the acceptable values of an XML element.

XSD — Complex Types

Complex Element is an XML element which can contain other elements and/or attributes. We can create a complex element in two ways −

Define a complex type and then create an element using the type attribute
Define a complex type directly by naming

Define a Complex Type and then create an element using type attribute.

<xs:complexType name = "StudentType">
   <xs:sequence>
      <xs:element name = "firstname" type = "xs:string"/>
      <xs:element name = "lastname" type = "xs:string"/>
      <xs:element name = "nickname" type = "xs:string"/>
      <xs:element name = "marks" type = "xs:positiveInteger"/>
   </xs:sequence>
   <xs:attribute name = 'rollno' type = 'xs:positiveInteger'/>
</xs:complexType>

<xs:element name = 'student' type = 'StudentType' />

Define a Complex Type directly by naming.

<xs:element name = "student">
   <xs:complexType>   
      <xs:sequence>
         <xs:element name = "firstname" type = "xs:string"/>
         <xs:element name = "lastname" type = "xs:string"/>
         <xs:element name = "nickname" type = "xs:string"/>
         <xs:element name = "marks" type = "xs:positiveInteger"/>
      </xs:sequence>
   <xs:attribute name = 'rollno' type = 'xs:positiveInteger'/>
   </xs:complexType>
<xs:element>

Following is the list of Complex Types that XSD supports.

S.No.	Simple Type & Description
1	Complex Empty complex type element can only have attributes but no contents.
2	Elements-Only complex type element can only contain elements
3	Text-Only complex type element can only contain attribute and text.
4	Mixed complex type element can contain element, attribute and text.
5	Indicators controls the ways how elements are to be organized in an XML document.
6	The <any> element is used for elements which are not defined by schema
7	The <anyAttribute> attribute is used for attribute which are not defined by schema.

String data types are used to represent characters in the XML documents.

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

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

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

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

<?xml version=»1.0″ encoding=»UTF-8″ ?>
<xs:schema xmlns:xs=»http://www.w3.org/2001/XMLSchema»>
<!— definition of simple elements —>
<xs:element name=»orderperson» type=»xs:string»/>
<xs:element name=»name» type=»xs:string»/>
<xs:element name=»address» type=»xs:string»/>
<xs:element name=»city» type=»xs:string»/>
<xs:element name=»country» type=»xs:string»/>
<xs:element name=»title» type=»xs:string»/>
<xs:element name=»note» type=»xs:string»/>
<xs:element name=»quantity» type=»xs:positiveInteger»/>
<xs:element name=»price» type=»xs:decimal»/>
<!— definition of attributes —>
<xs:attribute name=»orderid» type=»xs:string»/>
<!— definition of complex elements —>
<xs:element name=»shipto»>

<xs:complexType>

<xs:sequence>

<xs:element ref=»name»/>

<xs:element ref=»address»/>

<xs:element ref=»city»/>

<xs:element ref=»country»/>

</xs:sequence>

</xs:complexType>
</xs:element>
<xs:element name=»item»>

<xs:complexType>

<xs:sequence>

<xs:element ref=»title»/>

<xs:element ref=»note» minOccurs=»0″/>

<xs:element ref=»quantity»/>

<xs:element ref=»price»/>

</xs:sequence>

</xs:complexType>
</xs:element>
<xs:element name=»shiporder»>

<xs:complexType>

<xs:sequence>

<xs:element ref=»orderperson»/>

<xs:element ref=»shipto»/>

<xs:element ref=»item» maxOccurs=»unbounded»/>

</xs:sequence>

<xs:attribute ref=»orderid» use=»required»/>

</xs:complexType>
</xs:element>
</xs:schema>

Syntax

The basic syntax of a XSD is as follows −

<?xml version = "1.0"?>

<xs:schema xmlns:xs = "http://www.w3.org/2001/XMLSchema">
   targetNamespace = "http://www.tutorialspoint.com"
   xmlns = "http://www.tutorialspoint.com" elementFormDefault = "qualified">
   
   <xs:element name = 'class'>
      <xs:complexType>
         <xs:sequence>
            <xs:element name = 'student' type = 'StudentType' minOccurs = '0' 
               maxOccurs = 'unbounded' />
         </xs:sequence>
      </xs:complexType>
   </xs:element>

   <xs:complexType name = "StudentType">
      <xs:sequence>
         <xs:element name = "firstname" type = "xs:string"/>
         <xs:element name = "lastname" type = "xs:string"/>
         <xs:element name = "nickname" type = "xs:string"/>
         <xs:element name = "marks" type = "xs:positiveInteger"/>
      </xs:sequence>
      <xs:attribute name = 'rollno' type = 'xs:positiveInteger'/>
   </xs:complexType>
   
</xs:schema>

Поиск информации в XML файлах (XPath)¶

XPath ( англ. XML Path Language) — язык запросов к элементам
XML-документа. XPath расширяет возможности работы с XML.

XML имеет древовидную структуру. В документе всегда имеется корневой
элемент (инструкция к дереву отношения не имеет).
У элемента дерева всегда существуют потомки и предки, кроме корневого
элемента, у которого предков нет, а также тупиковых элементов (листьев
дерева), у которых нет потомков. Каждый элемент дерева находится на
определенном уровне вложенности (далее — «уровень»). У элементов на
одном уровне бывают предыдущие и следующие элементы.

Это очень похоже на организацию каталогов в файловой системе, и строки
XPath, фактически, — пути к «файлам» — элементам. Рассмотрим пример
списка книг:

<?xml version="1.0" encoding="windows-1251"?>
<bookstore>
   <book category="COOKING">
     <title lang="it">Everyday Italian</title>
     <author>Giada De Laurentiis</author>
     <year>2005</year>
     <price>30.00</price>
   </book>
   <book category="CHILDREN">
     <title lang="en">Harry Potter</title>
     <author>J K. Rowling</author>
     <year>2005</year>
     <price>29.99</price>
   </book>
   <book category="WEB">
     <title lang="en">Learning XML</title>
     <author>Erik T. Ray</author>
     <year>2003</year>
     <price>39.95</price>
   </book>
</bookstore>

XPath запрос вернет следующий результат:

<price>30.00</price>
<price>29.99</price>
<price>39.95</price>

Сокращенная форма этого запроса выглядит так: .

С помощью XPath запросов можно искать информацию по атрибутам. Например,
можно найти информацию о книге на итальянском языке: вернет .

Чтобы получить больше информации, необходимо модифицировать запрос вернет:

<book category="COOKING">
     <title lang="it">Everyday Italian</title>
     <author>Giada De Laurentiis</author>
     <year>2005</year>
     <price>30.00</price>
   </book>

В приведенной ниже таблице представлены некоторые выражения XPath и
результат их работы:

Using Named Types

The third design method defines classes or types, that enables us to reuse element
definitions. This is done by naming the simpleTypes and complexTypes elements,
and then point to them through the type attribute of the element.

Here is the third design of the schema file («shiporder.xsd»):

<?xml version=»1.0″ encoding=»UTF-8″ ?>
<xs:schema xmlns:xs=»http://www.w3.org/2001/XMLSchema»>
<xs:simpleType name=»stringtype»>

<xs:restriction base=»xs:string»/>
</xs:simpleType>
<xs:simpleType name=»inttype»>

<xs:restriction base=»xs:positiveInteger»/>
</xs:simpleType>
<xs:simpleType name=»dectype»>

<xs:restriction base=»xs:decimal»/>
</xs:simpleType>
<xs:simpleType name=»orderidtype»>

<xs:restriction base=»xs:string»>

<xs:pattern value=»{6}»/>

</xs:restriction>
</xs:simpleType>
<xs:complexType name=»shiptotype»>

<xs:sequence>

<xs:element name=»name» type=»stringtype»/>

<xs:element name=»address» type=»stringtype»/>

<xs:element name=»city» type=»stringtype»/>

<xs:element name=»country» type=»stringtype»/>

</xs:sequence>
</xs:complexType>
<xs:complexType name=»itemtype»>

<xs:sequence>

<xs:element name=»title» type=»stringtype»/>

<xs:element name=»note» type=»stringtype» minOccurs=»0″/>

<xs:element name=»quantity» type=»inttype»/>

<xs:element name=»price» type=»dectype»/>

</xs:sequence>
</xs:complexType>
<xs:complexType name=»shipordertype»>

<xs:sequence>

<xs:element name=»orderperson» type=»stringtype»/>

<xs:element name=»shipto» type=»shiptotype»/>

<xs:element name=»item» maxOccurs=»unbounded» type=»itemtype»/>

</xs:sequence>

<xs:attribute name=»orderid» type=»orderidtype» use=»required»/>
</xs:complexType>
<xs:element name=»shiporder» type=»shipordertype»/>
</xs:schema>

The restriction element indicates that the datatype is derived from a W3C XML
Schema namespace datatype. So, the following fragment means that the value of
the element or attribute must be a string value:

<xs:restriction base=»xs:string»>

The restriction element is more often used to apply restrictions to elements.
Look at the following lines from the schema above:

<xs:simpleType name=»orderidtype»>

<xs:restriction base=»xs:string»>

<xs:pattern value=»{6}»/>

</xs:restriction>
</xs:simpleType>

This indicates that the value of the element or attribute must be a string, it must be exactly six characters in a row, and those characters must be a
number from 0 to 9.

❮ Previous
Next ❯

Как открыть XML-файл

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

Используйте текстовый редактор при регулярной работе с XML

Поскольку XML-файлы – это просто текстовые файлы, их можно открыть в любом текстовом редакторе. Однако, многие текстовые редакторы, такие как Notepad, просто не предназначены для отображения XML-файлов с их правильной структурой. Это может быть полезно для быстро ознакомления с содержанием XML-файла. Но, существуют более удобные инструменты для работы с ними.

Щелкните правой кнопкой мыши файл XML, который вы хотите открыть, выберите Открыть с помощью в контекстном меню, а затем выберите Блокнот.
Примечание: мы используем Windows, но то же самое справедливо и для других операционных систем. Найдите хороший сторонний текстовый редактор, предназначенный для поддержки XML-файлов.
Файл открывается, но, как вы можете видеть, он теряет большую часть своего форматирования и записывает всё в две строки.
Таким образом, блокнот может быть полезен для быстрой проверки XML-файла. Но, гораздо удобнее использовать более продвинутый инструмент, такой как Notepad++, который подсвечивает синтаксис и формат файла, как это можно ожидать.
Вот тот же XML-файл, открытый в Notepad++

Использование веб-браузера для просмотра XML-файла

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

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

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

Использование онлайн-редактора для XML-файлов

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

Для примера используем CodeBeautify.org. Страница разделена на три раздела. Слева находится XML-файл, с которым вы работаете. В середине вы найдете несколько функций. Справа вы увидите результаты некоторых вариантов, которые вы можете выбрать.

Например, на рисунке ниже слева находится наш полный XML-файл, а на панели результатов отображается представление в виде дерева, так как мы нажали кнопку Tree View посередине.

Используйте кнопку Browse для загрузки XML-файла с вашего компьютера или кнопку Load URL для извлечения XML из интернет-источника

Кнопка Tree View отображает данные в хорошо отформатированной древовидной структуре на панели результатов, со всеми тегами, выделенными оранжевым цветом, и атрибутами справа от тегов.

Beatify отображает ваши данные в аккуратном, легко читаемом виде.

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

И, наконец, Вы можете использовать кнопку XML to JSON для преобразования XML в формат JSON, и кнопку Export to CSV для сохранения данных в виде файла значений, разделенных запятыми, или кнопку Download для загрузки любых изменений, которые вы сделали в новом XML-файле.

Что такое XSD

Термин «XSD» является аббревиатурой от английских слов «XML Schema definition». Файл с таким расширением являет собой схему описания XML-данных, использующую свой собственный язык для описания структуры документов XML.

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

Стандарт XSD 1.1 получил одобрение Консорциума Всемирной Паутины в апреле 2012 года, обладая несколькими важными преимуществами перед существовавшими до него схемами XML, такими как DTD (Document Type Definition) или SOX (Simple Object XML). К примеру, это то, что XSD написан на XML, имеется автоматическое создание схемы и так далее.

XML Technology данные записанные в файл

Divide the Schema

The previous design method is very simple, but can be difficult to read and maintain when documents are complex.

The next design method is based on defining all elements and attributes first, and then referring to them using the ref attribute.

Here is the new design of the schema file («shiporder.xsd»):

Как открыть xsd формат

Для открытия большинства файлов xsd будет достаточно использовать любые подручные текстовые редакторы (тот же «Блокнот», Notepad++, PSPad Editor и др.). Также в открытии xsd формата могут пригодиться такие программы как Microsoft XML Notepad, Oxygen XML Editor, Liquid XML Studio и другие аналоги.

Если же данный файл являет собой результат работы программы Pattern Maker for Cross stitch (обычно это рисунок-схема для вышивки), то такой файл можно просмотреть или с помощью указанной программы, или с помощью специального просмотрщика под названием «Pattern Maker Viewer».

Вышивка формата .XSD

Сущности¶

Некоторые символы в XML имеют особые значения и являются служебными. Если вы поместите,
например, символ внутри XML элемента, то будет
сгенерирована ошибка, так как парсер интерпретирует его, как начало
нового элемента.

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

<НПЮЛ ИННЮЛ="7718962261" КПП="771801001" НаимОрг="ООО<Мосавтогруз>"/>

Также ошибка будет сгенерирована и в слудющем примере, если название организации взять в обычные кавычки (английские двойные):

<НПЮЛ ИННЮЛ="7718962261" КПП="771801001" НаимОрг="ООО"Мосавтогруз""/>

Чтобы ошибки не возникали, нужно заменить символ на его
сущность. В XML существует 5 предопределенных сущностей:

Таблица I.1 — Сущности

Сущность
Символ
Значение

меньше, чем

больше, чем

амперсанд

апостроф

кавычки

Примечание

Только символы и строго запрещены в XML. Символ допустим, но лучше его всегда заменять на сущность.

Таким образом, корректными будут следующие формы записей:

<НПЮЛ ИННЮЛ="7718962261" КПП="771801001" НаимОрг="ООО&quot;Мосавтогруз&quot;"/>

или

<НПЮЛ ИННЮЛ="7718962261" КПП="771801001" НаимОрг="ООО«Мосавтогруз»"/>

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

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

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

<?xml version=»1.0″ encoding=»UTF-8″ ?>
<xs:schema xmlns:xs=»http://www.w3.org/2001/XMLSchema»>…
</xs:schema>

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

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

<xs:element name=»shiporder»>

<xs:complexType>

<xs:sequence>

…

</xs:sequence>

</xs:complexType>
</xs:element>

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

<xs:element name=»orderperson» type=»xs:string»/>

Далее, мы должны определить два элемента , которые имеют сложного типа: «shipto» и «item» . Мы начнем с определения «shipto» элемент:

<xs:element name=»shipto»>

<xs:complexType>

<xs:sequence>

<xs:element name=»name» type=»xs:string»/>

<xs:element name=»address» type=»xs:string»/>

<xs:element name=»city» type=»xs:string»/>

<xs:element name=»country» type=»xs:string»/>

</xs:sequence>

</xs:complexType>
</xs:element>

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

Теперь мы можем определить «item» элемент. Этот элемент может появляться несколько раз внутри «shiporder» элемента. Это определяется установкой maxOccurs атрибут «item» элемента «unbounded» , что означает , что там может быть много вхождений «item» элемент , как автор хочет

Обратите внимание на то, что «note» элемент не является обязательным. Мы определили это, установив minOccurs атрибут к нулю:

<xs:element name=»item» maxOccurs=»unbounded»>

<xs:complexType>

<xs:sequence>

<xs:element name=»title» type=»xs:string»/>

<xs:element name=»note» type=»xs:string» minOccurs=»0″/>

<xs:element name=»quantity» type=»xs:positiveInteger»/>

<xs:element name=»price» type=»xs:decimal»/>

</xs:sequence>

</xs:complexType>
</xs:element>

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

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

<xs:attribute name=»orderid» type=»xs:string» use=»required»/>

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

<?xml version=»1.0″ encoding=»UTF-8″ ?>
<xs:schema xmlns:xs=»http://www.w3.org/2001/XMLSchema»>
<xs:element name=»shiporder»>

<xs:complexType>

<xs:sequence>

<xs:element name=»orderperson» type=»xs:string»/>

<xs:element name=»shipto»>

<xs:complexType>

<xs:sequence>

<xs:element name=»name» type=»xs:string»/>

<xs:element name=»address» type=»xs:string»/>

<xs:element name=»city» type=»xs:string»/>

<xs:element name=»country» type=»xs:string»/>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name=»item» maxOccurs=»unbounded»>

<xs:complexType>

<xs:sequence>

<xs:element name=»title» type=»xs:string»/>

<xs:element name=»note» type=»xs:string» minOccurs=»0″/>

<xs:element name=»quantity» type=»xs:positiveInteger»/>

<xs:element name=»price» type=»xs:decimal»/>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

<xs:attribute name=»orderid» type=»xs:string» use=»required»/>

</xs:complexType>
</xs:element>
</xs:schema>