В первый раз, когда XML чуть не испортил мой день, это был ответ SOAP от платежного шлюза Одна строка. одиннадцать тысяч символов. Никаких новых строк, никаких отступов, просто непрерывная стена угловых скобок, которые мой терминал завернул в нечитаемый кирпич. Где-то в нем был один неправильный элемент, вызывающий несоответствие подписи, и я должен был найти его на глаз. С тех пор я построил много вещей - плагины WordPress, API-интерфейсы Laravel, инструменты React позади [Toolz.dev](/- и я могу сказать вам, что хороший XML-форматор - одна из тех тихих утилит, которые вы не цените до того момента, пока не уставитесь на стену тегов со сроком позади вас.
Это руководство - то, которое я хотел бы иметь в тот день. оно охватывает то, что на самом деле делает XML-форматер, почему украшение и минификация - это две стороны одной медали, правило пробелов, которое делает форматирование безопасным, и несколько ошибок проверки, которые объясняют почти каждый & quot; почему выиграл & # 39;t этот синтаксический анализ и квота; момент. Вы можете следовать в браузере с бесплатным XML-форматтер - он полностью работает на вашем компьютере, поэтому даже полезная нагрузка платежа никогда не покидает ваш ноутбук.
TL;DR: Форматировщик XML переписывает документ 's незначительное пробелы - пробел между теги - не касаясь его значения. Beautify добавляет разрывы строк и отступы, чтобы вы могли читать иерархию; минифицировать полосы все это, чтобы файл был как можно меньше. хороший форматировщик сохраняет комментарии, CDATA, XML-декларацию и порядок атрибутов, а также проверяет правильность формирования (соответствующие теги, закрытые элементы, завершенные разделы) на своем пути. Это так не сверьте свой документ со схемой DTD или XSD - это другая работа.
Что на самом деле делает XML-форматор?
Пробелы - это то место, где форматирование становится интересным, потому что XML 1.0 требует, чтобы синтаксический анализатор пропускал каждый символ внутри элемента в приложение - именно поэтому форматировщик должен знать, к чему безопасно прикасаться. В своей основе XML-форматор анализирует ваш документ в дереве узлов - элементы, текст, комментарии, разделы CDATA, инструкции по обработке - а затем сериализует это дерево обратно с постоянным интервалом. Этот обходной путь - это весь трюк. Поскольку инструмент понимает структуру, а не выполняет слепой поиск и замену, он может отступать глубоко вложенным <order><items><item> правильно цепочкуйте, поставьте каждого брата на свою линию и знайте, что текст внутри <price>44.95</price> должен оставаться на той же линии, что и его теги, а не растягиваться на три.
Причина, по которой это имеет значение, сводится к правилу, заложенному в спецификации XML: большая часть пробелов между элементами такова незначительный. Когда синтаксический анализатор читает <a>\n <b/>\n</a>, новые линии и пространства вокруг <b/> существуют ли для людей и не несут никаких данных. Форматировщику разрешено свободно добавлять, удалять или изменять эти пробелы. Чего он никогда не должен касаться, так это того, что он никогда не должен касаться значимый пробелы - символы внутри текстового узла, например <note>Call me at 9am</note>или что-то внутри блока CDATA - потому что этот контент представляет собой реальные данные. Каждое решение о форматировании XML-форматтер делает потоки от соблюдения этой линии.
Так что украшать - это не косметический пух. когда вы повторно отступаете к этому кирпичу SOAP, состоящему из одиннадцати тысяч символов, иерархия элементов становится видимой, и внезапно неуместно <Amount> слишком глубокий уровень узла три очевиден.Форматирование - это инструмент отладки, а также инструмент читаемости.
Зачем мне минифицировать XML вместо того, чтобы украшать его?
Украсить и минифицировать - это один и тот же движок, направленный в противоположных направлениях. Beautify добавляет пробелы для людей; minify удаляет его для машин. Вы тянетесь к minify, когда размер или транспорт имеют значение: сокращение файла конфигурации, который отправляется внутри пакета мобильных приложений, обрезка тела запроса перед его медленным соединением или нормализация документа, чтобы две версии можно было сравнивать байт за байт без помех шуму отступов.
Экономия реальна, но редко драматична. Многословие XML и #39;s живет в повторяющихся названиях тегов, а не в пробелах, поэтому минификация обычно обрезает где-то от пяти до двадцати процентов в зависимости от того, насколько сильно отступы были в оригинале. Это стоит иметь, но если вам нужно серьезное сжатие, gzip на проводе делает гораздо больше - минификация, а затем gzipping - это подход, который используют многие API.
Вот ментальная модель, которую я использую при принятии решения о том, каким способом направить инструмент:
| положение | окрашивать | минимизировать |
|---|---|---|
| Чтение или отладка ответа на глаз | да | нет |
| Введение файла конфигурации в управление версиями | Да (чистые различия) | нет |
| Доставка XML внутри пакета приложений или по сети | нет | да |
| Хранение множества небольших документов в столбце базы данных | нет | да |
| Подготовка документа для байт-для-байт-разница | То ли, последовательно | То ли, последовательно |
| Передача XML другому разработчику | да | нет |
Ключевая дисциплина - последовательность. Если вы распространяете два документа, запустите оба сначала через один и тот же режим с теми же параметрами - в противном случае вы сравниваете стили отступов, а не содержимое.
Как форматирование позволяет избежать изменения моих данных?
Это беспокойство, которое каждый форматировщик должен заслужить: & quot; если этот инструмент переписывает мой XML, откуда я знаю, что он не сломал что-то незаметно? & quot; Честный ответ заключается в том, что хорошо построенный форматировщик меняет пробелы только между тегами и оставляет четыре вещи строго в покое.
Первый есть текстовое содержимое. Символы внутри элемента копируются дословно. Это включает в себя сущности - литерал & остается &он никогда не декодируется с пользой & (что приведет к недопустимому XML) или двойному кодированию &amp;, йо- выше XML-форматтер относится к вашему тексту как к непрозрачному, что именно вам и нужно.
Второй есть Разделы CDATA, йо- равняется <![CDATA[ ... ]]> блок существует именно для того, чтобы вы могли удалить необработанный, неэкранированный контент - фрагмент JavaScript, фрагмент HTML, строку, полную < а & - в XML-документ, не ускользая от него. Форматировщик излучает этот контент точно так, как нашел, без экранирования и повторного отступа внутри блока.
Третий есть комментарии и декларация. Комментарии (<!-- ... -->), <?xml version="1.0"?> объявление, и любые инструкции обработки сохраняются и помещаются разумно. вы можете выбрать, чтобы удалить комментарии, когда вы хотите более компактный файл, но это ваше решение, а не то, что инструмент делает за вашей спиной.
Четвертый - это порядок атрибутов и цитирование. По умолчанию форматировщик сохраняет ваши атрибуты в том порядке, в котором вы их написали, с использованием используемого вами стиля котировок, поскольку спецификация XML рассматривает порядок атрибутов как незначительный, и нет причин его сбивать. Когда вы вести себя хотите канонический порядок - для более чистых различий, или для сравнения двух элементов, которые несут одни и те же атрибуты в разных порядках - & quot;sort атрибуты& quot; опция размещает их в алфавитном порядке для вас.
Поскольку все это работает на стороне клиента в JavaScript, существует также дивиденд конфиденциальности: документ, полный строк подключения, внутренних идентификаторов или записей клиентов, форматируется на вашей машине и никогда не загружается. Если вы заботитесь о том, чтобы не допускать использования рабочих данных на других серверах людей и #39;s - и вы должны - эту модель стоит понять, и я написал об этом больше в руководство по конфиденциальности данных для онлайн-инструментов, йо-
Какие ошибки XML улавливает форматировщик?
Прежде чем форматировщик сможет что-либо напечатать, ему необходимо проанализировать документ, и анализ - это то, где происходит полезная проверка. Это хорошо сформированность проверка - структурные правила, которым должен подчиняться каждый XML-документ - и, по моему опыту, подавляющее большинство сбоев связано с тремя ошибками.
Самым распространенным на сегодняшний день является а голый амперсанд. XML-резервы & чтобы начать сущность, то есть сырой & в тексте - тот, который пробирается через URL-адрес ?a=1&b=2 или название компании, как & quot;Marks & amp; Spencer& quot; - заставляет парсера ожидать имя сущности, а затем подавиться, когда он не находит его. исправление заключается в том, чтобы написать &, и хорошее сообщение об ошибке укажет вам на линию, чтобы вы не охотились вслепую.
Второй - а несоответствующий или незакрытый тег. Открыть а <div> и закрыть его </section>или открыть а <span> и никогда не закрывать его вообще, и документ больше не является хорошо сформированным Форматировщик отслеживает стек открытых элементов, когда он анализирует, поэтому он может точно сказать вам, какой тег он ожидал увидеть закрытым и какой он действительно нашел Это единственное сообщение - & quot;ожидается </book> но нашёл </author> в строке 14" - обычно достаточно, чтобы решить проблему за секунды.
Третий - ан незавершенный раздел: комментарий, открытый с <!-- это никогда не достигает -->или блок CDATA, который никогда не достигает ]]>. Их легко создать, когда вы редактируете вручную и удаляете слишком много. Опять же, форматировщик сообщает строку, с которой начинался сбежавший раздел.
Что делает форматировщик не сверяйте свой документ со схемой. Хорошо сформированный спрашивает & quot; является ли этот структурно действительный XML? & quot; Срок действия спрашивает & quot; следует ли этот XML правилам мой конкретный тип документа - правильные элементы, в правильном порядке, с правильными типами данных - как определено DTD или XSD?" Это отдельные слои. документ может быть идеально хорошо сформирован и при этом быть ерундой по назначению. для проверки схемы нужна схема, и это другой инструмент. Форматировщик гарантирует первый уровень, который останавливает сбой вашего парсера.
Как мне отформатировать XML в моем редакторе или конвейере сборки?
Инструмент браузера - самый быстрый путь для разового документа, но стоит знать альтернативы, чтобы выбрать подходящий для этой работы.
Большинство редакторов форматируют XML изначально.В VS Code встроенный & quot;Format Document& quot; команда (Shift+Alt+F) обрабатывает XML, а расширения, такие как Red Hat's XML языковой сервер добавляют сверху форматирование с учетом схемы. IntelliJ и его братья и сестры переформатируются с Ctrl+Alt+L. Они идеально подходят, когда файл уже открыт перед вами.
В командной строке, xmllint --format file.xml (часть libxml2, которая поставляется в большинстве систем Unix) украшает, и xmllint --noblanks file.xml приближает к минифицированному выводу. в проекте Node библиотеки, как xml-formatter или prettier с слотом плагина XML на этапе сборки. разработчики Python стремятся к xml.dom.minidom.parseString(s).toprettyxml()хотя будьте осторожны, он известен тем, что добавляет дополнительные пустые строки вокруг существующих пробелов.
Так зачем же использовать XML-форматтер вообще? Три причины, по которым я продолжаю возвращаться. Он не нуждается ни в установке, ни в конфигурации, ни в проекте - вы вставляете и уходите. Он сохраняет данные на вашей машине, что имеет значение, когда XML является реальной полезной нагрузкой, а не примером игрушки. И он естественным образом соединяется с соседними инструментами: как только ваш XML станет чистым и действительным, преобразуйте его в JSON с помощью XML в JSON конвертер это один клик, а обратный ход json в xml использует те же соглашения. если ваш день в основном JSON, Форматтер JSON является эквивалентом этого формата, и вся семья каталогизирована в Набор инструментов для веб-разработчиков, йо-
Когда мне следует форматировать или конвертировать свой XML?
Вопрос, который я получаю от людей, более новых к этому: если JSON легче читать, почему форматировать XML вместо того, чтобы просто конвертировать его? Ответ в том, что форматирование и конвертация решают различные проблемы.
Форматируйте, когда вам нужно держать XML - потому что этого требует конечная точка SOAP, потому что RSS или Atom-канал по определению является XML, потому что ваш файл конфигурации, ваш макет Android или ваш Maven pom.xml просто XML и всегда будет. Форматирование делает этот XML читаемым или компактным, оставляя его XML. Ничто в дальнейшем не должно меняться.
Конвертировать, когда вы хотите работайте с данными в другом формате - перетягивание значений во внешний интерфейс JavaScript, загрузка канала в систему, говорящую на JSON, или нормализация нескольких источников в одну форму. Преобразование меняет формат, а вместе с ним и некоторые атрибуты XML, смешанный контент и порядок элементов не имеют чистых эквивалентов JSON, поэтому конвертер делает осознанный выбор (атрибуты становятся префиксными ключами, повторяющиеся теги становятся массивами), который вы должны понять, прежде чем полагаться на них.
Мое эмпирическое правило: сначала формат, всегда. чистый, проверенный документ легче рассуждать о том, редактирует ли ваш следующий шаг его, распространяет или преобразует. Форматирование - это дешевая, безопасная операция без потерь; преобразование - это операция с потерями, которую вы делаете, когда знаете, что структура надежна. Карты сайта - хороший пример XML, который вы форматируете, а не конвертируете - если вы его создаете, выделенный генератор карт сайта напрямую производит действительный, хорошо сформированный результат.
Часто задаваемые вопросы
Как отформатировать XML онлайн?
Вставьте XML в панель ввода, выберите Beautify, выберите ширину отступа и нажмите «Формат». Инструмент анализирует документ, повторно отступает в него и позволяет копировать или загружать результат. Вся обработка происходит в вашем браузере - ничего не загружается.
В чем разница между украшением и минимизацией XML?
Украшение добавляет разрывы строк и отступы, поэтому иерархия элементов легко читается, что идеально подходит для редактирования и отладки. минификация удаляет все пробелы между тегами, чтобы создать наименьший возможный файл, который идеально подходит для хранения или отправки по сети. Оба сохраняют документ's значение; изменяется только незначительное пробелы.
Изменяет ли форматирование значение моего XML?
нет , йо- Изменены только пробелы между тегами - элементы, атрибуты, текстовое содержимое, комментарии и CDATA остаются неизменными. Поскольку значительные пробелы внутри текстовых узлов и CDATA сохраняются, хорошо сформированный документ ведет себя одинаково до и после форматирования.
Сохраняются ли разделы комментариев и CDATA?
Да. комментарии, разделы CDATA, XML-декларация и инструкции по обработке сохраняются. Комментарии отступают рядом с элементами, с которыми они сидят, а содержимое CDATA излучается дословно без какого-либо экранирования. вы также можете удалить комментарии, если хотите более экономичный вывод.
Может ли этот инструмент подтверждать мой XML?
да. Перед форматированием документ полностью разобран, а структурные проблемы - незакрытый элемент, закрывающий тег, не совпадающий с его открывающей тег, или раздел непоконченного комментария или CDATA - с номером строки, чтобы вы могли быстро их исправить. Он проверяет правильность, а не валидность для схемы DTD или XSD.
Почему мой XML не может форматировать?
Почти все сбои являются ошибками правильной формы. наиболее распространенными являются голый амперсанд в тексте (он должен быть записан как сущность, или синтаксический анализатор читает его как начало сущности), закрывающий тег, который не соответствует элементу, который он закрывает, и элемент, который открывается, но никогда не закрывается Сообщение об ошибке указывает на линию, чтобы вы могли сразу перейти к ней.
Безопасно ли форматировать XML, содержащий конфиденциальные данные?
да. Парсер полностью запускается в вашем браузере в вашем браузере - ни один сетевой запрос не несет ваши данные, ничего не регистрируется и не сохраняется, а инструмент работает в автономном режиме после загрузки. XML, содержащая ключи API, строки подключения или записи клиентов, никогда не покидает ваш компьютер.
Могу ли я впоследствии преобразовать отформатированный XML в JSON?
да. После того, как XML будет чистым и действительным, конвертер XML в JSON превращает его в эквивалентный JSON, сопоставляя атрибуты с префиксными ключами и повторяющиеся теги в массивы. Форматирование сначала делает структуру очевидной, что помогает вам понять, как она будет отображаться перед преобразованием.
Написано Liton - конструктором Toolz.dev, WP Adminify, и длинным списком проектов Laravel и React.Каждый инструмент, упомянутый здесь, работает бесплатно и полностью в вашем браузере по адресу [Toolz.dev](/.
