DOM4j 解析 XML

使用 DOM4j

XML 文件

首先拥有 xml 文件：

<?xml version="1.0" ?>
<breakfast_menu>
<food>
<name>Belgian Waffles</name>
<price>$5.95</price>
<description>Two of our famous Belgian Waffles with plenty of real maple syrup</description>
<calories>650</calories>
</food>
<food>
<name>Strawberry Belgian Waffles</name>
<price>$7.95</price>
<description>Light Belgian waffles covered with strawberries and whipped cream</description>
<calories>900</calories>
</food>
<food>
<name>Berry-Berry Belgian Waffles</name>
<price>$8.95</price>
<description>Light Belgian waffles covered with an assortment of fresh berries and whipped cream</description>
<calories>900</calories>
</food>
<food>
<name>French Toast</name>
<price>$4.50</price>
<description>Thick slices made from our homemade sourdough bread</description>
<calories>600</calories>
</food>
<food>
<name>Homestyle Breakfast</name>
<price>$6.95</price>
<description>Two eggs, bacon or sausage, toast, and our ever-popular hash browns</description>
<calories>950</calories>
</food>
</breakfast_menu>

保存 Food 类

然后尝试解析这个 XML 文件，将里面的信息保存到一个类中。

class Food {
    private String Name;
    private String Price;
    private String Description;
    private int Calories;

    public Food(String name, String price, String description, int calories) {
        Name = name;
        Price = price;
        Description = description;
        Calories = calories;
    }

    public String getName() {
        return Name;
    }

    public String getPrice() {
        return Price;
    }

    public String getDescription() {
        return Description;
    }

    public int getCalories() {
        return Calories;
    }

    @Override
    public String toString() {
        return "Food{" +
                "Name='" + Name + '\'' +
                ", Price='" + Price + '\'' +
                ", Description='" + Description + '\'' +
                ", Calories=" + Calories +
                '}';
    }
}

解析 XML 过程

1. 引入 JAR 包

2. 通过 SAXReader 构造方法获取 SAXReader 实例。

3. 通过 SAXReader 实例的 read(“filepaht”) 获取读取的 Document 对象。

4. 通过 Document 对象的 getRootElement() 获取根元素。

5. 通过 Element 对象的根元素的 elements() 获取根元素的子元素们的 List<Element> 集合

6. 遍历 List 集合，通过 element(“name”) 后的 getText() 获取子标签的值。

7. 将获取的数据保存到 Food 实例中。

写入 XML 过程

1. 引入 JAR 包

2. 通过 DocumentHelper 类的 createDocument() 创建 Document 对象

3. 通过 Document 的 addElement() 方法创建节点

4. 通过 Element 的 addAttribute() 方法为节点添加属性

5. 通过 Element 的 setText() 方法为节点设置内容

6. 通过 OutputFormat 的 createPrettyPrint() 方法创建 OutputFormat 对象（会自动缩进、换行）

7. 创建 XMLWriter 对象，将目的文件包装成 OutputStream 传入构造方法中，并将 OutputFormat 对象一并传入其中

8. 通过 XMLWriter 的 write() 方法生成XML文件，并将 Document 对象作为参数传入

9. 关闭 XMLWriter 对象

下面是执行的代码：

public class DOM4jTest {
    public static void main(String[] args) throws IOException, DocumentException {
        DOM4jTest.XMLToClass();
    }

    public static void XMLToClass() throws DocumentException, IOException {
        List<Food> list = new ArrayList<>(); // 用于存放解析出来的 Food 类
        SAXReader reader = new SAXReader(); // 获取 Sample AIP for XML Reader 实例
        Document doc = reader.read("./src/main/java/space/xorex/xml.xml"); // 让 Reader 去读取 XML 文件，返回 Document 实例
        List<Element> eles = doc.getRootElement().elements(); //获取保存类数据的根节点，这里是 food 标签节点
        for (Element i : eles) { //获取子元素的内容并保存到 Food 实例中
            String name = i.element("name").getText();
            String price = i.element("price").getText();
            String description = i.element("description").getText();
            int calories = Integer.parseInt(i.element("calories").getText());
            list.add(new Food(name, price, description, calories));
        }
        DOM4jTest.ClassToXML(list); //调用将实例 Food 转化为 XML 文件

    }

