DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
用 XStream 把 Java 物件序列化成 XML:從環境建置到設定檔讀取
編輯:XML詳解     

XStream 最吸引人的地方在於:大多數 Java 物件不需要任何對應設定,就能直接完成序列化。產生的 XML 中,物件名稱會成為元素名稱,類別中的欄位則變成元素內容。而且被序列化的類別完全不需要實作 Serializable 介面。

不過要先釐清一個定位問題:XStream 是序列化工具,不是資料綁定工具。也就是說,它無法反過來從 XML 或 XSD 產生類別。

它與其他序列化工具的差異

  • 不理會欄位的可見性,private 欄位一樣能處理。
  • 欄位不需要 getter 與 setter 方法。
  • 類別不必提供無參數建構子。
  • 不必改動原始碼,就能直接序列化/反序列化第三方類別。

準備開發環境

本文的示範以三個元件為基礎:

  • 從 Eclipse 官方網站下載並解壓 Eclipse 至指定目錄(本文以 eclipse_home 表示,版本假定為 3.3)。
  • 從 XStream 官方網站下載最新的穩定版並解壓(以 xstream_home 表示,版本假定為 1.2.2)。
  • 從 Sun 下載 J2SE SDK 並安裝(以 java_home 表示,版本假定為 1.5.0_05)。

建立 Java 專案

開啟 Eclipse,選擇 File > New > Project,接著在清單中選 Java > Java Project 並按 Next。

圖 1. 新增 Java 專案

填入專案名稱後再按 Next。

圖 2. 設定專案名稱

最後按 Finish 完成建立。

圖 3. 完成設定

圖 4. 新建的 Java 專案

為專案加入 XStream 支援

在 Project Explorer 中選取剛建立的專案,從 Project 選單進入 Properties。

圖 5. 加入 XStream 程式庫

按下 Add External JARs,從 xstream_home/lib 目錄中挑出 xstream-1.2.2.jar,再按 OK 收尾。

圖 6. 完成 XStream 支援的加入

圖 7. 加入後的程式庫

序列化與反序列化物件

這個小例子示範 XStream 如何把物件寫成 XML、再把 XML 讀回物件,共牽涉三個類別:Writer 負責序列化並存檔,Reader 負責讀檔並還原,Employee 則是被處理的資料載體。

清單 1. Writer.java

package com.samples;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import com.thoughtworks.xstream.*;

public class Writer {
  public static void main(String[] args) {
    Employee e = new Employee();
    // 刻意用 setter 而非建構子,藉此證明 XStream
    // 即使沒有建構子也能完成序列化
    e.setName("Jack");
    e.setDesignation("Manager");
    e.setDepartment("Finance");

    XStream xs = new XStream();
    try {
      FileOutputStream fs = new FileOutputStream("c:/temp/employeedata.txt");
      xs.toXML(e, fs);
    } catch (FileNotFoundException e1) {
      e1.printStackTrace();
    }
  }
}

Reader 讀取同一支檔案,把 XML 還原並填回 Java 物件。

清單 2. Reader.java

package com.samples;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import com.thoughtworks.xstream.*;
import com.thoughtworks.xstream.io.xml.DomDriver;

public class Reader {
  public static void main(String[] args) {
    XStream xs = new XStream(new DomDriver());
    Employee e = new Employee();
    try {
      FileInputStream fis = new FileInputStream("c:/temp/employeedata.txt");
      xs.fromXML(fis, e);
      System.out.println(e.toString());
    } catch (FileNotFoundException ex) {
      ex.printStackTrace();
    }
  }
}

Employee 的結構如下,三個私有欄位加上標準的存取器與 toString()。

清單 3. Employee.java

package com.samples;

public class Employee {
  private String name;
  private String designation;
  private String department;

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

  public String getDesignation() { return designation; }
  public void setDesignation(String designation) {
    this.designation = designation;
  }

  public String getDepartment() { return department; }
  public void setDepartment(String department) {
    this.department = department;
  }

  @Override
  public String toString() {
    return "Name : " + this.name
         + "\nDesignation : " + this.designation
         + "\nDepartment : " + this.department;
  }
}

用來讀取設定檔

幾乎每個應用程式都需要一些外部屬性,例如要連接的資料來源名稱、IP 位址或日誌檔路徑。把這些值放進設定檔的好處很直接:調整時不必重新編譯,維護成本也低得多。

傳統的 XML 資料綁定流程通常得先從 XML 產生 Java 類別;改用 XStream 之後,這一步可以省下來。你只要寫一個類別,讓欄位名稱對應到 XML 中的元素即可。

清單 4. Config.xml

<?xml version="1.0" encoding="UTF-8"?>
<config>
  <datasource-name>IRIS</datasource-name>
  <ipaddress>9.124.74.85</ipaddress>
  <logfilename>DailyLogApplication.log</logfilename>
  <appender>console</appender>
</config>

ConfigReader 負責把這份檔案讀進來,並把屬性載入物件中。這裡有兩個關鍵的對應設定:alias 把根元素 config 對應到 ConfigReader 類別,aliasField 則把帶有連字號的 datasource-name 對應到 Java 端合法的識別字 datasourcename。

清單 5. ConfigReader.java

package com.samples;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import com.thoughtworks.xstream.*;
import com.thoughtworks.xstream.io.xml.DomDriver;

public class ConfigReader {
  String datasourcename = null;
  String ipaddress = null;
  String logfilename = null;
  String appender = null;

  @Override
  public String toString() {
    return "Datasource Name : " + datasourcename
         + "\nIP Address : " + ipaddress
         + "\nLogfilename : " + logfilename
         + "\nAppender : " + appender;
  }

  public static void main(String[] args) throws FileNotFoundException {
    XStream xs = new XStream(new DomDriver());
    FileInputStream fis = new FileInputStream("c:/temp/Config.xml");
    xs.aliasField("datasource-name", ConfigReader.class, "datasourcename");
    xs.alias("config", ConfigReader.class);
    ConfigReader r = (ConfigReader) xs.fromXML(fis);
    System.out.println(r.toString());
  }
}

結語

打造一個使用 XStream 的應用程式,步驟其實相當精簡。本文走過了序列化、反序列化與設定檔讀取三條主線;若想再往下深入,XStream 官方網站上關於別名、註解與轉換器的說明值得一讀。掌握別名與轉換器之後,你對最終 XML 結構的掌控度會提高到幾乎完全自訂的程度。

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