XML格式化器
使用清晰的缩进格式化 XML，同时保留元素、属性、文本、注释和转义值。
让 XML 结构更容易阅读
紧凑的 XML 便于传输，却难以检查。当内容全部位于一行时，元素、属性、结束标签或转义字符很难定位。这个 formatter 会展示可读的布局，帮助你在 build、request 或配置流程中使用前检查结构。
格式化改变的是 presentation，不是预期的 XML data。元素名、属性值、文本节点、comment 和 entity reference 应被保留，同时添加一致的 indentation 与 line break。可读结果有助于 review，但不是 schema validation 结果。
学习工具时使用小而有代表性的 sample。将 source document、formatted copy 以及后续 validation result 分开保存，以便区分 XML syntax、schema、encoding 和 application rule。
如果 document 含有 secret 或个人信息，请先创建 redacted copy。Formatting 不会让 data 匿名，也不能证明把它分享给其他 service 是被允许的。
Formatting 和 validation 不同
XML 是一种 nested markup format，包含 element、attribute、text、comment、declaration 和 character reference。Element 需要匹配的 opening 与 closing tag，attribute 属于 opening tag，ampersand 等 reserved character 作为 data 时必须 escape。
Formatter 会读取足够的 structure 来排列 node 和 whitespace。它不能证明 document 符合 XSD、DTD、namespace policy、application contract 或 business rule。请在负责这些规则的 workflow 中单独执行检查。
在某些 XML context 中，whitespace 可能属于 data，尤其是 mixed content 和 text node。修改给 whitespace-sensitive consumer 使用的 document 前，要将 output 与其要求对比，并保留 original source。
格式化 XML 的步骤
- 把完整的 XML document 或 documented fragment 粘贴到 source field。请从 test copy 中删除无关文字和 programming-language wrapper。
- 运行 formatter 并检查 nesting、attribute、comment 和 text value。Formatting failure 不能单独证明某条 parser message。
- 将 formatted document 与 original 对比。Element name、attribute value、entity reference、namespace declaration 和 text data 应保持不变。
- 格式化后运行 project 要求的 XML parser、schema validator 或 application test。Formatting 本身不能证明 validity 或 compatibility。
- 对于 production data，请从 sample 中删除 secret 和个人信息。保留原文件以便进行 controlled diff 和 rollback。
格式化方法
- 读取 XML structure
Tool 将 markup 读取为 nested XML content，并识别可以重新排列的 element、attribute、text、comment 和 declaration boundary。
- 应用 indentation
Formatter 添加 line break 和 indentation 来显示 parent-child 关系。这些 whitespace 属于 presentation，不是新的 schema rule。
- 保留技术值
Attribute text、entity reference、namespace prefix 和 comment content 必须继续与 source sample 对应。Exact bytes 重要时请检查 diff。
Public page document 了 XML formatting input。Exact parser recovery、whitespace policy 和 error wording 需要在真实 engine 中测试。
阅读格式化结果
Successful result 是所提供 XML 的可读排列。请将 tree、value、attribute、comment 和 declaration 与 source 对比。
Failure 表示 documented path 无法处理 input。没有 matching runtime evidence 时，不要推断 exact parser rule 或 error location。
如果 document 之后在 XSD 或 application check 中失败，请检查那个独立 contract。Formatting 不会添加 required element、namespace 或 type。
常见错误
把 indentation 当成 schema validation，可能会忽略缺少的 required element 或 invalid attribute。
用可见字符替换 escaped entity，可能改变 XML data 或使 document invalid。
为了视觉效果排序 attribute 或 child，可能改变 consumer 期待的顺序或 mixed content。
没有必要的 namespace declaration 就复制 fragment，会使 test 不同于 production document。
限制
文档化的能力是 XML formatting。这不能证明 XSD 或 DTD validation、transformation、canonicalization、security analysis 或 application compatibility。
请与 target consumer 一起测试 whitespace-sensitive mixed content、namespace、大型 document 和 parser-specific recovery。
除非 policy 允许，否则不要粘贴 confidential production document。Formatted copy 可能含有相同的 sensitive value。
Examples
格式化简单 element
可以让 compact element 更易读吗？
提交 compact XML。
Child element 会在 note 下方以独立且缩进的 line 显示。
保留 attribute
如何检查带有 attribute 的 element？
提交 element 并查看 opening tag。
id attribute 仍在 user 上，name child 获得缩进。
保留 escaped text
文本中的 entity 会保留吗？
格式化 document 并比较 text node。
Entity reference 仍是 text representation 的一部分。
格式化重复 child
可以清楚地分开 repeated element 吗？
提交包含两个 item child 的 parent。
每个 repeated child 位于自己的 line，顺序更容易 review。
保留 comment
XML comment 会怎样？
格式化 configuration sample。
Comment 保留在 parent 与 mode element 之间。
保留 declaration
XML declaration 如何处理？
一起提交 declaration 和 root element。
Declaration 保留在开头，root content 在下面缩进。
Frequently asked questions
Formatting 会验证 XML schema 吗？
不会。它只整理 XML structure。Schema check 应使用 project 要求的 XSD、DTD 或 application validator。
Formatting 会改变 element value 吗？
它应保留 value 和 structure，只添加 presentation whitespace。Exact text 重要时，请与 original 对比。
Comment 会保留吗？
示例将 comment 作为 formatted view 中保留的 content。放入 pipeline 前请在自己的 input 上确认行为。
可以格式化 XML fragment 吗？
请使用完整 document 或 documented fragment shape。Fragment 可能依赖缺少的 namespace 或 root。
Formatting 会让 XML 更小吗？
不会。为了 readable output 通常会增加 whitespace。需要 compact output 时使用单独的 minifier 或 transport process。
Escaped ampersand 应该怎么处理？
请将 & 这样的 reference 保留为 XML data。如果 context 不再是 valid XML，不要替换成 raw ampersand。
Formatting 会修复 malformed XML 吗？
不要假设存在 automatic repair。请有意修正 source，并运行 application 使用的 parser 和 schema check。
Formatting 之后应该做什么？
检查 diff，运行 parser 或 schema check；如果 whitespace 或 namespace 重要，再用真实 consumer 测试 formatted copy。