Как отформатировать XML с отступами и сделать его читаемым

Для чего нужен форматировщик XML

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

Инструмент подходит, когда нужно быстро привести фрагмент конфигурации, ответа сервиса или экспортированного документа к удобному виду перед проверкой структуры. Режим с отступами помогает увидеть уровни вложенности, а режим минификации уменьшает визуальный объём XML. Результат зависит от того, является ли исходный текст корректным XML: форматирование с отступами сначала разбирает документ, поэтому синтаксическая ошибка может привести к неуспешному результату, а не к исправлению файла.

Параметр отступа задаёт ширину отступа. Если его не менять, используется значение 2 пробела. Это не превращает произвольный текст в XML: вход должен быть строкой с XML-содержимым, кроме отдельного случая пустого или состоящего только из пробелов ввода, который возвращает пустой результат.

Как отформатировать или минифицировать XML

Подготовьте XML-текст. Проверьте, что корневой элемент закрыт, кавычки в атрибутах парные, а вложенные элементы имеют корректные закрывающие теги. Вставьте текст во входное поле инструмента. Передача значения, которое не является строкой, завершается неуспешно.
Для обычного читаемого представления оставьте режим форматирования с отступами. Если нужно получить компактную запись, выберите режим минификации. Название режима в техническом интерфейсе может отображаться отдельно от самого XML-текста, поэтому ориентируйтесь на переключатель режима, а не на добавление специальных символов в документ.
При необходимости задайте ширину отступа. Для непустого XML значение преобразуется в целое число, если это возможно. Число от 0 до 8 принимается, а значение меньше 0, больше 8 или не преобразуемое в целое заменяется на 2. Для стандартной проверки вложенности удобно начать с 2 или выбрать большее значение, если уровни трудно различать.
Запустите форматирование и проверьте, что появился успешный результат. При режиме с отступами оцените уровни вложенности и расположение атрибутов. Если результат не создан, сначала вернитесь к исходному XML и найдите синтаксическую проблему, а не пытайтесь компенсировать её настройкой пробелов.
В режиме минификации учитывайте характер преобразования: комментарии XML удаляются, пробелы между тегами сворачиваются, а пробелы в начале и конце текста обрезаются. Сохраните исходный документ отдельно, если комментарии или исходное визуальное оформление ещё нужны.
Для большого непустого ввода проверьте размер до запуска: текст больше 1 000 000 байт UTF-8 отклоняется. Пустой или состоящий только из пробелов ввод обрабатывается раньше этой проверки и возвращает пустой результат. Поэтому результат для пустого поля не следует считать подтверждением корректности XML-документа.

Как читать результат и понимать ограничения

Успешный результат в режиме с отступами означает, что XML прошёл разбор и был выведен в структурированном, читаемом виде. Отступы показывают вложенность, но сам инструмент не должен рассматриваться как средство исправления синтаксиса: неправильно закрытый тег, повреждённая кавычка или другая ошибка разбора могут привести к неуспешной обработке.

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

Представьте ситуацию: у вас есть непустой XML-ответ с несколькими вложенными элементами и комментариями, записанный в одну строку. Вы вставляете его, оставляете форматирование с отступами и задаёте ширину 4. Проверяемая форма результата будет успешным XML-текстом с видимыми уровнями вложенности и отступами по 4 пробела. Если затем выбрать минификацию для того же корректного ввода, форма результата изменится на компактный XML без комментариев и пробелов между тегами.

Если исходное поле содержит только пробелы, ожидайте успешный пустой вывод, а не диагностический отчёт о структуре. Для непустого текста также действует проверка размера и разбор XML, поэтому отсутствие результата может быть связано с превышением допустимого объёма или некорректным синтаксисом. Эти границы помогают правильно читать итог: форматировщик меняет представление XML, но не заменяет отдельную проверку его бизнес-логики или содержимого.

Практический пример

Вы проверяете XML-ответ сервиса, который записан в одну строку и содержит несколько уровней вложенности.

Вставьте непустой корректный XML-ответ с несколькими вложенными элементами и комментариями, выберите форматирование с отступами и задайте ширину 4. Затем отдельно обработайте тот же исходный текст в режиме минификации.

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

Ограничения

Для непустого ввода действует ограничение 1 000 000 байт UTF-8, значение должно быть строкой, а пустой или пробельный текст обрабатывается отдельно и даёт пустой результат.

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

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

Частые вопросы

Как сделать XML читаемым?

Для читаемого результата оставьте режим форматирования с отступами. По умолчанию используется ширина 2 пробела, а для непустого XML можно задать значение от 0 до 8.

Удаляет ли минификация XML комментарии и пробелы?

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

Что произойдёт с пустым или большим XML-файлом?

Пустой или состоящий только из пробелов текст возвращает успешный пустой вывод. Для непустого текста размер больше 1 000 000 байт UTF-8 отклоняется.