Java生成XML文件的常用方法
在Java开发中，生成XML文件是常见的需求，比如配置文件导出、数据交换格式生成等。Java提供了多种原生API和第三方库来实现XML生成，本文将介绍几种主流的实现方式，并给出对应的代码示例。
一、使用DOM（Document Object Model）方式生成XML
DOM是W3C标准的XML处理模型，Java原生支持DOM API。它的原理是将整个XML文档加载到内存中，构建成树状结构，然后可以动态修改节点内容，最后输出为XML文件。这种方式适合XML结构较小、需要频繁修改节点的场景。
下面是使用DOM生成XML的完整示例，生成一个包含学生信息的简单XML文件：
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import java.io.File;
public class DomXmlGenerator {
public static void main(String[] args) {
try {
// 1. 创建DocumentBuilderFactory实例
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
// 2. 创建DocumentBuilder实例
DocumentBuilder builder = factory.newDocumentBuilder();
// 3. 创建新的Document文档
Document document = builder.newDocument();
// 4. 创建根节点students
Element rootElement = document.createElement("students");
document.appendChild(rootElement);
// 5. 创建第一个student节点
Element student1 = document.createElement("student");
student1.setAttribute("id", "1001"); // 设置节点属性
Element name1 = document.createElement("name");
name1.appendChild(document.createTextNode("张三")); // 设置文本内容
student1.appendChild(name1);
Element age1 = document.createElement("age");
age1.appendChild(document.createTextNode("20"));
student1.appendChild(age1);
rootElement.appendChild(student1);
// 6. 创建第二个student节点
Element student2 = document.createElement("student");
student2.setAttribute("id", "1002");
Element name2 = document.createElement("name");
name2.appendChild(document.createTextNode("李四"));
student2.appendChild(name2);
Element age2 = document.createElement("age");
age2.appendChild(document.createTextNode("22"));
student2.appendChild(age2);
rootElement.appendChild(student2);
// 7. 将Document转换为XML文件输出
TransformerFactory transformerFactory = TransformerFactory.newInstance();
Transformer transformer = transformerFactory.newTransformer();
// 设置输出格式，添加换行和缩进
transformer.setOutputProperty("encoding", "UTF-8");
transformer.setOutputProperty("indent", "yes");
DOMSource source = new DOMSource(document);
StreamResult result = new StreamResult(new File("students_dom.xml"));
transformer.transform(source, result);
System.out.println("DOM方式生成XML文件成功，路径：students_dom.xml");
} catch (Exception e) {
e.printStackTrace();
}
}
}运行上述代码后，会在项目根目录生成students_dom.xml文件，内容如下：
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<students>
<student id="1001">
<name>张三</name>
<age>20</age>
</student>
<student id="1002">
<name>李四</name>
<age>22</age>
</student>
</students>二、使用JDOM方式生成XML
JDOM是专为Java设计的XML解析工具，它简化了DOM的操作，API更符合Java开发者的使用习惯，不需要处理复杂的DOM原生接口。需要注意的是JDOM是第三方库，使用前需要添加对应的依赖，如果是Maven项目，可以添加如下依赖：
<dependency>
<groupId>org.jdom</groupId>
<artifactId>jdom2</artifactId>
<version>2.0.6.1</version>
</dependency>下面是使用JDOM生成XML的示例代码：
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.output.Format;
import org.jdom2.output.XMLOutputter;
import java.io.FileOutputStream;
import java.io.OutputStream;
public class JdomXmlGenerator {
public static void main(String[] args) {
try {
// 1. 创建根节点
Element rootElement = new Element("students");
// 2. 创建第一个student节点
Element student1 = new Element("student");
student1.setAttribute("id", "1001");
student1.addContent(new Element("name").setText("张三"));
student1.addContent(new Element("age").setText("20"));
rootElement.addContent(student1);
// 3. 创建第二个student节点
Element student2 = new Element("student");
student2.setAttribute("id", "1002");
student2.addContent(new Element("name").setText("李四"));
student2.addContent(new Element("age").setText("22"));
rootElement.addContent(student2);
// 4. 创建Document对象
Document document = new Document(rootElement);
// 5. 输出为XML文件
XMLOutputter outputter = new XMLOutputter();
// 设置输出格式，缩进和换行
outputter.setFormat(Format.getPrettyFormat().setEncoding("UTF-8"));
try (OutputStream outputStream = new FileOutputStream("students_jdom.xml")) {
outputter.output(document, outputStream);
}
System.out.println("JDOM方式生成XML文件成功，路径：students_jdom.xml");
} catch (Exception e) {
e.printStackTrace();
}
}
}JDOM的API比原生DOM更简洁，比如设置节点文本直接使用setText方法，添加子节点使用addContent，整体代码可读性更高。
三、使用DOM4J方式生成XML
DOM4J是另一个流行的Java XML处理库，性能优秀，功能丰富，很多开源框架都使用它来处理XML。同样需要添加第三方依赖，Maven依赖如下：
<dependency>
<groupId>dom4j</groupId>
<artifactId>dom4j</artifactId>
<version>2.1.4</version>
</dependency>下面是使用DOM4J生成XML的示例代码：
import org.dom4j.Document;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.XMLWriter;
import java.io.FileOutputStream;
public class Dom4jXmlGenerator {
public static void main(String[] args) {
try {
// 1. 创建Document对象
Document document = DocumentHelper.createDocument();
// 2. 创建根节点
Element rootElement = document.addElement("students");
// 3. 创建第一个student节点
Element student1 = rootElement.addElement("student");
student1.addAttribute("id", "1001");
student1.addElement("name").setText("张三");
student1.addElement("age").setText("20");
// 4. 创建第二个student节点
Element student2 = rootElement.addElement("student");
student2.addAttribute("id", "1002");
student2.addElement("name").setText("李四");
student2.addElement("age").setText("22");
// 5. 输出为XML文件
OutputFormat format = OutputFormat.createPrettyPrint();
format.setEncoding("UTF-8");
try (XMLWriter writer = new XMLWriter(new FileOutputStream("students_dom4j.xml"), format)) {
writer.write(document);
}
System.out.println("DOM4J方式生成XML文件成功，路径：students_dom4j.xml");
} catch (Exception e) {
e.printStackTrace();
}
}
}三种方式的选择建议
- 如果需要避免引入第三方依赖，优先选择原生DOM方式，缺点是API相对繁琐，代码量较多。
- 如果项目已经引入了JDOM或DOM4J依赖，或者需要更简洁的API，可以选择对应的第三方库，其中DOM4J的性能通常优于JDOM，适合处理较大规模的XML文件。
- 如果XML结构非常复杂，且需要频繁修改节点内容，DOM的内存树结构会更方便操作；如果是一次性生成XML，也可以考虑使用StAX这种流式的API，不过StAX更偏向于解析，生成场景使用相对少一些。
在实际应用中，可以根据项目的具体需求、依赖情况选择合适的XML生成方式，以上三种方式都能满足大部分常规场景的XML生成需求。