Что такое XSD и для чего он используется?

XSD (XML Schema Definition): назначение и применение

Определение XSD

XSD (XML Schema Definition) — это язык для определения структуры, содержания и семантики XML-документов. Проще говоря, это схема, которая описывает, какие элементы и атрибуты должны быть в XML файле, какие типы данных они имеют и какие правила валидации нужно применять.

XSD — это XML-ориентированный стандарт, рекомендованный W3C.

Назначение XSD

1. Валидация структуры XML

• Определить, какие элементы обязательны, а какие опциональны
• Указать порядок элементов
• Определить количество повторений элемента

2. Описание типов данных

• Определить тип данных для каждого элемента (строка, число, дата)
• Установить ограничения на значения (минимум, максимум, регулярные выражения)

3. Документирование

• Служит документацией для разработчиков
• Описывает, как должны быть структурированы данные

4. Интеграция систем

• Часто используется в SOAP, EDI, системах обмена данными
• Обеспечивает контракт между системами

История и контекст

• 1998 — появился DTD (Document Type Definition) — первый стандарт валидации XML
• 2001 — W3C утвердил XML Schema (более мощный чем DTD)
• 2004-2011 — стал стандартом для корпоративных систем
• Сегодня — XSD используется в legacy коде и в SOAP сервисах, но в REST API чаще используют JSON Schema

Структура XSD файла

Простой пример:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  
  <!-- Определение типа для адреса -->
  <xs:complexType name="AddressType">
    <xs:sequence>
      <xs:element name="street" type="xs:string" minOccurs="1" maxOccurs="1"/>
      <xs:element name="city" type="xs:string"/>
      <xs:element name="zipcode" type="xs:string" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
  
  <!-- Определение корневого элемента -->
  <xs:element name="person">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="name" type="xs:string"/>
        <xs:element name="age" type="xs:integer"/>
        <xs:element name="email" type="xs:string"/>
        <xs:element name="address" type="AddressType" minOccurs="0"/>
      </xs:sequence>
      <xs:attribute name="id" type="xs:integer" use="required"/>
    </xs:complexType>
  </xs:element>
  
</xs:schema>

Соответствующий XML файл, валидный по этой схеме:

<?xml version="1.0"?>
<person id="1">
  <name>Иван Петров</name>
  <age>30</age>
  <email>ivan@example.com</email>
  <address>
    <street>Красная 123</street>
    <city>Москва</city>
    <zipcode>101000</zipcode>
  </address>
</person>

Основные элементы XSD

1. Типы данных (Simple Types)

XSD поддерживает встроенные типы данных:

<!-- String типы -->
<xs:element name="username" type="xs:string"/>
<xs:element name="password" type="xs:string"/>

<!-- Числовые типы -->
<xs:element name="age" type="xs:integer"/>
<xs:element name="price" type="xs:decimal"/>
<xs:element name="quantity" type="xs:int"/>
<xs:element name="percentage" type="xs:float"/>

<!-- Дата и время -->
<xs:element name="birthDate" type="xs:date"/>
<xs:element name="created" type="xs:dateTime"/>
<xs:element name="duration" type="xs:duration"/>

<!-- Булевы типы -->
<xs:element name="isActive" type="xs:boolean"/>

<!-- Другие типы -->
<xs:element name="email" type="xs:anyURI"/>
<xs:element name="photo" type="xs:base64Binary"/>

2. Ограничения на значения (Restrictions)

<!-- Ограничение по длине строки -->
<xs:element name="username">
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:minLength value="3"/>
      <xs:maxLength value="20"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

<!-- Ограничение по диапазону чисел -->
<xs:element name="age">
  <xs:simpleType>
    <xs:restriction base="xs:integer">
      <xs:minInclusive value="0"/>
      <xs:maxInclusive value="150"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

<!-- Регулярное выражение -->
<xs:element name="email">
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:pattern value="[a-zA-Z0-9._%-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

<!-- Перечисление допустимых значений -->
<xs:element name="status">
  <xs:simpleType>
    <xs:restriction base="xs:string">
      <xs:enumeration value="active"/>
      <xs:enumeration value="inactive"/>
      <xs:enumeration value="pending"/>
    </xs:restriction>
  </xs:simpleType>
</xs:element>

3. Сложные типы (Complex Types)

<!-- Последовательность элементов (все в строгом порядке) -->
<xs:complexType name="PersonType">
  <xs:sequence>
    <xs:element name="firstName" type="xs:string"/>
    <xs:element name="lastName" type="xs:string"/>
    <xs:element name="middleName" type="xs:string" minOccurs="0"/>
  </xs:sequence>
</xs:complexType>

