java - 如何使用 Java 将换行符添加到 XML 文件中？

Question

如何在“请勿编辑此文件”注释后添加换行符？我尝试添加带换行符的文本节点，但它不起作用。

代码:

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 org.w3c.dom.Document;
import org.w3c.dom.Element;

public class Main {
    public static void main(String[] args) {
        try {
            final Document doc = DocumentBuilderFactory.newInstance().
                    newDocumentBuilder().newDocument();

            doc.appendChild(doc.createComment(" DO NOT EDIT THIS FILE "));

            final Element rootElement = doc.createElement("projects");
            doc.appendChild(rootElement);

            final Transformer transformer = TransformerFactory.newInstance().newTransformer();
            transformer.setOutputProperty(OutputKeys.INDENT, "yes");
            transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");
            transformer.transform(new DOMSource(doc), new StreamResult(new File("C:/abc.xml")));
        } catch ( Exception e ) {
            e.printStackTrace();
        }
    }
}

输出:

<!-- DO NOT EDIT THIS FILE --><projects/>

Answer 1

当我运行你的代码时，我也有一个空行。您是在编辑器中查看文件，还是解析并显示文件？ 我问是因为如果是这种情况，xml:space="preserve"设置在您的解析器代码中可能会出现问题。

另一种选择是将注释放在 XML 根元素本身中:

        final Element rootElement = doc.createElement("projects");
        doc.appendChild(rootElement);
        rootElement.appendChild(doc.createComment(" DO NOT EDIT THIS FILE "));

在几个方面，这更具互操作性。例如，假设您使用 xinclude 将 then 嵌入到文件的最终版本中。您在问题中的方式不包括不编辑文件的通知。如果将它放在根元素中，它会(并且您可能应该将其更改为说明不编辑此项目元素的内容，而不是出于同样的原因说明文件)。