XSD Пример


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


Документ XML

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

<?xml version="1.0" encoding="ISO-8859-1"?>

<shiporder orderid="889923"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="shiporder.xsd">
  <orderperson>John Smith</orderperson>
  <shipto>
    <name>Ola Nordmann</name>
    <address>Langgt 23</address>
    <city>4000 Stavanger</city>
    <country>Norway</country>
  </shipto>
  <item>
    <title>Империя бурлеска</title>
    <note>Special Edition</note>
    <quantity>1</quantity>
    <price>10.90</price>
  </item>
  <item>
    <title>Спрячь своё сердце</title>
    <quantity>1</quantity>
    <price>9.90</price>
  </item>
</shiporder>

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" указывает расположение схемы (здесь она находится в той же папке, что и "shiporder.xml").


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

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

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

<?xml version="1.0" encoding="ISO-8859-1" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
...
</xs:schema>

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

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

<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 в 0:

<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". Поскольку этот атрибут обязателен, мы указываем use="required".

Примечание:Объявление этого атрибута должно быть размещено в конце:

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

Это листинг документа файла схемы с именем "shiporder.xsd":

<?xml version="1.0" encoding="ISO-8859-1" ?>
<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>


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

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

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

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

<?xml version="1.0" encoding="ISO-8859-1" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">

<!-- определение простых элементов -->
<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"/>

<!-- определение атрибутов -->
<xs:attribute name="orderid" type="xs:string"/>

<!-- определение сложных элементов -->
<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>


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

Третий метод проектирования определяет классы или типы, давая нам возможность повторно использовать определения элементов. Конкретный подход таков: сначала назовите простые элементы и сложные элементы, а затем ссылайтесь на них через атрибут type элемента.

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

<?xml version="1.0" encoding="ISO-8859-1" ?>
<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="[0-9]{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>

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

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

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

<xs:simpleType name="orderidtype">
  <xs:restriction base="xs:string">
    <xs:pattern value="[0-9]{6}"/>
  </xs:restriction>
</xs:simpleType>

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

Другие расширения