Как избежать лишних пустых строк при генерации XML с Java?

Question

В настоящее время я пытаюсь разработать код с библиотеками Java 9 и javax.xml (обе обязательны для моей задачи), который редактирует файл 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>

Это XML, сгенерированный после запуска программы 2 раза. Как вы можете видеть, он добавляет пустые строки перед узлами <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++;
}

1-е выполнение:

Node text content: 

Node text content: namelastnameusername

2-е выполнение:

Node text content: 


Node text content: 
        name
        lastname
        username

Node text content: 

Node text content: namelastnameusername

3-е выполнение

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

ваше решение и приведенные ниже предложения работают для меня нормально, попробуйте этот тестовый пример,

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;

Answer 2

Я подозреваю, что это Трансформер, который добавляет пустые строки.

Вместо использования преобразователя по умолчанию (transformerFactory.newTransformer()) попробуйте передать XSLT, для которого установлено xsl:strip-space (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 3

Короче говоря: На самом деле, в 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 это добавит две новые строки для каждого нужного элемента с отступом, в результате появятся пустые строки.