Java 操作xml文件的dom4J庫使用

XML簡介

什麼是xml?

• XML 指可擴展標記語言（EXtensible Markup Language）
• XML 是一種標記語言，很類似 HTML
• XML 的設計宗旨是傳輸數據，而非顯示數據
• XML 標籤沒有被預定義。您需要自行定義標籤。
• XML 被設計爲具有自我描述性。
• XML 是 W3C 的推薦標準

xml文件實例

下面是自定義的xml文件

<?xml version="1.0" encoding="UTF-8" ?>
<Users>
    <User name="Johnson" password="admin" phoneNum="10036363636" email="[email protected]"/>
    <User name="leo" password="admin" phoneNum="10036363636" email="[email protected]"/>
    <User name="John" password="admin" phoneNum="10036363636" email="[email protected]"/>
    <User name="Mary" password="admin" phoneNum="10036363636" email="[email protected]"/>
    <User name="Paul" password="admin" phoneNum="10036363636" email="[email protected]"/>
</Users>

• 其中的Users, User元素標籤是自定義的，在這裏表示用戶列表、用戶對象
• User元素中的name, password, phoneNum, email代表定義該對象的屬性

dom4j

dom4j簡介

dom4j是一個用來讀寫XML文件的Java XML API。dom4j是一個十分優秀的JavaXML API，具有性能優異、功能強大和極其易使用的特點，是一個開放源代碼的軟件。

dom4j使用方式

1. 引入項目依賴，這裏以maven項目爲例

    <dependencies>
        <dependency>
            <groupId>dom4j</groupId>
            <artifactId>dom4j</artifactId>
            <version>1.6.1</version>
        </dependency>
    </dependencies>

1. 準備好自定義的xml文件，這裏以上面的xml文件爲例，將其保存爲users.xml

<?xml version="1.0" encoding="UTF-8" ?>
<Users>
    <User name="Johnson" password="admin" phoneNum="10036363636" email="[email protected]"/>
    <User name="leo" password="admin" phoneNum="10036363636" email="[email protected]"/>
    <User name="John" password="admin" phoneNum="10036363636" email="[email protected]"/>
    <User name="Mary" password="admin" phoneNum="10036363636" email="[email protected]"/>
    <User name="Paul" password="admin" phoneNum="10036363636" email="[email protected]"/>
</Users>

1. 編寫程序，讀取xml文件內容

public static void main(String... strings) throws Exception {
    //文件路徑
    String filePathName = "C:\\Users\\johnson\\Desktop\\users.xml";

    //定義dom4j的SAXReader對象
    SAXReader reader = new SAXReader();

    //通過reader獲取到的文件內容被讀取並轉換成Document對象
    Document document = reader.read(new File(filePathName));

    //獲取文檔中的根節點, Element是dom4j的元素對象，即獲取Users標籤的元素
    Element rootElement = document.getRootElement();

    //獲取根節點中的所有子元素列表,即user對象列表
    @SuppressWarnings("unchecked")
    List<Element> userElements = rootElement.elements();

    //element對象的attributeValue(String name)方法可以獲取到元素的屬性值
    userElements.forEach(userElement -> System.out.println(userElement.attributeValue("name") +
            " || " + userElement.attributeValue("password") +
            " || " + userElement.attributeValue("phoneNum") +
            " || " + userElement.attributeValue("email")));
}

1. 由於xml文件元素是自定義的，因此需要自定義的程序來解析，程序運行解析結果如下:

Johnson || admin || 10036363636 || [e-mail]
leo || admin || 10036363636 || [e-mail]
John || admin || 10036363636 || [e-mail]
Mary || admin || 10036363636 || [e-mail]
Paul || admin || 10036363636 || [e-mail]

dom4j xml文件讀取寫入操作封裝實例

package xxx.xxx.xxx.xxx.util;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.UnsupportedEncodingException;

import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * 對XML文件進行操作的工具類
 * 
 * Created by Xuyh at 2017年4月21日 下午7:41:42.
 */
public class XMLUtils {
    private static Logger logger = LoggerFactory.getLogger(XMLUtils.class);

    /**
     * 將document寫入XML文件
     * 
     * @param filePathName 文件路徑名
     * @param document
     * @return
     */
    public static boolean wirteXMLFile(String filePathName, Document document) {
        OutputFormat format = OutputFormat.createPrettyPrint();
        format.setEncoding("UTF-8");
        XMLWriter writer = null;
        try {
            writer = new XMLWriter(new FileOutputStream(new File(filePathName)), format);
            writer.write(document);
            writer.flush();
        } catch (UnsupportedEncodingException e1) {
            logger.warn(e1.getMessage());
            return false;
        } catch (IOException e2) {
            logger.warn(e2.getMessage());
            return false;
        } finally {
            if (writer != null) {
                try {
                    writer.close();
                } catch (IOException e) {
                    logger.warn(e.getMessage());
                    return false;
                }
            }
        }
        return true;
    }

    /**
     * 讀取XML文件獲取document
     * 
     * @param filePathName 文件路徑名
     * @return
     */
    public static Document readXMLFile(String filePathName) {
        SAXReader reader = new SAXReader();
        Document document = null;
        try {
            document = reader.read(new File(filePathName));
        } catch (DocumentException e) {
            logger.warn(e.getMessage());
        }
        return document;
    }

    /**
     * 讀取XML文件獲取document
     * 
     * @param file 文件對象
     * @return
     */
    public static Document readXMLFile(File file) {
        SAXReader reader = new SAXReader();
        Document document = null;
        try {
            document = reader.read(file);
        } catch (DocumentException e) {
            logger.warn(e.getMessage());
        }
        return document;
    }
}

需要注意的是，該工具類使用到了slf4j庫來記錄日誌

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.22</version>
</dependency>