Начало работы
Структура XML-документа
XML-документы начинаются с XML-объявления. Элементы должны быть правильно вложены и закрыты. Атрибуты дают дополнительные метаданные. xmlns объявляет пространства имён XML, чтобы избежать конфликтов имён.
<?xml version="1.0" encoding="UTF-8"?>
<!-- This is a comment -->
<bookstore xmlns="https://example.com/books">
<book id="b1" category="fiction">
<title lang="en">The Great Gatsby</title>
<author>F. Scott Fitzgerald</author>
<price currency="USD">12.99</price>
</book>
<book id="b2" category="programming">
<title lang="en">XML Guide</title>
<author>John Doe</author>
<price currency="USD">29.99</price>
</book>
</bookstore>XML-объявление
XML-объявление — первая строка пролога. 'version' обязателен (1.0 или 1.1). 'encoding' по умолчанию UTF-8. 'standalone' говорит парсерам, нужны ли внешние объявления DTD.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!-- version is required; encoding and standalone are optional -->
<!-- encoding defaults to UTF-8 -->
<!-- standalone="yes" means no external markup declarations -->
<root>
<child>text</child>
</root>Комментарии и инструкции обработки
Комментарии используют <!-- --> и не могут вкладываться или содержать '--'. Инструкции обработки (PI) вроде xml-stylesheet передают парсеру информацию приложения. PI имеют вид <?target data?>.
<?xml version="1.0"?>
<!-- a comment: ignored by the parser, cannot contain -- -->
<?xml-stylesheet type="text/xsl" href="style.xsl"?>
<root>
<!-- comments can span
multiple lines -->
<item>data</item>
</root>Корректный XML
Корректность означает: один корневой элемент, правильная вложенность, все теги закрыты, атрибуты в кавычках, нет дублирующихся атрибутов. Документ ОБЯЗАН быть корректным, чтобы парситься; валидность (по DTD/схеме) необязательна.
<!-- WELL-FORMED: single root, properly nested, closed -->
<root>
<a>
<b>text</b>
</a>
</root>
<!-- NOT well-formed: two roots, overlapping tags -->
<!-- <a><b></a></b> -->
<!-- <x></x><y></y> (no single root) -->
<!-- All attributes must be quoted -->
<item id='1' type="x"/>Пролог и пробелы
Пролог включает XML-объявление и необязательный DOCTYPE. xml:space='preserve' велит парсерам сохранять пробелы; 'default' допускает обычную обработку. Пробелы между элементами обычно незначимы.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE root SYSTEM "root.dtd">
<root xml:space="preserve">
<item> spaced text </item>
<item xml:space="default"> trimmed </item>
</root>Обзор CDATA
Секции CDATA помечают текст, который парсер не должен толковать как разметку. Внутри CDATA символы <, > и & не нужно экранировать. CDATA нельзя вкладывать, и она не может содержать литерал ']]>'.
<?xml version="1.0"?>
<root>
<code><![CDATA[
if (a < b && c > d) {
console.log("no escaping needed: < > & ");
}
]]></code>
</root>Элементы и атрибуты
Элементы против атрибутов
Атрибуты подходят для метаданных (id, типы, флаги); элементы — для данных со структурой или повторяющимися значениями. Атрибут встречается у элемента один раз и не может хранить вложенную структуру. Строгих правил нет: важнее последовательность.
<!-- Attributes: metadata/identifiers; Elements: data -->
<person id="p1">
<name>Alice</name>
<age>30</age>
</person>
<!-- vs. putting everything in attributes -->
<person id="p1" name="Alice" age="30"/>
<!-- Rule of thumb: use elements for data you display,
attributes for IDs, types, and metadata -->Пустые элементы
У пустого элемента нет содержимого. Самозакрывающаяся форма <tag/> — сокращение для <tag></tag>. Пробел перед '/>' — стилистическое соглашение для читаемости и совместимости с XHTML.
<!-- Three equivalent empty-element forms -->
<br></br>
<br/>
<br />
<!-- empty element with attributes -->
<img src="logo.png" alt="Logo" width="200" height="100"/>
<!-- self-closing with namespace -->
<xlink:link xmlns:xlink="http://www.w3.org/1999/xlink" href="#sec1"/>Вложенные элементы
Элементы вкладываются иерархически и должны закрываться в обратном порядке — пересекаться они не могут. Вложенность выражает структуру. Глубоко вложенные деревья валидны, но снижают читаемость и производительность разбора.
<library>
<section name="fiction">
<book>
<title>Book A</title>
<authors>
<author>Author 1</author>
<author>Author 2</author>
</authors>
</book>
</section>
</library>
<!-- WRONG: tags must not overlap -->
<!-- <a><b></a></b> -->Значения атрибутов и кавычки
Значения атрибутов должны быть в одинарных или двойных кавычках. Двойные кавычки внутри значения в двойных кавычках нужно экранировать как ". Атрибут может встречаться у элемента только один раз: для повторяющихся значений используйте дочерние элементы.
<!-- Both single and double quotes are allowed -->
<item id="q1" name='quick'/>
<msg text="He said "hi""/>
<msg text='She said 'hi''/>
<!-- attribute values MUST be quoted -->
<!-- <item id=q1/> is NOT well-formed -->
<!-- an attribute can appear at most once per element -->
<point x="1" y="2" z="3"/>Атрибуты по умолчанию и фиксированные
Объявления атрибутов в DTD поддерживают #REQUIRED (обязателен), #IMPLIED (необя зателен), #FIXED (постоянное значение) и буквальное значение по умолчанию. Атрибут #FIXED должен всегда равняться объявленному значению, иначе документ невалиден.
<!-- In a DTD, attributes can have defaults -->
<!ATTLIST item
type CDATA "standard"
status CDATA #REQUIRED
version CDATA #FIXED "1.0"
note CDATA #IMPLIED>
<item status="active"/>
<!-- 'type' defaults to "standard", 'version' is fixed,
'note' is optional (#IMPLIED) -->Правила именования элементов
Имена элементов должны начинаться с буквы или подчёркивания и могут содержать буквы, цифры, дефисы, подчёркивания и точки. Имена не могут начинаться с 'xml' (в любом регистре). XML чувствителен к регистру: <Tag> и <tag> различаются.
<!-- Names: start with a letter or underscore,
continue with letters, digits, hyphens, underscores, dots -->
<my-element>ok</my-element>
<my.element>ok</my.element>
<my_element>ok</my_element>
<_private>ok</_private>
<x-1>ok</x-1>
<!-- NOT allowed: starting with a digit or 'xml', containing spaces -->
<!-- <2way/> -->
<!-- <my element/> -->
<!-- <XmlTag/> (names are case-sensitive; 'xml' prefix is reserved) -->Пространства имён
Пространство имён по умолчанию
Пространство имён по умолчанию (xmlns=URI) действует на элемент, где объявлено, и всех потомков без префикса. Дочерние элементы наследуют его, если не переопределено. Атрибуты никогда не используют пространство имён по умолчанию.
<?xml version="1.0"?>
<table xmlns="http://www.w3.org/1999/xhtml">
<tr>
<td>Cell content</td>
<td>More content</td>
</tr>
</table>
<!-- All elements without a prefix use the default namespace -->Префикс пространства имён
Префикс пространства имён объявляется как xmlns:prefix=URI и используется как prefix:element. Префикс — лишь псевдоним: для идентичности важен только URI. Префиксы чувствительны к регистру.
<?xml version="1.0"?>
<root xmlns:bk="https://example.com/books"
xmlns:au="https://example.com/authors">
<bk:book bk:id="b1">
<au:author au:name="Jane Doe"/>
<bk:title>XML Guide</bk:title>
</bk:book>
</root>Несколько пространств имён
Один документ может смешивать много пространств имён. Объявляйте каждый префикс один раз (обычно на корне) и переиспользуйте. Объявление пространства имён на элементе действует на этот элемент и его потомков.
<?xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<m:GetPrice xsi:type="xsd:string"
xmlns:m="https://example.com/pricing">
<m:Item>Apples</m:Item>
</m:GetPrice>
</soap:Body>
</soap:Envelope>Область видимости пространства имён
Объявления пространств имён ограничены элементом, где они стоят, и его потомками. Переобъявление внутри ребёнка переопределяет отображение префикса родителя для этого поддерева. После закрытия ребёнка исходное отображение восстанавливается.
<?xml version="1.0"?>
<root xmlns:a="http://a.example">
<a:item>A</a:item>
<child xmlns:a="http://b.example">
<!-- here 'a' is REBOUND to the b.example URI -->
<a:item>B</a:item>
</child>
<!-- outside child, 'a' is back to a.example -->
<a:item>A again</a:item>
</root>Частые пространства имён
Эти URI — известные идентификаторы, а не URL, которые нужно загружать. Пространство xsi даёт атрибуты экземпляра схемы (type, nil, schemaLocation). У XSD, XSL, SVG, SOAP, Atom и Dublin Core (dc) есть свои стандартные URI.
<!-- Frequently used namespace URIs -->
xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd = "http://www.w3.org/2001/XMLSchema"
xmlns:xsl = "http://www.w3.org/1999/XSL/Transform"
xmlns:svg = "http://www.w3.org/2000/svg"
xmlns:html = "http://www.w3.org/1999/xhtml"
xmlns:soap = "http://schemas.xmlsoap.org/soap/envelope/"
xmlns:atom = "http://www.w3.org/2005/Atom"
xmlns:dc = "http://purl.org/dc/elements/1.1/"Target namespace в XSD
targetNamespace схемы — пространство имён элементов, которые она определяет. elementFormDefault='qualified' означает, что локально объявленные элементы входят в целевое пространство имён. Префикс tns — соглашение для «этого пространства имён».
<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="https://example.com/orders"
xmlns:tns="https://example.com/orders"
elementFormDefault="qualified">
<xs:element name="order" type="tns:OrderType"/>
<xs:complexType name="OrderType">
<xs:sequence>
<xs:element name="item" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:schema>CDATA и сущности
Предопределённые сущности
XML предопределяет п ять сущностей: < (<), > (>), & (&), ' ('), " ("). & нужно экранировать ВСЕГДА (даже в тексте без CDATA); < нужно экранировать везде, кроме начала тега; кавычки важны в основном в атрибутах.
<?xml version="1.0"?>
<root>
<lt>less than: <</lt>
<gt>greater than: ></gt>
<amp>ampersand: &</amp>
<apos>apostrophe: '</apos>
<quot>quote: "</quot>
<!-- < > & ' " are the 5 built-in entities -->
</root>Ссылки на символы
Ссылки на символы используют кодовую точку Unicode: © (десятичная) или © (шестнадцатеричная) для ©. Они работают в тексте элементов и значениях атрибутов и не зависят от кодировки. Так можно представить любой символ Unicode.
<?xml version="1.0" encoding="UTF-8"?>
<root>
<decimal>© 2024 Company</decimal>
<hex>© 2024 Company</hex>
<euro>Price: €10</euro>
<emoji>Smile: 😀</emoji>
</root>
<!-- &#NNN; decimal code point -->
<!-- &#xHHH; hexadecimal code point -->Секции CDATA
Секции CDATA позволяют включать <, > и & без экранирования — удобно для кода и разметки. CDATA не может содержать литерал ']]>'; чтобы вставить его, разделите секцию, как показано. CDATA — символьные данные, а не разбираемые элементы.
<?xml version="1.0"?>
<root>
<script><![CDATA[
function check(a, b) {
if (a < b && b > 0) {
return a & b;
}
}
]]></script>
<!-- to include ]]> inside CDATA, split it -->
<data><![CDATA[foo]]]]><![CDATA[>bar]]></data>
</root>Свои сущности (DTD)
Внутренние сущности объявляются в DTD и раскрываются везде, где на них ссылаются. Они работают как текс товые макросы и могут ссылаться на другие сущности. Полезно для повторяющегося шаблонного текста. Осторожно: внешние и общие сущности создают риск XXE.
<?xml version="1.0"?>
<!DOCTYPE root [
<!ENTITY company "Acme Corp.">
<!ENTITY version "2.0">
<!ENTITY copyright "Copyright © 2024 &company;">
]>
<root>
<product>&company; Toolkit v&version;</product>
<footer>©right;</footer>
</root>
<!-- Entities are expanded during parsing -->Экранирование в атрибутах
Внутри значений атрибутов нужно экранировать & как &, а также кавычку, ограничивающую значение (" или '). < тоже следует экранировать. Переводы строк и табуляция в атрибутах парсер нормализует в пробелы.
<?xml version="1.0"?>
<root>
<link url="https://example.com?a=1&b=2"/>
<msg text="Say "hello" & smile"/>
<path value='C:\Users\name'/>
<data value="<tagged>"/>
</root>Параметрические сущности
Параметрические сущности (объявляются через %) используются только внутри DTD для построения переиспользуемых моделей содержимого. На них ссылаются как %name; (с точкой с запятой). Общие сущности (&name;) используются в содержимом документа.
<?xml version="1.0"?>
<!DOCTYPE root [
<!ENTITY % inline " (#PCDATA | em | strong)* ">
<!ELEMENT p %inline;>
<!ELEMENT em %inline;>
<!ELEMENT strong %inline;>
<!ELEMENT root (p)*>
]>
<root>
<p>Hello <em>world</em> and <strong>XML</strong>.</p>
</root>DTD (Document Type Definition)
Внутренний DTD
Внутренний DTD объявляется прямо в DOCTYPE в квадратных скобках. Он описывает структуру: какие элементы существуют, их модели содержимого и атрибуты. Внутренние DTD самодостаточны, но действуют только на один документ.
<?xml version="1.0"?>
<!DOCTYPE note [
<!ELEMENT note (to, from, heading, body)>
<!ELEMENT to (#PCDATA)>
<!ELEMENT from (#PCDATA)>
<!ELEMENT heading (#PCDATA)>
<!ELEMENT body (#PCDATA)>
]>
<note>
<to>Alice</to>
<from>Bob</from>
<heading>Reminder</heading>
<body>Don't forget the meeting</body>
</note>Внешний DTD
Внешний DTD живёт в отдельном файле .dtd, на который ссылаются через SYSTEM (приватный) или PUBLIC (публичный идентификатор + URI). Внешние DTD позволяют многим документам делить одно определение. SYSTEM 'file.dtd' — самая частая форма.