Форматувати та робити відступи у XML

Форматування XML (також зване XML pretty print, XML відступ або XML форматування) полягає у реорганізації компактного або мінімізованого XML-документа у структуру з відступами, читабельну рядок за рядком. Добре відформатований XML покращує читабельність людиною, що є суттєвим при читанні SOAP-відповіді, перегляді RSS-потоку або інспекції файлу конфігурації.

Конкретно, XML форматується з чотирьох основних причин:

• Debug: швидко знайти незакритий тег, відсутній атрибут або непослідовну структуру.
• Ручна інтеграція: чисто скопіювати фрагмент у файл конфігурації без порушення наявного відступу.
• Code review: порівняння двох версій XML-документа у Git diff стає читабельним, коли кожен тег знаходиться на власному рядку.
• Документація та приклади: відформатований XML набагато більш дидактичний у технічній документації або README.

XML залишається скрізь присутнім в екосистемі програмного забезпечення. Ось формати, на яких розробники найчастіше використовують XML-форматер:

• SOAP-відповіді: конверти <soap:Envelope>, повернуті SOAP веб-сервісами, як правило мінімізовані.
• RSS та Atom потоки: для інспекції або аудиту потоку синдикації.
• Конфігурації Spring, Maven (pom.xml), Ant, Ivy: файли збірки та залежностей Java.
• AndroidManifest.xml та інші XML-ресурси Android-проекту.
• SVG-файли: векторна графіка, експортована з дизайн-програми, часто стиснута в один рядок.
• Експорти e-commerce: потоки продуктів Google Shopping, експорти Magento, Shopify або PrestaShop.
• Документи OOXML: файли .docx, .xlsx та .pptx є ZIP-архівами, що містять XML-файли, які часто потрібно інспектувати.
• XML-сайтмапи: sitemap.xml, що обслуговуються пошуковим системам.

XML-форматер не просто додає пробіли навмання. Він виконує два кроки:

1. Parsing: документ читається, потім перетворюється у дерево DOM (Document Object Model). Цей крок також перевіряє, що XML є добре сформованим (теги правильно вкладені, атрибути у лапках, один кореневий елемент).
2. Індентований серіалізатор: дерево DOM повторно виводиться у вигляді тексту з переносами рядків між елементами та відступом, пропорційним глибині у дереві.

Цей підхід через дерево гарантує, що логічна структура документа залишається суворо ідентичною: змінюються лише незначущі пробіли між тегами. Секції CDATA, коментарі та інструкції обробки зберігаються.

Процедура навмисно проста:

1. Вставте ваш XML-документ у текстове поле або завантажте файл .xml.
2. Підтвердіть форму: документ аналізується та автоматично виділяється відступами.
3. Відформатований результат з'являється в зоні виведення. У разі помилки парсингу, повідомлення вказує характер та приблизне місце проблеми.
4. Скопіюйте результат за допомогою відповідної кнопки або завантажте для безпосередньої інтеграції у ваш проект.

Кілька угод для дотримання з метою виробляти чистий та довготривалий XML:

• Відступ: 2 або 4 пробіли відповідно до угоди вашої команди. Залишайтеся послідовними у всьому проекті.
• Переноси рядків: один елемент на рядок, що робить Git diff придатним для використання.
• CDATA-секції: гарний форматер повністю зберігає блоки <![CDATA[ ... ]]> без переіндентації їхнього вмісту, який обробляється як сирий текст.
• Кодування: завжди оголошуйте кодування у першому рядку з <?xml version="1.0" encoding="UTF-8"?>. UTF-8 є де-факто стандартом.
• Атрибути: якщо елемент має багато атрибутів, деякі команди переносять їх на новий рядок для читабельності; інакше вони залишаються на тому самому рядку, що й відкриваючий тег.
• Коментарі: <!-- ... --> повинні зберігатися форматером такими як є.

Ось конкретний приклад компактного XML, прикрашеного форматером.

До (один рядок, нечитабельний):

<root><item id="1">val</item><item id="2">val2</item></root>

Після (відформатований з 2 пробілами):

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <item id="1">val</item>
  <item id="2">val2</item>
</root>

Логічна структура є суворо ідентичною: змінюється лише візуальний порядок.

Більший XML-документ після форматування виглядає так:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <user id="12345">
    <name>John Doe</name>
    <email>johndoe@example.com</email>
    <address>
      <street>123 Main St</street>
      <city>Springfield</city>
      <state>IL</state>
      <postalCode>62704</postalCode>
      <country>USA</country>
    </address>
    <phoneNumbers>
      <phoneNumber type="home">555-1234</phoneNumber>
      <phoneNumber type="work">555-5678</phoneNumber>
    </phoneNumbers>
    <preferences>
      <newsletter>true</newsletter>
      <theme>dark</theme>
    </preferences>
    <lastLogin>2024-06-14T09:30:00Z</lastLogin>
  </user>
</root>