使用Java解析时如何在文档元素之前保留空格？

Question

在我的应用程序中，我更改了 XML 文件的某些部分，其开头如下：

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id: version control yadda-yadda $ -->

<myElement>
...

注意<myElement> 之前的空行。加载、修改、保存后，效果差强人意：

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id: version control yadda-yadda $ --><myElement>
...

我发现注释和文档节点之间的空格（一个换行符）根本没有在 DOM 中表示。以下独立代码可靠地重现了该问题：

String source =
    "<?xml version=\"1.0\" encoding=\"UTF-16\"?>\n<!-- foo -->\n<empty/>";
byte[] sourceBytes = source.getBytes("UTF-16");

DocumentBuilder builder =
    DocumentBuilderFactory.newInstance().newDocumentBuilder();
Document doc =
    builder.parse(new ByteInputStream(sourceBytes, sourceBytes.length));

DOMImplementationLS domImplementation =
    (DOMImplementationLS) doc.getImplementation();
LSSerializer lsSerializer = domImplementation.createLSSerializer();
System.out.println(lsSerializer.writeToString(doc));

// output: <?xml version="1.0" encoding="UTF-16"?>\n<!-- foo --><empty/>

有人知道如何避免这种情况吗？本质上，我希望输出与输入相同。 （我知道 xml 声明将被重新生成，因为它不是 DOM 的一部分，但这不是问题。）

Answer 1

一般来说，空白在 XML 中被认为是不相关的，因此在解析 XML 文件时不会保留。大多数输出​​ XML 的库都可以选择以良好的格式和正确的缩进输出它，但它总是相当通用的。没有“在这里有一个额外的行”。

Answer 2

为什么要避免这种情况？

标签/元素之外的空白被规范定义为无关紧要。就您的 DOM 所代表的信息集而言，它根本不存在。

因此，在再次序列化 DOM 时，它将不存在。

如果您正在开发依赖于这个空行的东西......不要。

Answer 3

我遇到了同样的问题。我的解决方案是编写自己的 XML 解析器：DecentXML

主要特点：它可以 100% 保留原始输入，空白，实体，一切。它不会打扰你的细节，但如果你的代码需要像这样生成 XML：

 <element
     attr="some complex value"
     />

那么你就可以了。

Answer 4

我同意 Kris 和 Tomalak 的观点，从 XML 的角度来看，空行是不相关的。如果您的应用程序需要在输出中生成一个空行，我建议您查看该要求的需要。

无论如何，如果您仍然希望显示该空白行，我建议您下载您正在使用的 XML 解析器的源代码并修改该行为。但请记住，这不是标准 XML，它不会与其他应用程序兼容。

• Jdom Source
• Dom4j Source检查org.dom4j.io.DOMWriter

Answer 5

根本原因是标准DOM Level 3 无法在不违反规范的情况下将文本节点表示为文档的子节点。任何兼容的解析器都会删除空格。

Document -- 
    Element (maximum of one),
    ProcessingInstruction,
    Comment,
    DocumentType (maximum of one)

如果您需要符合标准的解决方案并且目标是可读性而不是 100% 可复制，我会在您的输出机制中寻找它。