DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
用 OASIS CAM 模板打造可外部配置的 XML 驗證服務
編輯:XML詳解     

本文示範一套以 OASIS Content Assembly Mechanism(CAM)模板為核心的 XML 驗證做法,適用於與 B2B、B2C 商業夥伴之間進行的各類複雜訊息交換。CAM 模板能把驗證規則寫得直覺又清楚,同時讓閘道放行那些與自身無關的訊息內容。我們也會分享用 Eclipse 與 Java 技術打造開源元件、進而發布驗證服務的實作經驗,並透過 STAR(Standards for Technology in Automotive Retail)汽車產業商業物件文件(BOD)架構與對應 CAM XML 模板的程式碼片段與 XML 範例,說明整個應用開發流程。

業務與技術上的難題

今天,多數企業都要與大量貿易夥伴以 XML 交換複雜訊息,並面對龐大的 XSD 架構集。要在這種環境下支撐交易、準確處理訊息,本身就是門檻。XML 架構與 DTD 能驗證 XML 文件的結構性內容,也就是「檢驗」文件形狀;某些驗證規則可以寫進 XML 架構,但並非所有型別的事務驗證都做得到。

常用縮寫

  • API:應用程式介面
  • B2B:企業對企業
  • B2C:企業對消費者
  • DTD:文件型別定義
  • HTTP:超文本傳輸協定
  • JAX-RPC:以 XML 為基礎的 Java RPC API
  • JDOM:以 Java 為基礎的文件物件模型
  • J2EE:Java 2 平台企業版
  • OASIS:結構化資訊標準推動組織
  • UI:使用者介面
  • WSDL:Web 服務描述語言
  • XML:可擴充標記語言
  • XPath:XML 路徑語言
  • XSD:XML 架構定義
  • XSLT:可擴充樣式表語言轉換

隨著 STAR 這類產業標準問世,標準化的 XML 訊息交換格式也以 XSD 形式大量出現。Web 服務的消費者與提供者都必須遵循這些架構,才能取得產業標準組織的認證。但這些產業架構的驗證約束相當寬鬆,通常只能用於傳入 XML 的結構檢查;要加上真正需要的驗證,得另外寫程式碼。當應用程式或元件要求收到的資料符合特定格式、或滿足業務內容規則時,這些額外驗證就能攔下錯誤。

在 Web 服務及其周邊 XML 應用裡實作驗證邏輯,最常見的做法就是寫客製程式。結果是驗證規則被埋在應用程式內部,難以修改、難以記錄、也難以共享。視所需驗證的數量與性質,這段程式碼可能相當龐大冗長;參與的人一多,維護就成了沉重負擔。更麻煩的是,驗證邏輯每變一次,就得重新編譯並部署到正式環境,時間、精力與風險樣樣都要付。

除了獨立應用程式,透過企業服務匯流排(ESB)發布服務時同樣需要驗證。圖 1 展示了一個典型的 ESB 架構:中間的訊息匯流排提供 SOAP、HTTP、Java Messaging Service(JMS)等標準的訊息發布能力,讓服務能依各自事務品質需求互動,並支援 SOAP、XML、WSDL、JMS、J2EE、JAX-RPC 等標準。

圖 1. ESB 架構中的驗證位置

開發人員面臨的主要挑戰,是當訊息經由 ESB 傳遞時,該在提供者與消費者之間的哪一環執行驗證。以圖 1 為例,Web 服務元件可能需要既有應用程式提供的資訊:Web 服務(消費者)透過 ESB 向既有應用程式(提供者)送出請求,應用程式元件要求請求符合某種格式並帶有正確內容,因此會在處理前先驗證;Web 服務元件有自己的一套規則,會驗證回應訊息。若兩端採用不同協定或標準,ESB 必須在轉換前後各做一次驗證。

每個提供者與消費者都有自己的規則,於是依事務型別與驗證數量,開發週期會被拉得很長——定義、實作、測試每一條驗證。這個穩定化階段會一直持續,直到每個驗證元件都能對呼叫方的訊息給出正確回饋。

解法概要

這裡介紹的方案,是依據 OASIS Content Assembly Mechanism 規範來實作 XML 驗證服務。CAM 模板走的是一條簡單直接的 XML 內容處理與驗證路線,讓企業得以建立通用交換模型。它支援基於上下文的規則、代碼清單與跨領域驗證;其中許多跨領域驗證無法單靠 XSD 實作,也有些情況是既有的產業架構根本沒打算涵蓋這些驗證變化。

