初めてXMLが私の午後を台無しにしそうになったとき、それは支払いゲートウェイからのSOAP応答でした 1 行 11,000 文字 改行なし、インデントなし、私の端末が読めないレンガに包まれた角括弧の途切れることのない壁がある場所には、署名の不一致を引き起こす単一の間違った要素があり、私はそれを目で見つけることになっていた それ以来、私はたくさんのものを構築しました - WordPressプラグイン、Laravel API、 [Toolz.dev] (/ - そして、私はあなたがあなたの後ろに締め切りのあるタグの壁を見つめている瞬間まで、あなたが感謝しないそれらの静かなユーティリティの1 つであることを伝えることができます。
このガイドは、その日の午後に私が持っていればよかったものです。 XMLフォーマッタが実際に何をするのか、美化とミニ化が表裏一体である理由、フォーマットを安全にする空白ルール、ほぼすべての" why won' t this parse" moment.の検証エラーの一握りについて、XMLフォーマッタが無料でブラウザでフォローできます XML フォーマッタ - 完全にマシン上で実行されるため、支払いペイロードであってもラップトップから離れることはありません。
tl;dr: XML フォーマッタはドキュメントを書き直します'重要ではない空白 - スペース 間に タグ - その意味に触れることなく Beautify は改行とインデントを追加して階層を読み込めるようにします; minify はファイルをできるだけ小さくできるようにそのすべてをストリップします。 good formatter はコメント、CDATA、XML 宣言、属性順序を保持し、途中で整形式 (一致するタグ、閉じた要素、終端セクション) を検証します でないよ ドキュメントを DTD または XSD スキーマと照合します。これは別のジョブです。
XMLフォーマッタは実際に何をしますか?
空白は書式設定が興味深いところだからです XML 1.0 パーサーが要素内のすべての文字をアプリケーションに渡す必要があります - そのため、フォーマッターは何に触れても安全かを知る必要があります。 XMLフォーマッターは、その中核で、ドキュメントをノードのツリー (要素、テキスト、コメント、CDATAセクション、処理命令) に解析し、そのツリーを一貫した間隔でシリアライズして戻します。その往復が全体のトリックです。ツールは、ブラインド検索と置換を行うのではなく構造を理解しているため、深くネストされたツールをインデントできます <order><items><item> 正しくチェーンし、各兄弟を独自の行に置き、その中のテキストを知っています <price>44.95</price> 3 つにまたがるのではなく、タグと同じ線上に留まる必要があります。
これが重要な理由は、XML 仕様に埋められているルール、つまり要素間の空白のほとんどに帰着します 取るに足らない。 パーサが読み込むとき <a>\n <b/>\n</a>、 改行 と スペース 周辺 <b/> 人間用でデータを持ち込まないもの フォーマッタはその空白を自由に追加、削除、変更することが許されています 決して触れてはいけないのは 重大な ホワイトスペース - テキスト ノード内の文字 <note>Call me at 9am</note>、またはCDATAブロック内の何か - そのコンテンツは実際のデータであるため フォーマット決定ごとに XML フォーマッタ そのラインを尊重することで流れを生み出します。
したがって、美化することは化粧品の綿毛ではありません。その 11,000 文字の SOAP ブリックを再インデントすると、要素の階層が表示され、突然配置が間違います <Amount> ノードの 3 レベルが深すぎることは明らかです。フォーマットは、読みやすさと同じくらいデバッグ ツールです。
XML を美化する代わりにミニファイするのはなぜですか?
Beautify と minify は、反対方向を向いた同じエンジンです。 Beautify は人間のために空白を追加します。 minify は機械のために削除します。 minify は、サイズや輸送が問題になったときに手を伸ばします。モバイル アプリ バンドル内に同梱されている構成ファイルを縮小したり、低速接続に移行する前にリクエスト本文をトリミングしたり、ドキュメントを正規化して 2 つのバージョンをバイト単位で比較したりできます。インデントノイズが邪魔になることはありません。
節約は現実的ですが、劇的なことはほとんどありません。 XML's の冗長性は、空白ではなく、繰り返されるタグ名に存在するため、ミニファイは通常、元のインデントがどの程度大きくないかに応じて 5 ～ 20 パーセントの間のトリミングを行う価値があります。ただし、本格的な圧縮が必要な場合は、ワイヤ上の gzip の方がはるかに多くの機能を実行します。ミニファイ化してから gzipping するのが、多くの API で使用されているベルト アンド ブレースのアプローチです。
ツールをどの方向に向けるかを決めるときに使うメンタルモデルは次のとおりです:
| 状況 | 美化する | ミニファイ |
|---|---|---|
| 応答を目で読み取りまたはデバッグします | はいって | いやー |
| コンフィグファイルをバージョン管理にコミットする | はい (clean diffs) | いやー |
| XML をアプリ バンドル内またはネットワーク経由で出荷します | いやー | はいって |
| 多くの小さなドキュメントをデータベース列に保存します | いやー | はいって |
| バイトごとの差分のドキュメントを準備します | いずれか、一貫して | いずれか、一貫して |
| XMLを別の開発者に渡す | はいって | いやー |
重要な規律は一貫性です。 2 つのドキュメントを差分する場合は、実行します 両方 最初に同じオプションを使用して同じモードを使用します。そうでない場合は、コンテンツではなくインデント スタイルを比較します。
フォーマットはどのように私のデータを変更しないようにしますか?
これは、すべてのフォーマッタが過去にその道を獲得しなければならない不安です。 "このツールが私の XML を書き換えた場合、それが静かに何かを壊さなかったとどうやってわかるでしょうか?"正直な答えは、よく構築されたフォーマッタはタグ間の空白を変更するだけで、4 つのことが厳密に単独で残されるということです。
1 つ目は テキスト内容.要素内の文字は逐語的にコピーされる.これには実体 - リテラルが含まれる. & 滞在 &、それは決して役に立つようにデコードされません & (無効な XML が生成される) または二重エンコードされます &amp;。 ザ・ XML フォーマッタ テキストを不透明として扱うのは、まさにあなたが望むことです。
2 つ目は CDATA セクション。 あ <![CDATA[ ... ]]> ブロックは正確に存在するため、エスケープされていない生のコンテンツ (JavaScript のスニペット、HTML の塊、文字列が満載) をドロップできます < あんど & ーエスケープせずに XML ドキュメントに フォーマッターは、ブロック内でエスケープも再インデントもせず、見つけたとおりにそのコンテンツを発します。
3 つ目は コメントと宣言。 コメント ()<!-- ... -->）、 <?xml version="1.0"?> 宣言、および任意の処理命令は保存され、賢明に配置されます。無駄のないファイルが必要な場合はコメントを削除することを選択できますが、それはあなたの決定であり、ツールが背後で行うことではありません。
4つ目は 属性順と引用XML 仕様では属性順序が重要ではないものとして扱われ、それをチャーンする理由がないので、デフォルトでは、フォーマッタは、あなたが使用した引用文スタイルで、あなたが書いた順序で属性を保持するとき する 正規の順序が必要です - よりクリーンな差分、または同じ属性を異なる順序で持つ 2 つの要素を比較するには - a "属性"を並べ替えます。オプションを使用すると、アルファベット順に並べられます。
これはすべてJavaScriptでクライアント側で実行されるため、プライバシーの配当もあります: 接続文字列、内部識別子、または顧客記録でいっぱいのドキュメントは、自分のマシンでフォーマットされ、アップロードされることはありません他の人から作業データをオフに保つことを気にする場合& #39; sサーバー - そして、あなたはする必要があります - そのモデルは理解する価値があり、私はそれについて詳しく書きました オンラインツール向けデータプライバシーガイド。
フォーマッタはどのような XML エラーをキャッチしますか?
フォーマッタが何かをきれいに印刷する前に、ドキュメントを解析する必要があり、有用な検証が行われるのは解析です。これは 整った形状 すべての XML ドキュメントが従わなければならない構造ルールをチェックすると、私の経験では 3 つの間違いが障害の圧倒的多数を占めます。
これまでのところ最も一般的なのは a です ベア アンパサンド. XML 予備 & エンティティを開始するには、raw を開始します & テキストで - のような URL を介して忍び込む種類 ?a=1&b=2 または "Marks & Spencer" - のような会社名により、パーサーがエンティティ名を期待し、エンティティ名が見つからない場合はチョークします。 fix は、エンティティ名を記述することです &、および良いエラーメッセージは、ラインであなたを指し示すので、盲目狩りではありません。
2 つ目はaです タグが一致しないか、閉じられていない。 a を開く <div> そしてそれを閉じます </section>、またはaを開きます <span> そして決して閉じてはならず、文書はもはや整形式ではありません。 formatter は解析時に open-element スタックを追跡するため、どのタグが closed と見込まれ、どのタグが実際に見つかったかを正確に伝えることができます。その単一のメッセージ - " expected </book> しかし、見つかりました </author> 行14&引用; - は通常、問題を数秒で解決するのに十分です。
3番目は、 未終了区間: で開かれたコメント <!-- それは決して届きません -->、または決して到達しないCDATAブロック ]]>。これらは、手編集しているときに簡単に作成でき、少し削除しすぎます。ここでも、フォーマッタは暴走セクションが始まった行を報告します。
フォーマッタが行うこと でないよ ドキュメントをスキーマに対してチェックすることです。 well-formedness asks "is this structurally valid XML?" Validity asks "does this XML follow the rules of 私の特に dotd または XSD で定義されているドキュメント タイプ - 適切な要素を適切な順序で、適切なデータ型で -?"これらは別個のレイヤーです。ドキュメントは完全に適切に形成されていても、意図された目的にはナンセンスである可能性があります。スキーマの検証にはスキーマが必要ですが、これは別のツールです。フォーマッタは最初のレイヤーを保証します。これはパーサーのクラッシュを停止します。
エディタで XML をフォーマットしたり、パイプラインを構築したりするにはどうすればよいですか?
ブラウザ ツールは 1 回限りのドキュメントの最速パスですが、そのジョブに適したドキュメントを選択できるように、代替手段を知る価値があります。
ほとんどのエディタは XML をネイティブにフォーマットします。 VS Code では、組み込みの "Format Document" コマンド (Shift+Alt+F) が XML を処理し、Red Hat's XML 言語サーバーのような拡張機能は、スキーマ認識形式を上部に追加します。 IntelliJ とその兄弟は、Ctrl+Alt+L で再フォーマットします。これらは、ファイルが目の前にすでに開いている場合に最適です。
コマンドラインでは、 xmllint --format file.xml (ほとんどの Unix システムに同梱されている libxml2 の一部) が美化されます xmllint --noblanks file.xml ミニファイド出力に近づけます。 Node プロジェクトでは、ライブラリが次のようにします xml-formatter や prettier XML プラグイン スロットを使用してビルド ステップを実行します。 Python 開発者は、次のことに手を伸ばします xml.dom.minidom.parseString(s).toprettyxml()ただし、既存の空白の周囲に余分な空白行を追加することで悪名高いので注意してください。
では、なぜ を使用するのか XML フォーマッタ まったく? 3 つの理由私は戻って来る.それはインストール、構成、およびプロジェクトを必要としません - あなたは貼り付け、行きます.XMLがおもちゃの例ではなく、実際のペイロードである場合に重要なあなたのマシン上のデータを保持し、それは自然に隣接するツールとペアになります: あなたのXMLがきれいで有効になったら、それをJSONに変換します XML から JSON へのコンバー ワンクリックで、逆のトリップが行われます JSON から XML へ 同じ規約を使います. もしあなたの日がほとんどJSONなら, JSON フォーマッタ はその形式に相当し、家族全員がカタログ化されています Web 開発者ツールキット。
XML をフォーマットするか変換するかはいつですか?
これに慣れていない人から得た質問: JSON の方が読みやすいのであれば、なぜ XML を変換するだけでなくフォーマットするのでしょうか? 答えは、フォーマットと変換によってさまざまな問題が解決されるということです。
必要なときにフォーマットします 保つ XML - SOAP エンドポイントが要求するため、RSS または Atom フィードが定義上 XML であるため、構成ファイル、Android レイアウト、または Maven が必要であるため pom.xml simply is XML and always will be.書式設定すると、XMLのままにしておくと、そのXMLが読みやすくなったりコンパクトになったりします。 downstreamでは何も変更する必要はありません。
変換したいときに変換します 別の形式でデータを操作します - 値を JavaScript のフロントエンドに引き込む、JSON を話すシステムにフィードをロードする、または複数のソースを 1 つの形状に正規化する。変換すると形式が変更され、それに伴い忠実度の一部も変更されます。XML 属性、混合コンテンツ、要素の順序にはクリーンな JSON 相当物がないため、コンバーターは意図的な選択を行います (属性は接頭辞付きキーになり、繰り返されるタグは配列になります)。これらに依存する前に理解しておく必要があります。
私の経験則: フォーマットファースト、常に.クリーンで検証されたドキュメントは、次のステップが編集、差分、または変換であるかどうかについて推論するのが簡単です.フォーマットは、安価で安全なロスレス操作です; 変換は、構造が健全であるとわかると、損失の多いものです.サイトマップは、変換ではなくフォーマットするXMLの好例です - あなたが構築している場合、専用 サイトマップ ジェネレーター 有効で整形式の出力を直接生成します。
よくある質問
XML をオンラインでフォーマットするにはどうすればよいですか?
XML を入力パネルに貼り付け、[Beautify] を選択し、インデント幅を選択して [フォーマット] をクリックします。 ツールは、ドキュメントを解析して再インデントし、結果をコピーまたはダウンロードできます。 すべての処理はブラウザで行われます。何もアップロードされません。
XML の美化と小型化の違いは何ですか?
美化すると改行やインデントが追加されるため、要素階層が読みやすくなり、編集やデバッグに最適です。最小化すると、タグ間の空白がすべて削除され、可能な限り最小のファイルが生成されます。これは、ストレージまたはネットワーク経由での送信に最適です。両方とも document's の意味を保存します。
フォーマットすると、私の XML の意味が変わりますか?
いやー 。 タグ間の空白のみが変更されます。要素、属性、テキスト コンテンツ、コメント、および CDATA は変更されません。 テキスト ノードと CDATA 内の重要な空白は保持されるため、整形式のドキュメントは、フォーマット前後と同じように動作します。
コメントと CDATA セクションは保存されていますか?
はい。 comments、CDATA セクション、XML 宣言、処理命令はすべて保持されます。 comments は、それらが一緒に置かれている要素と一緒にインデントされ、CDATA コンテンツはエスケープせずにそのまま送信されます。 leaner 出力が必要な場合は、コメントをストリップすることを選択することもできます。
このツールは私の XML を検証できますか?
はい。 フォーマットする前に、ドキュメントが完全に解析され、構造上の問題 (閉じられていない要素、最初のタグと一致しないクローズ タグ、または終了していないコメントまたは CDATA セクション) が行番号で報告されるので、すばやく修正できます。 DTD または XSD スキーマに対して有効性ではなく、整形式をチェックします。
XML でフォーマットに失敗するのはなぜですか?
ほとんどすべての失敗は整形式のエラーです。最も一般的なのは、テキスト内の裸のアンパサンド (エンティティとして記述するか、パーサーがエンティティの開始点として読み取る必要があります)、閉じる要素と一致しない終了タグ、および開かれるが決して閉じられない要素です。エラー メッセージは行を指すため、すぐにジャンプできます。
機密データを含む XML をフォーマットしても安全ですか?
はい。 パーサーは、ブラウザーで JavaScript で完全に実行されます。ネットワーク リクエストはデータを運びません。ログに記録されたり保存されたりすることはなく、ロードされた後、ツールはオフラインで動作します。 XML を保持している API キー、接続文字列、または顧客レコードは、マシンから離れることはありません。
その後、フォーマットされた XML を JSON に変換できますか?
はい。 XML がクリーンで有効になると、XML から JSON へのコンバータによって同等の JSON に変換され、属性がプレフィックスキーに、タグが繰り返し配列にマッピングされます。 最初にフォーマットすると構造が明白になり、変換前にどのようにマッピングされるかを理解するのに役立ちます。
Litonによって書かれた - Toolz.dev、WP Adminify、LaravelとReactプロジェクトの長いリストのビルダー ここで言及されているすべてのツールは、 [Toolz.dev] (/) のブラウザで無料で完全に実行されます。
