如何避免使用 Java 生成 XML 中的额外空行？

Question

目前我正在尝试使用编辑 XML 文件的 Java 9 和 javax.xml 库（这两个库都是我的任务所必需的）开发一些代码，并且在添加子节点时遇到了一些奇怪的问题。

这是 XML 文件：

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<users>
</users>

我想编辑它构建这样的东西：

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<users>
    <user>
        <name>A name</name>
        <last-name>Last Name</last-name>
        <username>username</username>
    </user>
</users>

现在，代码的第一次运行在<user> 节点之前添加了一个空行。当它第二次运行时会填充更多的空白行：

<users>


    <user>

        <name>name</name>

        <last-name>lastname</last-name>

        <username>username</username>

    </user>

    <user>
        <name>name</name>
        <last-name>lastname</last-name>
        <username>username</username>
    </user>
</users>

这是程序运行2次后生成的XML。如您所见，它在 <user> 节点之前和其他节点之间添加了空行，节点之间的 n-1 个空行正好是代码执行次数的 n 次。

在更新文件之前想知道那些节点的内容是什么我写了下一个代码：

int i=0;
while (root.getChildNodes().item(i)!=null){
  Node aux = root.getChildNodes().item(i);
  System.out.println("Node text content: ".concat(aux.getTextContent()));
  i++;
}

第一次执行：

Node text content: 

Node text content: namelastnameusername

第二次执行：

Node text content: 


Node text content: 
        name
        lastname
        username

Node text content: 

Node text content: namelastnameusername

第三次执行

Node text content: 



Node text content: 

        name

        lastname

        username


Node text content: 


Node text content: 
        name
        lastname
        username

Node text content: 

Node text content: namelastnameusername

最后，这是Java代码：

private static void saveUser(String firstName, String lastName, String username){
  DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
    try {
      DocumentBuilder builder = factory.newDocumentBuilder();
      Document doc = builder.parse(new File(databaseFile));
      Element root = doc.getDocumentElement();
      root.normalize();

      // build user node
      Element userNode = doc.createElement("user");
      Element nameNode =  doc.createElement("name");
      Element lastNameNode = doc.createElement("last-name");
      Element usernameNode = doc.createElement("username");

      //build structure
      nameNode.appendChild(doc.createTextNode(firstName));
      lastNameNode.appendChild(doc.createTextNode(lastName));
      usernameNode.appendChild(doc.createTextNode(username));

      userNode.appendChild(nameNode);
      userNode.appendChild(lastNameNode);
      userNode.appendChild(usernameNode);
      root.appendChild(userNode);

      //write the updated document to file or console
      TransformerFactory transformerFactory = TransformerFactory.newInstance();
      Transformer transformer = transformerFactory.newTransformer();
      DOMSource source = new DOMSource(doc);
      StreamResult result = new StreamResult(new File(databaseFile));
      transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
      transformer.setOutputProperty(OutputKeys.INDENT, "yes");
      transformer.transform(source, result);
    }catch (SAXException | ParserConfigurationException | IOException | TransformerException e1) {
      e1.printStackTrace();
    }
}

我能找到的唯一解决方案是在生成 XML 后删除空行，但我认为这不是一个合适的解决方案，我想先找到一些替代方案。

关于如何解决这个问题有什么建议吗？

Answer 1

我怀疑是 Transformer 添加了空白行。

不要使用默认转换器 (transformerFactory.newTransformer())，而是尝试传入一个设置了 xsl:strip-space 的 XSLT (transformerFactory.newTransformer(new StreamSource(new File(PATH_TO_XSLT_FILE)));)...

XSLT 文件

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:output indent="yes"/>
  <xsl:strip-space elements="*"/>

  <xsl:template match="@*|node()">
    <xsl:copy>
      <xsl:apply-templates select="@*|node()"/>
    </xsl:copy>
  </xsl:template>

</xsl:stylesheet>

Answer 2

简而言之： 其实在Java 9中，你可能只会采取在xml生成后或者xml从文件中解析后删除空行的方式，比如：

private void clearBlankLine(Element element) {
    NodeList childNodes = element.getChildNodes();
    for (int index = 0; index < childNodes.getLength(); index++) {
        Node item = childNodes.item(index);
        if (item.getNodeType() != 1 && System.lineSeparator()
            .equals(item.getNodeValue())) {
            element.removeChild(item);
        } else {
            if (item instanceof Element) {
                clearBlankLine((Element) item);
            }
        }
    }
}

然后使用root 元素调用它。

详情：

在xml生成的流程中，每个元素解析有三个生命周期：startElement,parse,endElement。而indent 功能是在startElement 范围内实现的。缩进也会在文档中添加一个空行。

调用栈在java 8和java 9之间不同：

在 Java 8 中：ToStream#startElement-> ToStream#indent(IfNecessary)

在 Java 9 中：ToStream#startElement->ToStream#flushCharactersBuffer(IfNecessary)->ToStream#indent(IfNecessary)

虽然flushCharactersBuffer 在我们打开缩进功能时也会进行缩进，例如：transformer.setOutputProperty(OutputKeys.INDENT, "yes"); 调用方法的条件：flushCharactersBuffer 和方法：indent 几乎相同。

这意味着在 Java 9 中，这将为每个需要缩进的元素添加两个新行，结果出现空行。

Answer 3

您的解决方案和以下建议对我来说都很好，请尝试使用此测试用例，

public static void main(String[] args) {

    saveUser("test one", "test two", "test three");

}

private static void saveUser(String firstName, String lastName, String username){
    DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
    try {
        DocumentBuilder builder = factory.newDocumentBuilder();
        Document doc = builder.parse(new File("second.xml"));
        Element root = doc.getDocumentElement();
        root.normalize();

        // build user node
        Element userNode = doc.createElement("user");
        Element nameNode =  doc.createElement("name");
        Element lastNameNode = doc.createElement("last-name");
        Element usernameNode = doc.createElement("username");

        userNode.appendChild(nameNode).setTextContent(firstName); //set the text content
        userNode.appendChild(lastNameNode).setTextContent(lastName);
        userNode.appendChild(usernameNode).setTextContent(username);
        root.appendChild(userNode);

        //write the updated document to file or console
        TransformerFactory transformerFactory = TransformerFactory.newInstance();
        Transformer transformer = transformerFactory.newTransformer();
        DOMSource source = new DOMSource(doc);
        StreamResult result = new StreamResult(new File("second.xml"));
        transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
        transformer.setOutputProperty(OutputKeys.INDENT, "yes");
        transformer.transform(source, result);

     }catch (Exception e) {
        e.printStackTrace();
     }
}

second.xml（执行前）

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<users>
</users>

second.xml（第一次执行）

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<users>
<user>
<name>test one</name>
<last-name>test two</last-name>
<username>test three</username>
</user>
</users>

second.xml（第二次执行）

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<users>
<user>
<name>test one</name>
<last-name>test two</last-name>
<username>test three</username>
</user>
<user>
<name>test one</name>
<last-name>test two</last-name>
<username>test three</username>
</user>
</users>

second.xml（第三次执行）

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<users>
<user>
<name>test one</name>
<last-name>test two</last-name>
<username>test three</username>
</user>
<user>
<name>test one</name>
<last-name>test two</last-name>
<username>test three</username>
</user>
<user>
<name>test one</name>
<last-name>test two</last-name>
<username>test three</username>
</user>
</users>

导入类，

import java.io.File;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import javax.xml.parsers.DocumentBuilder; // missing import class

import org.w3c.dom.Document;
import org.w3c.dom.Element;