    public static void ClassToXML(List<Food> list) throws IOException {
        int num=0;
        Document doc= DocumentHelper.createDocument(); //利用 DocumentHelper.createDocumnet() 获取一个 Document 对象
        Element menu=doc.addElement("breakfast_menu"); // 在 Document 对象中添加根节点 breakfast_menu
        for(Food i:list) {//添加 food 节点，以及对应的子节点参数
            Element food=menu.addElement("food"); 
            food.addAttribute("id", String.valueOf(++num));
            food.addElement("name").setText(i.getName());
            food.addElement("price").setText(i.getPrice());
            food.addElement("description").setText(i.getDescription());
            food.addElement("calories").setText(String.valueOf(i.getCalories()));
        }
        OutputFormat format = OutputFormat.createPrettyPrint(); //生成一个 XML 输出格式
        XMLWriter writer =new XMLWriter(new FileWriter("write.xml"),format); //获取写 XML 文档的 IO 实例 XMLWriter
        writer.write(doc); // 写入
        writer.close(); // 关闭 IO 
    }
}

执行之后生成的 XML 文件内容。

<?xml version="1.0" encoding="UTF-8"?>

<breakfast_menu>
  <food id="1">
    <name>Belgian Waffles</name>
    <price>$5.95</price>
    <description>Two of our famous Belgian Waffles with plenty of real maple syrup</description>
    <calories>650</calories>
  </food>
  <food id="2">
    <name>Strawberry Belgian Waffles</name>
    <price>$7.95</price>
    <description>Light Belgian waffles covered with strawberries and whipped cream</description>
    <calories>900</calories>
  </food>
  <food id="3">
    <name>Berry-Berry Belgian Waffles</name>
    <price>$8.95</price>
    <description>Light Belgian waffles covered with an assortment of fresh berries and whipped cream</description>
    <calories>900</calories>
  </food>
  <food id="4">
    <name>French Toast</name>
    <price>$4.50</price>
    <description>Thick slices made from our homemade sourdough bread</description>
    <calories>600</calories>
  </food>
  <food id="5">
    <name>Homestyle Breakfast</name>
    <price>$6.95</price>
    <description>Two eggs, bacon or sausage, toast, and our ever-popular hash browns</description>
    <calories>950</calories>
  </food>
</breakfast_menu>

DOM4j API

• 解析XML形式的文本,得到document对象.

String text = "<members></members>";
Document document = DocumentHelper.parseText(text);

增删查改

• 删除某节点.

parentElm.remove(childElm);//childElm是待删除的节点,parentElm是其父节

• 添加一个CDATA节点.

Element contentElm = infoElm.addElement("content");
contentElm.addCDATA(diary.getContent());

• 取得某节点下的某属性

Element root=document.getRootElement(); //属性名name
Attribute attribute=root.attribute("size");

• 取得属性的文字

String text=attribute.getText();

• 删除某属性

Attribute attribute=root.attribute("size");
root.remove(attribute);

• 获取某节点的所有属性

Element root=document.getRootElement();
List attributes =root.attributes();

• 设置某节点的属性和文字.

newMemberElm.addAttribute("name", "sitinspring");

• 设置属性的文字

Attribute attribute=root.attribute("name");
attribute.setText("sitinspring");

输出系列

• 文档中含有中文,设置编码格式写入的形式.

OutputFormat format = OutputFormat.createPrettyPrint();// 指定XML编码
format.setEncoding("GBK");
XMLWriter writer = new XMLWriter(new FileOutputStream("output.xml"),format);
writer.write(document);
writer.close();

• 在指定位置插入节点

得到插入位置的节点列表（list），调用 list.add(index,elemnent)，由 index 决定 element 的插入位置。Element 元素可以通过 DocumentHelper 对象得到

Element aaa = DocumentHelper.createElement("aaa");
aaa.setText("aaa");
List list = root.element("书").elements();
list.add(1, aaa); //更新document