整體由兩部分組成:CAM Studio 是基於 Eclipse 的模板編輯器 UI,用於定義 CAM 模板;CAMV 驗證引擎則是一組開源 Java API,在執行期以編譯過的 CAM 模板驗證 XML。CAM Studio 允許在產生的模板中補上自訂 XPath 運算式,不過大多數規則都能靠 UI 定義完成,不必自己寫運算式。

圖 2 呈現了驗證規則生命週期中建模、實作與測試、部署、監控這幾個階段。

圖 2. 驗證規則生命週期

建模階段

這個階段確認資料項目、資料元素以及各自對應的驗證規則。XML 交換架構此時已定義完成,所需元素也已對映到 STAR 這類既有產業標準架構。

實作與測試階段

接著用 CAM Studio 編輯器組裝或撰寫 CAM 模板。建立模板有三種起點:從零開始手寫、以既有 XML 架構為基礎、或以既有 XML 實例為基礎。

模板建立後,下一步是逐一审視每個元素與屬性,為它們設定適用的驗證規則。編輯器的面板會列出每個模板節點上的規則。圖 3 是 CAM 模板編輯器中模板結構的截圖:

圖 3. CAM TemplateEditor 中的 CAM 模板

並非所有驗證結果都是非真即假的二元判斷,CAM 允許把驗證失敗歸類為「警告」。這個特性在這樣的情境下很方便:某個動作在服務提供者端其實仍能正常處理,只是需要調整酬載,而不是退回整封訊息。舉例來說,某條規則要求註解欄位不超過 255 字元;但超過上限的訊息不該被直接拒絕,而是送出警告,告知使用者系統只會取前 255 字元。關於如何把訊息歸類為警告,後面「提示與技巧」一節會細說。

部署階段

先用 CAM Studio 編輯器編譯 CAM 模板,執行期則交由 CAMV 引擎。編譯後的格式是原模板的精簡 XML 版本,用來最佳化 CAMV 的驗證效能。編譯方式是選擇 Tools > Compile Template,會產生 .cxx 檔,執行期即使用這份檔案。

CAMV 提供簡潔的開源 Java API,任何 Java 應用都能用它搭配合適的 CAM 模板來驗證輸入 XML。清單 1 示範用法:

清單 1. CAMV API 用法

TemplateValidator tv = new TemplateValidator(templateDocument);
tv.setErrHandler(new ElementErrorHandler(tv));

boolean tvResult = tv.validate(ioReader);

if (tvResult){
    System.out.println("No errors, might be warnings.....");
}

List errList = tv.getErrors();
List warnList = tv.getWarnings();

錯誤與警告訊息格式如下:

<error classification>: <XPATH> => <error or warning message>
  => Node: <node name> => attribute: <attribute name>

例如錯誤訊息長這樣:

/p:ProcessRepairOrder[1]/p:ApplicationArea[1]/p:CreationDateTime[1]
  => Content does not conform to the mask: YYYY-MM-DD'T'HH:MI:SSZ
  => Node: CreationDateTime

警告訊息則像這樣:

Warning: /p:ProcessRepairOrder[1]/.../p:ResidenceAddress[1]/p:LineOne[1]
  => length should be less than 80 => Node: LineOne

監控階段

導入 CAMV 之後,所有驗證檢查都能外置,不必再嵌進程式碼或以客製實作處理。進入監控階段,只要更新驗證模板就能滿足新增或移除驗證的需求——重新指派編譯後的 CAM 模板(.cxx 檔)即可。驗證邏輯改變時,不需要重新編譯或重新部署任何 Java 程式碼。

新版 CAMV 的特性

2009 年 12 月版 CAMV 加入的重要特性包括:

  • 除了預設的 Java 1.6,另提供向下相容 Java 1.5 的版本。
  • CAMV 是執行緒安全的,可部署於任何 J2EE 容器,例如 WebSphere Application Server。
  • 除 JDOM 文件外,也能直接接收 StringReader 形式的 XML 輸入,減少訊息處理中的序列化/反序列化次數。
  • 可在單一 XML 元素或屬性上定義多種條件。

提示與技巧

