dom4j是一款优秀的Java XML解析和生成工具,它提供了简洁的API,能够方便地创建、修改和输出XML文档。在实际开发中,我们经常会遇到需要动态生成XML文件的场景,比如接口数据返回、配置文件生成等,使用dom4j可以快速实现这些需求。

dom4j依赖引入
如果使用的是Maven项目,需要在pom.xml中添加dom4j的依赖,依赖坐标如下:
<dependency>
<groupId>org.dom4j</groupId>
<artifactId>dom4j</artifactId>
<version>2.1.3</version>
</dependency>
如果是普通Java项目,可以下载dom4j的jar包,导入到项目的类路径中即可。
生成XML的核心步骤
使用dom4j生成XML文件主要分为以下几个步骤:
- 创建Document对象,作为XML文档的根容器
- 创建根节点,并添加到Document中
- 根据需求创建子节点、添加属性、设置节点文本内容
- 配置XML输出格式,比如编码、是否缩进、换行等
- 将Document对象写入到文件或输出流中
完整示例代码
下面是一个生成简单用户信息的XML文件的完整示例,生成的XML包含用户id、姓名、年龄等字段:
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 Dom4jGenerateXmlDemo {
public static void main(String[] args) {
try {
// 1. 创建Document对象
Document document = DocumentHelper.createDocument();
// 2. 创建根节点users
Element rootElement = document.addElement("users");
// 3. 创建子节点user,并添加属性
Element userElement = rootElement.addElement("user");
userElement.addAttribute("id", "1001");
// 4. 给user节点添加子节点,设置文本内容
Element nameElement = userElement.addElement("name");
nameElement.setText("张三");
Element ageElement = userElement.addElement("age");
ageElement.setText("25");
Element emailElement = userElement.addElement("email");
emailElement.setText("test@ipipp.com");
// 5. 配置输出格式,设置编码为UTF-8,开启缩进和换行
OutputFormat format = OutputFormat.createPrettyPrint();
format.setEncoding("UTF-8");
// 6. 创建XMLWriter,将Document写入文件
XMLWriter writer = new XMLWriter(new FileOutputStream("user_info.xml"), format);
writer.write(document);
writer.close();
System.out.println("XML文件生成成功");
} catch (Exception e) {
e.printStackTrace();
}
}
}
代码说明
上述代码中,首先通过DocumentHelper.createDocument()方法创建了Document对象,这是整个XML文档的基础。然后通过addElement方法依次创建根节点和子节点,使用addAttribute方法给节点添加属性,setText方法设置节点的文本内容。
OutputFormat类用于配置XML的输出样式,createPrettyPrint()方法会生成带有缩进和换行的格式,方便阅读,如果是生产环境需要紧凑格式,可以使用createCompactFormat()方法。最后通过XMLWriter将Document对象输出到指定的文件中。
生成结果验证
运行上述代码后,会在项目根目录下生成user_info.xml文件,内容如下:
<?xml version="1.0" encoding="UTF-8"?>
<users>
<user id="1001">
<name>张三</name>
<age>25</age>
<email>test@ipipp.com</email>
</user>
</users>
常见问题说明
- 如果出现中文乱码问题,需要检查OutputFormat的编码设置和写入文件的编码是否一致,建议都设置为UTF-8
- 添加节点时要注意层级关系,先创建父节点再添加子节点,避免空指针异常
- 如果需要生成复杂的XML结构,可以封装节点创建的方法,减少重复代码
dom4jxml_generationJavaDocument修改时间:2026-07-21 21:15:12