<!-- Выбор одного из элементов (OR) -->
<xs:complexType name="PaymentType">
  <xs:choice>
    <xs:element name="creditCard" type="CreditCardType"/>
    <xs:element name="bankTransfer" type="BankTransferType"/>
    <xs:element name="wallet" type="WalletType"/>
  </xs:choice>
</xs:complexType>

<!-- Группа элементов (все могут повторяться) -->
<xs:complexType name="OrderType">
  <xs:all>
    <xs:element name="orderNumber" type="xs:string"/>
    <xs:element name="customerName" type="xs:string"/>
    <xs:element name="totalAmount" type="xs:decimal"/>
  </xs:all>
</xs:complexType>

4. Атрибуты

<xs:complexType name="BookType">
  <xs:sequence>
    <xs:element name="title" type="xs:string"/>
    <xs:element name="author" type="xs:string"/>
  </xs:sequence>
  <!-- Обязательный атрибут -->
  <xs:attribute name="isbn" type="xs:string" use="required"/>
  <!-- Опциональный атрибут -->
  <xs:attribute name="publicationYear" type="xs:integer" use="optional"/>
  <!-- Атрибут со значением по умолчанию -->
  <xs:attribute name="language" type="xs:string" default="en"/>
</xs:complexType>

Использование XSD в реальных сценариях

1. SOAP Web Services

SOAP использует XSD для описания параметров и возвращаемых значений:

<wsdl:types>
  <xs:schema>
    <xs:element name="GetUserRequest">
      <xs:complexType>
        <xs:sequence>
          <xs:element name="userId" type="xs:integer"/>
        </xs:sequence>
      </xs:complexType>
    </xs:element>
    
    <xs:element name="User">
      <xs:complexType>
        <xs:sequence>
          <xs:element name="id" type="xs:integer"/>
          <xs:element name="name" type="xs:string"/>
          <xs:element name="email" type="xs:string"/>
        </xs:sequence>
      </xs:complexType>
    </xs:element>
  </xs:schema>
</wsdl:types>

2. EDI (Electronic Data Interchange)

В системах электронного обмена данными между организациями:

<xs:element name="Invoice">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="invoiceNumber" type="xs:string"/>
      <xs:element name="invoiceDate" type="xs:date"/>
      <xs:element name="items">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="item" maxOccurs="unbounded">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="description" type="xs:string"/>
                  <xs:element name="quantity" type="xs:integer"/>
                  <xs:element name="unitPrice" type="xs:decimal"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>

XSD vs JSON Schema

JSON Schema эквивалент XSD:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "age": { "type": "integer", "minimum": 0, "maximum": 150 },
    "email": { "type": "string", "format": "email" }
  },
  "required": ["name", "email"]
}

Валидация XML по XSD

В Java:

SchemaFactory factory = SchemaFactory.newInstance(
  XMLConstants.W3C_XML_SCHEMA_NS_URI
);
Schema schema = factory.newSchema(new File("schema.xsd"));
Validator validator = schema.newValidator();
validator.validate(new StreamSource(new File("data.xml")));

В Python:

from lxml import etree

with open(schema.xsd, r) as f:
    schema_doc = etree.parse(f)
    schema = etree.XMLSchema(schema_doc)

with open(data.xml, r) as f:
    xml_doc = etree.parse(f)
    
if schema.validate(xml_doc):
    print("Valid!")
else:
    print(schema.error_log)

Когда использовать XSD

Используй XSD когда:

• Работаешь с SOAP сервисами
• Интегрируешься с legacy системами
• Нужна строгая валидация структуры данных (EDI, финансовые системы)
• Требуется formal specification XML формата
• Работаешь в корпоративной среде (Java EE, .NET)

Не используй XSD когда:

• Разрабатываешь REST API (используй JSON Schema вместо этого)
• Нужна простота и скорость разработки
• Работаешь в современном веб-приложении
• Команда не знакома с XML технологиями

Частые ошибки

1. Слишком строгие ограничения

   • Может заблокировать легитимные данные в будущем

2. Недостаточная документация в XSD

   • Добавляй <xs:annotation> для описания

3. Неправильный порядок элементов

   • Используй <xs:sequence> если порядок важен

4. Забывание про версионирование

   • При изменении схемы — обнови версию

Заключение

XSD — это мощный инструмент для валидации XML структур, используемый в корпоративных системах, SOAP сервисах и EDI. Однако в современных REST API проектах на его место пришёл JSON Schema.

Если ты видишь XSD в коде — это, скорее всего, legacy система или интеграция с корпоративным ПО. Для новых проектов рекомендуется использовать JSON и JSON Schema.