以下是我們在一個實際專案中累積的心得。該專案以 CAMV 打造 B2B 閘道驗證框架,為一家領先汽車產業組織公開以 STAR 為基礎的 Web 服務。

驗證分類

CAMV 支援建立「錯誤」與「警告」兩類驗證規則。要產生警告,需要在 XML 元素上指定條件 XPath 運算式。

例如這樣的業務情境:某欄位超過 255 字元時,不必拒絕整個 Web 服務請求;業務決策是把欄位截到 255 字元後再送進後台系統,但必須同時通知呼叫方。這類需求可以在 CAM 模板規則中指定 printmessage() 運算式來處理。

訊息文字必須以 Warning: 開頭,後面接上要提示的內容,例如 length should be less than 255,完整字串就是 Warning: length should be less than 255。

只有當該元素長度真的超過指定值時才回傳這則警告,因此規則要標為條件式,並建立執行長度檢查的 XPath 運算式。圖 4 是 CAM Studio 編輯器運算式精靈的截圖:

圖 4. 如何設定警告規則

快取 CAMV 模板

把 CAMV 模板快取在記憶體中,重複驗證時就不必每次都從硬碟讀檔。這能減少磁碟 I/O,對效能與吞吐量都有明顯幫助。

驗證結果的判讀

即使只回傳警告,TemplateValidator.validate(..) 仍會回傳 true,只有在出現錯誤時才回傳 false。所以要取得警告清單,得另外呼叫 getWarnings()。

驗證訊息的細節

如果預設回傳的訊息(含 XPath 路徑、訊息文字與節點名稱)無法滿足業務情境,需要更多資訊時,可以自建程式處理。CAMV 會在輸入的交換訊息 XML 上加註 CAMERROR 與 CAMWARN 屬性,並回傳同一份 XML,如清單 2 所示。

清單 2. 驗證後被標註的 XML

<p:ApplicationArea>
  <p:Sender>
    <p:CreatorNameCode>CNV</p:CreatorNameCode>
    <p:SenderNameCode>SNC</p:SenderNameCode>
  </p:Sender>
  <p:CreationDateTime CAMERROR="CreationDateTime | Content does not
    conform to the mask: YYYY-MM-DD'T'HH:MI:SSZ">2001-12-31T12:00:00
    </p:CreationDateTime>
  <p:Destination/>
</p:ApplicationArea>

<p:ResidenceAddress>
  <p:LineOne CAMWARN="WARNING:LineOne | length should be less than 80">
    100 Moon Drive 100 Moon Drive 100 Moon Drive 100 Moon Drive
    </p:LineOne>
  <p:LineTwo>APT # 100</p:LineTwo>
  <p:CityName>MALIBU</p:CityName>
  <p:CountryID>US</p:CountryID>
  <p:Postcode>99999</p:Postcode>
  <p:StateOrProvinceCountrySub-DivisionID>CA
    </p:StateOrProvinceCountrySub-DivisionID>
</p:ResidenceAddress>

萬用字元運算式

在模板中輸入規則時,XPath 運算式預設會帶上兩個斜線(//)的萬用寫法,意思是從文件中的既有節點出發,不論位置一律選出所有符合的節點。

圖 5. 定義規則時的萬用運算式

這會讓規則套用到該元素的所有實例。(提醒:其他實例上的規則不會立刻顯示,需在 CAM 模板編輯器檢視中重新整理後才看得到。)

若你只想把檢查套用在 XML 元素的特定實例上,建議在 Rule XPath 中勾選 Full。

圖 6. 定義規則時的明確運算式

結語

導入 CAMV 之後,驗證檢查得以一致執行,規則也能快速調整以配合特定夥伴的交換需求與內容要求。把過去深埋在後台應用程式碼裡的驗證規則外置,訊息處理變得更可控、更可預期;這些以標準為基礎的規則模板還能有選擇地與夥伴共享,進一步推動內容處理的一致性。

流程變得更靈活、更容錯之後,應用程式能吸納更多內容變化,於是支援更多樣的互動夥伴反而變得輕鬆,維護成本也跟著下降——這與一般經驗正好相反。

開源在這裡發揮了不小的作用,它大幅加速了方案開發與 CAMV 引擎融入既有部署環境的過程。整體而言,這個專案說明:創意地使用 XML、搭配動態可設定的 XML,能帶來比單靠靜態編譯程式碼更穩定、更快、也更強的使用者體驗。

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