DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
DOM4J 實戰:XML 文件的增刪改查全流程
編輯:XML詳解     

做過 Java 開發的人,大概都有過這樣的階段:用 XML 已經好一段時間,卻從來只做「讀」;要產生 XML 時,乾脆用 StringBuffer 把標籤一段段拼出來,看起來能跑就心滿意足了。真正需要對同一份 XML 進行完整的讀取、新增、修改、刪除,往往是後來才被逼著面對的事。

本文用 DOM4J 把這四件事一次做完。DOM4J 的 API 其實不複雜,官方文件甚至比任何教學都清楚——Cookbook(https://www.dom4j.org/cookbook.html)與 Quick Start(https://www.dom4j.org/guide.html)值得先讀一遍,剩下的就是動手寫。

一、範例 XML 的結構

假設 classpath 根目錄下有一份 navigation.xml,用 GBK 編碼,每個 propertset 節點用 name 與 description 兩個屬性描述一組設定,field 子節點存放編號:

<?XML version="1.0" encoding="GBK"?>
<propertysets>
  <propertset name="rea_faculty" description="team">
    <field>10290</field>
  </propertset>
  <propertset name="faculty_lea" description="another team">
    <field>10286</field>
  </propertset>
  <propertset name="Office" description="teams">
    <field>10287</field>
  </propertset>
</propertysets>

二、先準備一個承載資料的類別

與其到處傳遞零散的字串,不如做一個對應節點的簡單 JavaBean。欄位對應屬性與子節點,getter/setter 齊備即可:

public class Propertys {
    private String name;
    private String description;
    private String field;

    public String getName() { return name; }
    public void setName(String name) { this.name = name; }

    public String getDescription() { return description; }
    public void setDescription(String description) { this.description = description; }

    public String getField() { return field; }
    public void setField(String field) { this.field = field; }
}

三、讀取:把 XML 轉成 List

讀取的路徑是固定的四步:用 SAXReader 讀成 Document、取得根元素、遍歷目標子節點、把值填進 JavaBean。

public List getAll() {
    List list = new ArrayList();
    try {
        InputStream is = getClass().getResourceAsStream("/navigation.xml");
        SAXReader reader = new SAXReader();
        Document document = reader.read(is);
        Element root = document.getRootElement();

        Iterator it = root.elementIterator("propertset");
        while (it.hasNext()) {
            Element el = (Element) it.next();
            Propertys property = new Propertys();
            property.setName(el.attributeValue("name"));
            property.setDescription(el.attributeValue("description"));
            property.setField(el.elementText("field"));
            list.add(property);
        }
    } catch (Exception e) {
        e.printStackTrace();
    }
    return list;
}

這裡有兩個關鍵方法值得記住:attributeValue() 取屬性值,elementText() 取子節點的文字內容。若節點不存在,前者回傳 null,後者回傳空字串,取值時最好留意空值處理。

四、新增:用串接寫法一次補齊節點

DOM4J 的 addElement()、addAttribute()、addText() 都會回傳元素本身,因此可以一路串下去,程式碼比逐一 new 元素清爽得多。成功回傳 1,失敗回傳 0:

public int saveProperty(Propertys property) {
    try {
        InputStream is = getClass().getResourceAsStream("/navigation.xml");
        SAXReader reader = new SAXReader();
        Document document = reader.read(is);
        Element root = document.getRootElement();

        root.addElement("propertset")
            .addAttribute("name", property.getName())
            .addAttribute("description", property.getDescription())
            .addElement("field")
            .addText(property.getField());

        writeDocument(document);
        return 1;
    } catch (Exception e) {
        e.printStackTrace();
    }
    return 0;
}

五、修改:先定位,再改值

修改的思路與讀取相同,只是找到目標節點後改用 setAttributeValue() 與 setText() 覆寫內容:

public int updateProperty(String oldName, Propertys property) {
    try {
        InputStream is = getClass().getResourceAsStream("/navigation.xml");
        SAXReader reader = new SAXReader();
        Document document = reader.read(is);
        Element root = document.getRootElement();

        Iterator it = root.elementIterator("propertset");
        while (it.hasNext()) {
            Element el = (Element) it.next();
            if (property.getName().equals(el.attributeValue("name")) == false) continue;
            el.setAttributeValue("name", property.getName());
            el.setAttributeValue("description", property.getDescription());
            el.element("field").setText(property.getField());
        }

        writeDocument(document);
        return 1;
    } catch (Exception e) {
        e.printStackTrace();
    }
    return 0;
}

六、刪除:detach 把節點摘掉

刪除節點只需呼叫 detach(),它會把該元素從樹上摘離,寫回檔案時自然就不存在:

public int delProperty(String name) {
    try {
        InputStream is = getClass().getResourceAsStream("/navigation.xml");
        SAXReader reader = new SAXReader();
        Document document = reader.read(is);
        Element root = document.getRootElement();

        Iterator it = root.elementIterator("propertset");
        while (it.hasNext()) {
            Element el = (Element) it.next();
            if (name.equals(el.attributeValue("name"))) {
                el.detach();
            }
        }

        writeDocument(document);
        return 1;
    } catch (Exception e) {
        e.printStackTrace();
    }
    return 0;
}

七、把寫檔邏輯抽成一個方法

新增、修改、刪除三者的結尾其實一模一樣:設定格式、指定編碼、寫出、關閉。與其複製三遍,不如抽成一個私有方法,日後要改編碼或輸出位置只需動一處:

private void writeDocument(Document document) throws IOException {
    OutputFormat format = OutputFormat.createPrettyPrint();
    format.setEncoding("GBK");
    FileWriter out = new FileWriter(
        System.getProperty("user.dir") + "/web/WEB-INF/classes/navigation.xml");
    XMLWriter writer = new XMLWriter(out, format);
    writer.write(document);
    writer.close();
}

幾個實務上的提醒

  • 編碼要一致。宣告是 GBK 就用 GBK 寫入,否則中文容易變成亂碼。
  • 讀與寫的路徑不同。讀取用 getResourceAsStream() 走 classpath,寫入則是實體檔案路徑;在 Web 專案裡兩者指向的檔案必須是同一份,否則改了也看不到效果。
  • 及早關流。XMLWriter.close() 請務必呼叫,緩衝區沒清空容易造成檔案內容不完整。
  • 併發要小心。DOM4J 是「整份讀進記憶體、改完整份寫回」,多人同時修改同一份設定檔時,後寫的會蓋掉先寫的,這時該考慮改用資料庫或加鎖。

把這四個方法湊在一起,XML 對你的專案就不再只是唯讀的設定檔,而是一份可以隨時維護的資料來源。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved