本文用 Apache SDO 走一遍 XML 數據處理的完整流程。需要提前說明的是:SDO 目前並不是處理 XML 的標準方案,所以文中會順帶介紹它操作 XML 數據的基本方式,便於判斷是否適合引入。
記錄數據的修改歷史,在很多軟件、應用和業務場景中都是硬性需求:並發控制、離線應用同步、商業進程管理(BPM)系統,都離不開它。
但這個需求嚴格實現起來並不容易。要為文件的各種變化建模,再逐一監視,工程量往往超出預期。更合理的做法是把它做成一個可復用的獨立模塊,服務於不同應用,而不是每個項目重造一次輪子。
服務數據對象(SDO)——由 BEA 和 IBM 共同定義的異構數據訪問方案——提供的正是這樣一種機制,讓開發者能在系統層面追蹤數據變化,而不必在業務代碼裡處處埋點。
示例把 XML 數據處理劃分為三個階段:
數據通過文件系統在這三個階段之間傳遞。核心場景是:第二步需要知道文檔相對第一步被改動了什麼;到了第三步,瀏覽者希望能看到完整、細緻的修改記錄——就像 Word 的修訂功能那樣,誰改了什麼、從什麼改成什麼,一目了然。
示例數據基於一個名為 po_original.xsd 的模式,命名空間是 https://www.example.com/PO。CreatePO 類負責構造數據對象並存盤,關鍵步驟如下。
先定義類型。由於數據基於 XML 格式,運行時必須先讓 SDO 知道類型的結構,這由 Util 類的 definePOTypes() 完成,內部調用 XSDHelper:
public static void definePOTypes() throws Exception {
FileInputStream fis = new FileInputStream(PO_MODEL_ORIGINAL);
XSDHelper.INSTANCE.define(fis, null);
fis.close();
}
接著建立根數據對象。SDO 的動態 API 用數據對象的層次與屬性來描述結構化數據,未連接的對象由 DataFactory 創建:
DataObject purchaseOrder =
DataFactory.INSTANCE.create(Constants.PO_NAMESPACE, "PurchaseOrderType");
purchaseOrder.setString("orderDate", "1999-10-20");
然後建立子對象並賦值。這裡有兩種等價寫法:一種是在父對象上直接創建,另一種是先獨立創建再掛上去。
// 寫法一:直接在父對象下創建
DataObject shipTo = purchaseOrder.createDataObject("shipTo");
shipTo.set("country", "US");
shipTo.set("name", "Alice Smith");
// 寫法二:先獨立創建,再關聯
DataObject shipTo2 = DataFactory.INSTANCE.create(Constants.PO_NAMESPACE, "USAddress");
purchaseOrder.setDataObject("shipTo", shipTo2);
訂單裡的 items 之下可以有多個 item,重複結構照樣一層層 create 下去即可。最後把整棵對象樹寫入文件:
Util.storeXML(purchaseOrder, "purchaseOrder", Constants.PO_XML);
要啟用追蹤,需要改動模式:引入 SDO 命名空間,並在訂單類型裡加入一個 ChangeSummaryType 元素。這個元素的名字可以任意取,但不要用保留名 changes。
<xsd:schema xmlns:xsd="https://www.w3.org/2001/XMLSchema"
xmlns:sdo="commonj.sdo"
targetNamespace="https://www.example.com/PO">
<xsd:import namespace="commonj.sdo" schemaLocation="sdo.xsd" />
<xsd:element name="purchaseOrder" type="PurchaseOrderType" />
<!-- PurchaseOrderType 中加入 ChangeSummaryType 元素 -->
</xsd:schema>
被導入的 sdo.xsd 定義了 ChangeSummaryType。裝上新模式後生成的文檔,根元素下會多出一個 <changes logging="false" /> 子元素。
ProcessPO 類負責處理訂單,流程很清晰:載入文檔 → 取得關聯的 ChangeSummary 對象 → 打開日志 → 修改數據 → 關閉日志 → 保存結果。此時輸出的 po_processed.xml 中,changes 元素會變得相當豐富:它用 create、delete 屬性記錄節點的增刪,並通過帶 sdo:ref 的片段指向被修改的原始節點及其舊值。有了這些信息,應用程序完全有能力把數據還原到修改前的狀態。
打印變化的核心邏輯值得看一眼:
public static void printChangeSummary(ChangeSummary chngSum) {
if (chngSum == null) return;
for (Iterator it = chngSum.getChangedDataObjects().iterator(); it.hasNext();) {
DataObject changedObject = (DataObject) it.next();
if (chngSum.isCreated(changedObject)) {
// 新建對象:打印內容與所屬容器
} else if (chngSum.isDeleted(changedObject)) {
// 刪除對象:打印原容器與被刪屬性
for (Iterator sit = chngSum.getOldValues(changedObject).iterator(); sit.hasNext();) {
printDeletedProperty((ChangeSummary.Setting) sit.next());
}
} else if (chngSum.isModified(changedObject)) {
// 修改對象:打印新值與舊值對照
for (Iterator sit = chngSum.getOldValues(changedObject).iterator(); sit.hasNext();) {
ChangeSummary.Setting s = (ChangeSummary.Setting) sit.next();
printUpdatedProperty(s, changedObject, chngSum);
}
}
}
}
思路是先用 getChangedDataObjects() 拿到所有變動過的對象,再按創建、刪除、修改三類分別處理。getOldValues() 返回的 Setting 集合,正是「哪個屬性、舊值是什麼」的載體。
ReviewPO 類負責讀取處理後的文檔,做兩件事:按順序打印訂單的主要信息,以及展示第二階段累積的全部修改記錄。關鍵調用同樣簡單:
XMLDocument xmlDoc = XMLHelper.INSTANCE.load(fis);
DataObject purchaseOrder = xmlDoc.getRootObject();
// 查看變化
ChangeSummary chngSum = purchaseOrder.getChangeSummary();
Util.printChangeSummary(chngSum);
// 撤銷第二階段的全部改動
chngSum.undoChanges();
// 在原始版本上重新做一次小修改
chngSum.beginLogging();
billTo.set("name", "Alice Smith");
chngSum.endLogging();
Util.printChangeSummary(chngSum);
Util.storeXML(purchaseOrder, "purchaseOrder", Constants.PO_REVIEWED_XML);
這裡有兩個細節值得留意。
第一,這次的輸出與上一階段的輸出呈現方式不同:本階段的打印是直接基於 ChangeSummary 中重新載入的記錄,而不是即時狀態。對比兩份 printout 就能看出差別——上一階段在刪除項上 printDataObject() 什麼都不輸出,改由 printDeletedProperty() 列出屬性和值;本階段恰好相反。這說明變化的呈現方式可以按需選擇。
第二,undoChanges() 提供了「整批回滾」的能力,而 beginLogging() 與 endLogging() 之間的改動會被重新記錄下來。這兩個能力組合起來,就是離線編輯與同步場景裡最需要的原語。
順帶說明一個實測中遇到的情況:在 Tuscany SDO 的某些版本中,刪除對象的內容打印和舊屬性遍歷可能沒有輸出,這更像是實現層的缺陷而非 API 設計問題。選型時值得留意實現成熟度。