使用 dom4j 操作 XML 文件完整指南
XML 是一种常用的数据存储和交换格式,在 Java 开发中,dom4j 是非常流行的 XML 解析工具,它性能优异、API 简洁,支持对 XML 文件的读取、创建、修改、删除等全量操作。本文将详细介绍如何使用 dom4j 完成所有常见的 XML 操作。
环境准备
使用 dom4j 前需要先引入相关依赖,如果你使用 Maven 构建项目,可以在 pom.xml 中添加如下依赖:
<dependency>
<groupId>org.dom4j</groupId>
<artifactId>dom4j</artifactId>
<version>2.1.4</version>
</dependency>如果是普通 Java 项目,可以下载 dom4j 的 jar 包,导入到项目的类路径中即可。
读取 XML 文件
读取 XML 是最基础的操作,我们可以通过 SAXReader 来解析 XML 文件,获取完整的 Document 对象,进而操作整个 XML 结构。
假设我们有一个测试用的 XML 文件 test.xml,内容如下:
<?xml version="1.0" encoding="UTF-8"?>
<users>
<user id="1">
<name>张三</name>
<age>25</age>
<email>zhangsan@ipipp.com</email>
</user>
<user id="2">
<name>李四</name>
<age>28</age>
<email>lisi@ipipp.com</email>
</user>
</users>下面是读取该 XML 文件并打印所有用户信息的代码示例:
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import java.io.File;
import java.util.List;
public class Dom4jReadDemo {
public static void main(String[] args) {
// 创建 SAXReader 对象
SAXReader reader = new SAXReader();
try {
// 读取 XML 文件,获取 Document 对象
Document document = reader.read(new File("test.xml"));
// 获取根节点,这里是 <users> 标签
Element rootElement = document.getRootElement();
System.out.println("根节点名称:" + rootElement.getName());
// 获取所有 <user> 子节点
List<Element> userElements = rootElement.elements("user");
for (Element userElement : userElements) {
// 获取 user 节点的 id 属性
String id = userElement.attributeValue("id");
// 获取子节点 <name> 的文本内容
String name = userElement.elementText("name");
// 获取子节点 <age> 的文本内容
String age = userElement.elementText("age");
// 获取子节点 <email> 的文本内容
String email = userElement.elementText("email");
System.out.println("用户ID:" + id + ",姓名:" + name + ",年龄:" + age + ",邮箱:" + email);
}
} catch (DocumentException e) {
e.printStackTrace();
}
}
}运行上述代码,会输出 XML 中所有用户的信息,通过这种方式我们可以快速解析 XML 中的节点和属性内容。
创建新的 XML 文件
除了读取已有的 XML,我们也可以使用 dom4j 动态创建新的 XML 文件,设置节点、属性、文本内容等信息。
下面是创建一个包含用户信息的 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;
import java.io.IOException;
public class Dom4jCreateDemo {
public static void main(String[] args) {
// 创建 Document 对象
Document document = DocumentHelper.createDocument();
// 创建根节点 <users>
Element rootElement = document.addElement("users");
// 创建第一个 <user> 节点
Element user1 = rootElement.addElement("user");
// 给 user1 添加 id 属性
user1.addAttribute("id", "1");
// 添加子节点 <name> 并设置文本
user1.addElement("name").setText("王五");
user1.addElement("age").setText("30");
user1.addElement("email").setText("wangwu@ipipp.com");
// 创建第二个 <user> 节点
Element user2 = rootElement.addElement("user");
user2.addAttribute("id", "2");
user2.addElement("name").setText("赵六");
user2.addElement("age").setText("32");
user2.addElement("email").setText("zhaoliu@ipipp.com");
// 设置输出格式,缩进排版,避免生成的 XML 挤在一起
OutputFormat format = OutputFormat.createPrettyPrint();
format.setEncoding("UTF-8");
try {
// 创建 XMLWriter,输出到文件 new_test.xml
XMLWriter writer = new XMLWriter(new FileOutputStream("new_test.xml"), format);
writer.write(document);
writer.close();
System.out.println("XML 文件创建成功");
} catch (IOException e) {
e.printStackTrace();
}
}
}运行代码后,会在项目根目录生成 new_test.xml 文件,内容和我们手动构造的结构一致,格式清晰可读。
修改 XML 文件内容
修改 XML 文件的核心是先读取原有内容,找到需要修改的节点或属性,调整后再重新写入文件。
以下示例会修改上面创建的 new_test.xml 中 id 为 1 的用户年龄,并新增一个爱好节点:
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.List;
public class Dom4jUpdateDemo {
public static void main(String[] args) {
SAXReader reader = new SAXReader();
try {
// 读取原有 XML 文件
Document document = reader.read(new File("new_test.xml"));
Element rootElement = document.getRootElement();
// 获取所有 user 节点
List<Element> userElements = rootElement.elements("user");
for (Element userElement : userElements) {
String id = userElement.attributeValue("id");
// 找到 id 为 1 的用户
if ("1".equals(id)) {
// 修改 age 节点的文本内容
Element ageElement = userElement.element("age");
ageElement.setText("31");
// 新增 hobby 子节点
userElement.addElement("hobby").setText("篮球");
break;
}
}
// 重新写入文件,覆盖原有内容
OutputFormat format = OutputFormat.createPrettyPrint();
format.setEncoding("UTF-8");
XMLWriter writer = new XMLWriter(new FileOutputStream("new_test.xml"), format);
writer.write(document);
writer.close();
System.out.println("XML 文件修改成功");
} catch (DocumentException | IOException e) {
e.printStackTrace();
}
}
}修改完成后,再次读取该 XML 文件,会发现 id 为 1 的用户年龄已经更新,并且新增了爱好字段。
删除 XML 文件节点
删除操作同样需要先定位到目标节点,然后调用父节点的 remove 方法完成删除。
以下示例会删除 new_test.xml 中 id 为 2 的用户节点:
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.List;
public class Dom4jDeleteDemo {
public static void main(String[] args) {
SAXReader reader = new SAXReader();
try {
Document document = reader.read(new File("new_test.xml"));
Element rootElement = document.getRootElement();
List<Element> userElements = rootElement.elements("user");
Element targetUser = null;
// 遍历找到要删除的节点
for (Element userElement : userElements) {
if ("2".equals(userElement.attributeValue("id"))) {
targetUser = userElement;
break;
}
}
// 如果找到了目标节点,从根节点中移除
if (targetUser != null) {
rootElement.remove(targetUser);
System.out.println("节点删除成功");
} else {
System.out.println("未找到目标节点");
}
// 重新写入文件
OutputFormat format = OutputFormat.createPrettyPrint();
format.setEncoding("UTF-8");
XMLWriter writer = new XMLWriter(new FileOutputStream("new_test.xml"), format);
writer.write(document);
writer.close();
} catch (DocumentException | IOException e) {
e.printStackTrace();
}
}
}执行后再次查看 XML 文件,id 为 2 的用户节点已经被完全移除。
常用操作总结
dom4j 的核心操作都围绕 Document、Element、Attribute 这几个类展开,常用方法整理如下:
| 操作类型 | 常用方法 | 说明 |
|---|---|---|
| 读取 XML | SAXReader.read(File) | 解析 XML 文件返回 Document 对象 |
| 获取根节点 | Document.getRootElement() | 获取 XML 的根元素 |
| 获取子节点 | Element.elements(String)、Element.element(String) | 获取所有指定名称的子节点或第一个指定名称的子节点 |
| 获取属性 | Element.attributeValue(String) | 获取节点的指定属性值 |
| 获取/设置文本 | Element.elementText(String)、Element.setText(String) | 获取子节点文本或设置当前节点文本 |
| 添加节点 | Element.addElement(String) | 添加指定名称的子节点 |
| 删除节点 | Element.remove(Element) | 从父节点中移除指定子节点 |
| 写入文件 | XMLWriter.write(Document) | 将 Document 内容写入输出流 |
掌握这些方法后,就可以应对绝大多数 XML 操作场景,如果需要更复杂的查询,还可以结合 dom4j 支持的 XPath 语法快速定位节点,进一步提升开发效率。
dom4jXML解析Java操作XMLSAXReaderXML文件处理 本作品最后修改时间:2026-05-22 21:16:13