Web 服務協定走過了一段漫長的演進之路:從最初只能承載簡單參數的樸素請求,一路發展到對現代物件導向語言的完整支援。回顧這條時間軸,XML-RPC 大概是最早期的形態之一,它只認得字串、整數、布林值這類基本型別;SOAP 接著往前跨了一步,為物件引入了正式的編碼規則;而最近一次針對二進位資料的關鍵改進,則來自「帶附件的 SOAP」(SOAP with Attachments)。
帶附件的 SOAP 最初是以 SOAP 1.1 擴充方案的形式提出的,並迅速獲得主流 SOAP 工具包的普遍採用。值得一提的是,即便 W3C 正式發布的 SOAP 1.2 尚未原生支援附件,社群仍在努力朝著把它納入標準的方向推進,理想情況下能在不遠的未來整合進來。
我始終相信,XML 能在應用程式整合領域大獲成功,關鍵在於它對「文字編碼」的依賴——這與 CORBA(一種物件導向的 RPC 協定)、RMI(Java 專屬的 RPC 標準)等二進位協定形成鮮明對比。人們之所以偏好文字編碼,原因不少,但最重要的莫過於它易於除錯,而且在必要時也很容易自行完成一套專用實作。
然而,對文字編碼的依賴也有其代價:XML 對於引入二進位資料並沒有給出真正有效率的解法。依據 W3C XML Schema 規範,二進位資料只能採用 base 64 或十六進位編碼。不幸的是,base 64 編碼後的資料會比原始資料脹大約 50%,而十六進位編碼更是直接翻倍。對於一小段二進位資料,這種開銷或許還能接受;但面對大型資料集時,問題就變得相當棘手。
二進位資料在各類應用中其實無所不在,例如:
儘管為這些格式打造 XML 版本在技术上是可行的(例如向量圖形就有 SVG),但二進位格式已經存在太久,短期内恐怕仍會廣泛流通。最後還有一個容易被忽略的問題——XML 自身的嵌套:想在一份 XML 文件裡安插另一份 XML 文件其實並不簡單,語法上正確的做法往往得依賴 CDATA 區段與字元轉義。
這裡順便釐清一個經常被混淆的觀念:MIME 並沒有強制要求使用 base 64 編碼。具體來說,HTTP 實作根本不會對附件編碼,只有郵件用戶端才會編碼附件,那是為了突破 SMTP 的限制——因此這件事和 XML 之間其實沒有可比性。
為了解決上述種種應用的需求,Web 服務必須具備高效處理二進位資料的能力。目前提出的方案就是「帶附件的 SOAP」,其核心思路是:把二進位資訊從 XML 有效負載中抽離出來,改以 multipart/related 的 MIME 內容直接放進 HTTP 請求裡。
在設計需要用到二進位資料的 Web 服務時,可以考慮的取捨大致如下:
下面的清單 1 展示了一個帶有 base 64 編碼參數的 SOAP 請求,請特別留意其中的 address 元素。
清單 1. 以 base 64 編碼的參數
POST /ws/retrieve HTTP/1.0
Content-Type: text/XML; charset=utf-8
Accept: application/soap+xml multipart/related, text/*
Host: localhost:8080
SOAPAction: ""
Content-Length: 540
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="https://www.w3.org/2001/XMLSchema"
xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ps:retrieve
soapenv:encodingStyle="https://schemas.xmlsoap.org/soap/encoding/"
xmlns:ps="https://psol.com/2004/ws/retrieve">
<address xsi:type="xsd:base64Binary">d3d3Lm1hcmNoYWwuY29t</address>
</ps:retrieve>
</soapenv:Body>
</soapenv:Envelope>
對 Java 開發者而言,可以透過 JAX-RPC(Java API for XML-based RPC)與 SAAJ(SOAP with Attachments API for Java)來處理附件。別被 SAAJ 這個名稱誤導了——JAX-RPC 其實同樣支援附件。兩者的差別在於抽象層次,而非功能多寡。
JAX-RPC 屬於高層 API,比 SAAJ 更抽象,它把絕大多數面向 SOAP 協定的細節都藏在 RMI 層背後。開發者面對的是 Java 物件,再由前處理器把它轉換成 SOAP 節點。JAX-RPC 使用 java.awt.Image 與 javax.activation.DataHandler 這兩個類別來表示附件。
SAAJ 則更貼近協定本身。用 SAAJ 建立 SOAP 訊息要比用 JAX-RPC 多花不少功夫(而且它不像 JAX-RPC 那樣能自動對接 WSDL),因此在大多數情況下,你大概會更青睞 JAX-RPC。不過,若是為了清楚說明附件究竟是如何運作的,由於其貼近底層的特性,SAAJ 反而更合適。清單 2 就是一個帶附件的 SOAP 請求,它要求伺服器縮放一張圖片;由於圖片體積龐大,改用附件顯然更有效率。
清單 2. 以附件承載參數
POST /ws/resize HTTP/1.0
Content-Type: multipart/related; type="text/xml";
start="<EB6FC7EDE9EF4E510F641C481A9FF1F3>";
boundary="----=_Part_0_7145370.1075485514903"
Accept: application/soap+xml, multipart/related, text/*
Host: localhost:8080
SOAPAction: ""
Content-Length: 1506005
------=_Part_0_7145370.1075485514903
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: binary
Content-Id: <EB6FC7EDE9EF4E510F641C481A9FF1F3>
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="https://www.w3.org/2001/XMLSchema"
xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ps:resize
soapenv:encodingStyle="https://schemas.xmlsoap.org/soap/encoding/"
xmlns:ps="https://psol.com/2004/ws/resize"
xmlns:SOAP-ENC="https://schemas.xmlsoap.org/soap/encoding/">
<source href="cid:E1A97E9D40359F85CA19D1B8A7C52AA3"/>
<percent>20</percent>
</ps:resize>
</soapenv:Body>
</soapenv:Envelope>
------=_Part_0_7145370.1075485514903
Content-Type: image/jpeg
Content-Transfer-Encoding: binary
Content-Id: <E1A97E9D40359F85CA19D1B8A7C52AA3>
note: binary data deleted...
------=_Part_0_7145370.1075485514903--
清單 3 示範了如何以程式建立這個 SOAP 請求,整段流程大致如下:
清單 3. 使用 SAAJ
public File resize(String endPoint, File file) {
SOAPConnection connection =
SOAPConnectionFactory.newInstance().createConnection();
SOAPMessage message = MessageFactory.newInstance().createMessage();
SOAPPart part = message.getSOAPPart();
SOAPEnvelope envelope = part.getEnvelope();
SOAPBody body = envelope.getBody();
SOAPBodyElement operation =
body.addBodyElement(
envelope.createName("resize",
"ps",
"https://psol.com/2004/ws/resize"));
operation.setEncodingStyle("https://schemas.xmlsoap.org/soap/encoding/");
DataHandler dh = new DataHandler(new FileDataSource(file));
AttachmentPart attachment = message.createAttachmentPart(dh);
SOAPElement source = operation.addChildElement("source", ""),
percent = operation.addChildElement("percent", "");
message.addAttachmentPart(attachment);
source.addAttribute(envelope.createName("href"),
"cid:" + attachment.getContentId());
percent.addTextNode("20");
SOAPMessage result = connection.call(message, endPoint);
part = result.getSOAPPart();
envelope = part.getEnvelope();
body = envelope.getBody();
if (!body.hasFault()) {
Iterator iterator = result.getAttachments();
if (iterator.hasNext()) {
dh = ((AttachmentPart) iterator.next()).getDataHandler();
String fname = dh.getName();
if (null != fname)
return new File(fname);
}
}
return null;
}
值得注意的是,清單 3 清楚地說明了附件是位於 XML 訊息的「外部」——這麼做正是為了兼顧效率。
說到效率,不妨看看清單 4,這是清單 3 更為常見、也更為精簡的 JAX-RPC 版本。JAX-RPC 的前處理器會產生一支存根程式(stub),大幅簡化了編碼工作:你只要把 DataHandler 物件當作參數傳入,JAX-RPC 便會自動生成附件。
清單 4. 更精簡的 JAX-RPC 寫法
public File resize(File file)
throws ServiceException, RemoteException {
AttachmentService service = new AttachmentServiceLocator();
AttachmentTip port = service.getAttachmentTip(); // get stub
DataHandler dh = new DataHandler(new FileDataSource(file));
DataHandler result = port.resize(dh, 20);
return new File(result.getName());
}
擁有選擇總是好事,而 SOAP 在處理二進位資料時確實給了你選擇的空間:資料集小的時候,可以在 XML 有效負載裡用 base 64 編碼;資料集大的時候,則可以把未經編碼的二進位檔案直接附加到請求中。依實際情境做出取捨,才能兼顧開發成本與傳輸效率。