Форматировать XML

Почему переформатировать XML рискованнее, чем кажется

Пробелы в XML по умолчанию значимы, и именно на этом многие попадаются. В отличие от JSON, где форматирование ничего не меняет, XML-парсер обязан сообщать о пробелах и переводах строк между элементами как о текстовом содержимом — и только схема, если она есть, говорит, что их можно игнорировать. Поэтому новые отступы действительно меняют документ. Для большинства конфигурационных файлов и файлов с данными это неважно, а в документах со смешанным содержимым — где текст и элементы стоят рядом, как в XHTML или DocBook, — это может изменить смысл написанного.

Поэтому форматирование здесь не трогает то, что трогать нельзя. Элемент с атрибутом xml:space="preserve" сохраняет содержимое в точности как написано — этот атрибут для того и существует. Секции CDATA передаются без изменений: они предназначены для текста, который нельзя интерпретировать, и переформатирование внутри них его испортит. Ссылки на сущности остаются ссылками и не раскрываются в символы, которые они обозначают.

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

При форматировании проверяется корректность синтаксиса (well-formedness): все теги закрыты и правильно вложены, корневой элемент один, символы допустимы, амперсанды и угловые скобки экранированы. Это нижняя из двух планок XML. Документ может быть синтаксически безупречным и всё равно не соответствовать своему DTD или схеме — и никакое форматирование этого не покажет.

Если нужно другое

xmllint --format in.xml делает то же самое в командной строке и уже установлен в большинстве Unix-систем; xmlstarlet fo --indent-tab даёт больше контроля над самими отступами. Оба справляются с файлами гораздо больше тех, что страница может удержать в памяти.

Если документ нужно сравнивать, подписывать или хранить в каноническом виде, форматирование — вообще не та операция. Каноническая форма XML — xmllint --c14n — даёт единственный нормализованный вид, к которому сводятся два эквивалентных документа; на нём держатся цифровые подписи XML. Красивое форматирование подписанного документа ломает подпись — и это самый дорогой способ об этом узнать.