未來的 Web 將是以服務為中心的 Web,而 XML-RPC 標準讓編寫與應用服務變得非常簡單。本文介紹 XML-RPC 標準及其在 PHP 中的實作,並透過實例示範如何在 PHP 中開發 XML-RPC 服務與客戶程式。
從內容提供商採用的簡單做法,到 UDDI(Universal Description, Discovery and Integration)的未來構想,業界已有大量關於「服務式 Web」的說明與評論。就 Web 的初創階段而言,它只是一個文檔集散地,提供的僅是可瀏覽的資訊。隨著 Web 的發展,在 Web 上運行服務越來越具吸引力——未來,Web 將成為企業為客戶與其他企業提供便捷服務的載體,B2B 與 B2C 模式之間的協同,便可視為一種服務式 Web。
一個很重要的問題是:Web 上究竟能提供哪些服務?可提供的服務不勝枚舉,有些已在運行,有些則在不久的將來便會問世,以下列出了一小部分可透過 Web 提供的服務:
那麼,企業與組織透過 Web 提供服務的正確途徑是什麼?這是個關鍵問題。今天,有些服務提供 HTML 介面,以文檔形式提供服務,但在服務介面的背後隱藏著什麼?在爭奪 Web 的競賽中,瀏覽器並不孤單,手機、手持裝置乃至微波爐之類的設備都想存取 Web、查詢資料庫、轉換資料、擷取資訊等等。要實現真正的服務式 Web,在表現層(HTML)之下,應該還有另一層。
XML 或許是近十年來最重要的標準,XML 詞彙表(vocabulary)為企業構造服務環境奠定了基石。要構建服務式 Web,就有必要學習 XML-RPC 標準——這不僅因為 XML-RPC 對把服務放上 Web 很有用,更因為它是一種已然成形、易於採用的標準。對 B2B 服務而言,提供服務的標準極其重要:共同遵循標準的公司,能藉由其他公司提供的服務獲得快速增長。難以想像能在各種私有的服務標準之上建立起真正的服務式 Web,服務必須有可遵循的標準。
XML-RPC 是一種面向網際網路分散式處理的標準。RPC 即 remote procedure call(遠程程序呼叫)的縮寫,是一種遠程呼叫機制,用於呼叫可能駐留於其他機器、且可能以其他語言撰寫的程序。遠程程序呼叫是分散式運算的重要支柱。舉例來說,在一個分散式運算環境中,我們可以尋找並利用在其他機器上運行的加法與減法程序:執行加法的程序可能以 APL 撰寫、運行於 RS6000 機器上,執行減法的程序則可能以 C 撰寫、運行於 UNIX 上,其他開發者同樣能加以利用,或另選更好的計算器。
在 RPC 中,程序(procedure)是最主要的構件,伺服器提供的便是供客戶端呼叫的程序。程序可以接收參數並回傳結果。XML-RPC 以 HTTP 作為協議載體,透過傳送與接收資料的 XML 詞彙表來實現 RPC 機制:XML-RPC 伺服器接收請求並回傳應答,XML-RPC 客戶程式則傳送請求並接收應答,兩者都必須依 XML-RPC 標準的要求來處理請求與應答。
完整的 XML-RPC 規範可在 https://www.xmlrpc.com/spec 找到,以下是要點說明。
XML-RPC 請求
XML-RPC 請求應為 HTTP POST 請求,其正文為 XML 格式。請求的 XML 部分格式如下:
<?xml version="1.0" ?> <methodCall> <methodName>examples.getStateName</methodName> <params> <param> <value><i4>41</i4></value> </param> </params> </methodCall>
指定資料送往何處的 URL 並未在此表明。若伺服器專門用來進行 RPC 處理,它可能是「/」。上述 XML 文檔中的有效載荷是一個 methodCall 結構,它必須包含一個 methodName 子元素,後者含有描述待呼叫方法的字串。如何解讀 methodName 的內容,完全由伺服器決定——它可以是一個執行檔名、資料庫中記錄的名稱,或任何其他東西。若程序接收參數,methodCall 可包含一個 params 元素及若干 param 子元素,每個 param 元素都含一個帶型別描述符的值,型別描述符如下表所示:
標記說明
<i4> 或 <int>:四字節帶正負號的整數,如 12
<boolean>:0(false)或 1(true)
<string>:字串,如「hello world」
<double>:雙精度帶正負號的浮點數,如 -12.214
<dateTime.iso8601>:日期/時間,如 19980717T14:08:55
<base64>:base64 編碼的二進位資料,如 eW91IGNhbiB0aGlsbHk=
結構(struct)
值可以是一個結構,結構以 <struct> 元素描述,每個 <struct> 包含多個 <member>,每個 <member> 含一個 <name> 與一個 <value>。以下是一個由兩個成員構成的結構:
<struct> <member> <name>name</name> <value><string>member1</string></value> </member> <member> <name>member2</name> <value><i4>19</i4></value> </member> </struct>
<struct> 可以嵌套,任何 <value> 都能包含 <struct> 或任何其他型別。
陣列(array)
值也可以是陣列型別,陣列以 <array> 元素描述,每個 <array> 包含一個 <data> 元素,其中可含任意多個 <value>。以下是陣列元素的一個例子:
<array> <data> <value><boolean>0</boolean></value> <value><i4>9</i4></value> <value><string>hello</string></value> </data> </array>
<value> 元素沒有名稱,其值可以是前述各種類型;<array> 也可嵌套,任何 <value> 都能包含 <array> 或其他型別。
XML-RPC 應答
XML-RPC 應答是一個 HTTP 應答,內容型別為 text/xml,其正文格式如下:
<?xml version="1.0"?> <methodResponse> <params> <param> <value><string>abcdefg</string></value> </param> </params> </methodResponse>
其中可能包含一個 <params>,也可能包含一個 <fault>,取決於程序呼叫是否成功。<fault> 的語法如下:
<fault> <value> <struct> <member> <name>faultCode</name> <value><int>4</int></value> </member> <member> <name>faultString</name> <value><string>error!</string></value> </member> </struct> </value> </fault>
利用 XML-RPC 構造與使用服務相當便利。企業為自身提供的各種服務部署 XML-RPC 伺服器,用戶、客戶軟體與客戶企業便能據此構造出高端服務或面向最終用戶的應用。這種更有效、廉價而優質的服務競爭,將大幅提高應用服務的質量。
但仍有問題有待解決,例如:該如何編目、索引、搜尋 Web 上的服務?UDDI 試圖解決這個問題,但這個標準並不簡單,業界對它的反應也尚未明朗。然而,在企業內部應用 XML-RPC,不僅能改善代碼的可重用性,還會帶來一種全新的分散式運算模式,在未來數年中它必將成為重要的知識資產。XML-RPC 從解決分散式運算問題、成為服務式 Web 的基本層面起步,可謂開了個好頭,其後想必將緊隨人們對該標準的熱忱。既然如此,我們就來看看 XML-RPC 的實際應用吧!
在 PHP 中應用 XML-RPC
對提供 Web 服務而言,PHP 是一種非常理想的語言。我們只需寫好 PHP 代碼並放到合適的位置,便立即擁有一個可透過 URL「呼叫」的服務。PHP 中的 XML-RPC 實作可繁可簡,選擇眾多,這裡我們採用來自 Useful Information Company 的 XML-RPC 實作,其代碼與文檔可從 https://xmlrpc.usefulinc.com/ 下載。
這個 XML-RPC 實作涉及兩個基本檔案:
客戶端
編寫 XML-RPC 客戶端意味著:建立一個 XML-RPC 請求訊息、設定 XML-RPC 參數、建立 XML-RPC 訊息、傳送訊息、取得應答,並解讀應答。請看下面這個例子:
<?php
$f = new xmlrpcmsg('examples.getStateName',
array(new xmlrpcval(14, "int")));
$c = new xmlrpc_client("/rpc2", "betty.userland.com", 80);
$r = $c->send($f);
$v = $r->value();
if (!$r->faultCode()) {
print "狀態代碼 14 是 " . $v->scalarval() . "<br>";
print "<hr>這是伺服器的應答<br><pre>" . htmlentities($r->serialize()) . "</pre><hr>\n";
} else {
print "錯誤: ";
print "代碼: " . $r->faultCode() . " 原因: " . $r->faultString() . "<br>";
}
?>
本例中,我們先建立一個呼叫 examples.getStateName 方法的 XML-RPC 訊息,並傳入一個型別為 int、值為 14 的整數參數;接著建立一個描述待呼叫 URL(路徑、網域與連接埠)的客戶;然後傳送訊息、接收應答物件並檢查錯誤,若無錯誤便顯示結果。
編寫 RPC 客戶程式時要用到的主要函式如下。建立客戶用:
$client = new xmlrpc_client($server_path, $server_hostname, $server_port);
傳送訊息的方法是:
$response = $client->send($xmlrpc_message);
它會回傳一個 xmlrpcresp 的執行個體;我們傳入的訊息則是 xmlrpcmsg 的執行個體,用如下方法建立:
$msg = new xmlrpcmsg($methodname, $parameterarray);
其中 methodname 是待呼叫的方法(程序)名稱,parameterarray 是 xmlrpcval 物件的 PHP 陣列。例如:
$msg = new xmlrpcmsg("examples.getStateName",
array(new xmlrpcval(23, "int")));
xmlrpcval 物件可用如下形式建立:
<?php
$myval = new xmlrpcval($stringval);
$myval = new xmlrpcval($scalarval, "int" | "boolean" |
"string" | "double" | "dateTime.iso8601" | "base64");
$myval = new xmlrpcval($arrayval, "array" | "struct");
?>
第一種形式建立的是 xmlrpc 字串值;第二種形式建立的是描述值與型別的值;第三種形式則透過在陣列之類的結構中組合其他 xmlrpc 值,建立複雜物件,例如:
<?php
$myarray = new xmlrpcval(array(
new xmlrpcval("tom"),
new xmlrpcval("dick"),
new xmlrpcval("harry")), "array");
$mystruct = new xmlrpcval(array(
"name" => new xmlrpcval("tom"),
"age" => new xmlrpcval(34, "int"),
"geek" => new xmlrpcval(1, "boolean")), "struct");
?>
應答物件是 xmlrpcresp 型別,透過呼叫客戶物件的 send 方法取得。在伺服器端,可用如下方式建立 xmlrpcresp 型別的物件:
$resp = new xmlrpcresp($xmlrpcval);
而在客戶端,則用如下方法從應答取得 xmlrpcval:
$xmlrpcval = $resp->value();
接著,我們就能用下面的方式取得描述應答結果的 PHP 變數:
$scalarval = $val->scalarval();
對於複雜資料型別,有兩個函式非常有用,它們都在 xmlrpc.inc 內:
$arr = xmlrpc_decode($xmlrpc_val);
該函式回傳一個 PHP 陣列,其中包含 xmlrpcval 變數 $xmlrpc_val 內、已轉換成 PHP 原生型別的資料。
$xmlrpc_val = xmlrpc_encode($phpval);
該函式回傳一個 xmlrpcval 型別的值,其中包含 $phpval 所描述的 PHP 資料;對於陣列與結構,它能遞迴分析。注意,這裡不支援非基本資料型別(如 base-64 資料或日期時間資料)。
伺服器端
利用 xmlrpcs.inc 提供的類別來編寫服務非常簡單。要建立一個服務,我們依如下方式建立 xmlrpc_server 的執行個體:
<?php
$s = new xmlrpc_server(array(
"examples.myfunc" => array("function" => "foo")));
?>
傳給 xmlrpc_server 建構子的是一個關聯陣列的關聯陣列,程序 examples.myfunc 會呼叫 foo 函式,因此 foo 被稱為方法句柄。編寫方法句柄非常簡單,以下是方法句柄的骨架:
<?php
function foo($params) {
global $xmlrpcerruser; // 引入用戶錯誤代碼值
// $params 是 xmlrpcval 物件的陣列
if ($err) {
// 錯誤條件
return new xmlrpcresp(0, $xmlrpcerruser + 1, // 用戶錯誤 1
"error!");
} else {
// 成功
return new xmlrpcresp(new xmlrpcval("fine!", "string"));
}
}
?>
可以看到,程式會檢查錯誤,若存在錯誤則回傳錯誤(從 $xmlrpcerruser + 1 起算),否則若一切正常,則回傳描述操作成功資訊的 xmlrpcresp。
下面這個例子中,我們將構造一個服務:對於給定的數值 n,服務回傳 n × 2;客戶端則利用該服務計算 5 × 2 的值。伺服器端代碼如下:
<?php
include("xmlrpc.inc");
include("xmlrpcs.inc");
function foo($params) {
global $xmlrpcerruser; // 引入用戶錯誤代碼值
// $params 是 xmlrpcval 物件的一個陣列
$vala = $params->params[0];
$sval = $vala->scalarval();
$ret = $sval * 2;
return new xmlrpcresp(new xmlrpcval($ret, "int"));
}
$s = new xmlrpc_server(array("product" => array("function" => "foo")));
?>
客戶端代碼如下:
<?php
include("xmlrpc.inc");
if ($http_post_vars["number"] != "") {
$f = new xmlrpcmsg('product', array(new xmlrpcval(
$http_post_vars["number"], "int")));
$c = new xmlrpc_client("/xmlrpc/servfoo.php",
"luigi.melpomenia.com.ar", 80);
$c->setDebug(0);
$r = $c->send($f);
$v = $r->value();
if (!$r->faultCode()) {
print "number " . $http_post_vars["number"] . " is " . $v->scalarval() . "<br>";
print "<hr>來自伺服器的結果!<br><pre>" . htmlentities($r->serialize()) . "</pre><hr>\n";
} else {
print "操作失敗: ";
print "代碼: " . $r->faultCode() . " 原因: " . $r->faultString() . "<br>";
}
}
print "<form method=\"post\">
<input name=\"number\" value=\"${number}\">
<input type=\"submit\" value=\"go\" name=\"submit\"></form><p> 輸入一個數值";
?>
結語:XML-RPC 服務的運作,還涉及許多其他基礎設施與基礎工作,如分散式程序的編目與索引機制,以及在程式語言中處理 XML-RPC 的更完善介面等。有關 XML-RPC 與服務式 Web 的報導非常多,讓我們密切關注它們的發展吧!