PHP DOMDocument 怎样保留节点中的空白文本

用 PHP 的 DOMDocument 读取 XML 后，如果发现原来的换行和缩进总是跟着节点走，或者 formatOutput 打开了却没有重新排版，通常不是 saveXML() 失效，而是加载阶段已经决定了 DOM 树要不要保留空白文本节点。

官方地址：https://www.php.net/manual/en/class.domdocument.php

想保留 XML 原有排版，就在加载前保持 preserveWhiteSpace=true；想让后续保存时统一缩进，就在 load() 或 loadXML() 之前设为 false，再配合 formatOutput=true 和 saveXML()。关键顺序是“先决定 DOM 树，再决定输出格式”。

先分清业务文本和排版空白

preserveWhiteSpace 控制的是 XML 元素之间由换行、缩进形成的冗余空白。比如 里的“示例”属于元素内容，不能因为想整理排版就当成冗余空白删除；而 与 之间的换行和空格，才是本文讨论的排版空白。

PHP 官方手册给出的默认值是 true，也就是默认不删除冗余空白。这个默认值适合需要尽量保留原始 XML 的场景，但会让后续的“自动缩进”看起来没有效果：DOM 树里已经有一套空白文本节点，序列化器不会替你把它们全部改成另一套缩进。

在加载 XML 之前设置 preserveWhiteSpace

属性必须在 load() 或 loadXML() 之前设置。下面的例子把 XML 字符串作为输入，并明确选择“去掉元素之间的排版空白”，方便后面统一输出：

示例18
XML;

$dom = new DOMDocument('1.0', 'UTF-8');
// 这个属性要在 loadXML 前设置，否则已有的空白节点不会被追回。
$dom->preserveWhiteSpace = false;

if (!$dom->loadXML($xml)) {
    // 解析失败时不要继续保存半成品，交给调用方处理错误。
    throw new RuntimeException('XML 加载失败');
}

// 由序列化阶段统一添加缩进和换行。
$dom->formatOutput = true;
echo $dom->saveXML();

如果目标是保留原文排版，只需要把加载前的属性改成 true，或者不改默认值：

preserveWhiteSpace = true;

if (!$dom->loadXML($xml)) {
    // 失败就停止后续节点编辑和保存。
    throw new RuntimeException('XML 加载失败');
}

// true 只表示尽量格式化，不会重写已经存在的空白文本节点。
$dom->formatOutput = true;
echo $dom->saveXML();

根据任务选择保留或清理策略

实际项目里不要把 true 或 false 当成“更正确”的固定答案，而要看 XML 的用途：

如果 XML 混合了有意义的文本节点，例如文档正文、混合内容或对空格敏感的内容，就不能仅凭“看起来像缩进”来删除。此时优先保留空白，并把格式化输出限制在明确允许重排的文档范围内。

为什么 formatOutput 打开了仍然不缩进

formatOutput 的作用发生在序列化阶段：它告诉 save() 或 saveXML() 尽量以缩进形式输出当前 DOM 树。它不是解析选项，也不会回到加载阶段删除节点。

因此，下面两件事要分开判断：

• DOM 树中是否已经存在由原始换行和缩进形成的文本节点，由 preserveWhiteSpace 在加载时决定。
• 序列化时是否尝试添加漂亮的缩进，由 formatOutput 决定。

最常见的可控组合是“加载前清理、保存时格式化”：$dom->preserveWhiteSpace = false;，然后调用 load() 或 loadXML()，修改节点，最后设置 formatOutput = true 并调用 saveXML()。如果顺序反过来，已经保留的空白节点仍然属于 DOM 树的一部分，结果就可能出现多余空行、旧缩进和新缩进混在一起。

LIBXML_NOBLANKS 和 preserveWhiteSpace 有什么关系

PHP 官方手册说明，把 preserveWhiteSpace 设为 false，效果等同于给加载方法传入 LIBXML_NOBLANKS。两者表达的是同一个加载阶段决策，但在业务代码里直接写属性通常更容易读出意图：

preserveWhiteSpace = false;
$dom->load($filename);

$dom->formatOutput = true;
// 方式二：加载选项也能表达去除冗余空白的意图。
$other = new DOMDocument();
$other->load($filename, LIBXML_NOBLANKS);
$other->formatOutput = true;

echo $dom->saveXML();
echo $other->saveXML();

同一段代码不要无理由地同时使用两种写法。若要让维护者快速知道“为什么这里会改变空白节点”，保留一种表达即可；更重要的是把它放在加载动作之前。

处理编码、空输入和加载失败

空白策略解决的是 DOM 节点形状，不会替你解决输入编码或 XML 合法性问题。DOMDocument 的 DOM 扩展以 UTF-8 为核心处理编码；外部输入若不是 UTF-8，应在进入 DOM 之前完成明确的编码转换。加载方法返回 false 时，不要继续调用 saveXML() 发布结果。

preserveWhiteSpace = false;

    if (!$dom->loadXML($xml)) {
        // 解析失败时返回明确异常，避免保存不完整文档。
        throw new RuntimeException('XML 不是可加载的文档');
    }

    return $dom;
}

$dom = loadXmlForEditing($xml);
// 统一设置输出策略，避免把解析策略和序列化策略混在一起。
$dom->formatOutput = true;
echo $dom->saveXML();

最后用三句话排查空白问题

1. 先问“我要保留原始排版，还是要重新生成排版”：前者保持 true，后者在加载前设为 false。
2. 再问“属性是不是在 load 或 loadXML 之前设置”：如果已经加载完成，再改属性不能撤销现有空白文本节点。
3. 最后问“我是否在保存时打开了 formatOutput”：它只负责序列化时的缩进尝试，不能替代加载阶段的空白策略。

相关问题

preserveWhiteSpace 默认是什么？

PHP 官方 DOMDocument 手册记载默认值为 true，默认不会移除冗余空白。

只设置 formatOutput 可以吗？

如果原文已经带有空白文本节点，单独设置它往往不能得到统一缩进。需要在加载前设置 preserveWhiteSpace=false，再在保存阶段设置 formatOutput=true。

什么时候不应该清理空白？

当空格、换行本身属于混合内容或业务文本的一部分时，不要为了视觉整齐删除它们；先确认该 XML 的语义允许重排。