回想 Web 的初創階段,它其實只是一座可被瀏覽的資訊集散地:頁面上擺著文件,使用者用瀏覽器一路點下去。但隨著頻寬、標準與程式語言都不斷成熟,「讓服務在網路上跑起來」這件事變得越來越有吸引力。B2B 與 B2C 之間的協同流程,某種意義上就是服務式 Web 的雛形。
那麼,網路上究竟能開哪些服務?清單其實長得驚人:
關鍵問題在於「怎麼開」。今天多數服務只提供 HTML 介面,靠文件形式對外溝通;可是介面背後藏著什麼?更重要的是,上網的裝置早就不只有瀏覽器——手機、PDA、甚至家電都想直接查資料庫、轉換資料、抽取欄位。要讓服務式 Web 真正成立,HTML 這個表現層底下必須再多一層,一層能被程式呼叫、與畫面無關的介面。
XML 大概是近十餘年最關鍵的標準之一,而 XML-RPC 則是把「服務放上網路」這件事變得簡單的那塊敲門磚。它成熟、易於採用,對 B2B 場景尤其重要:大家都遵循同一套標準,一家公司就能直接消費另一家公司提供的服務,快速疊加能力。試想若每個服務都自創一套私有協定,服務式 Web 根本無從建立。
RPC 是 Remote Procedure Call(遠端程序呼叫)的縮寫,指的是呼叫一個可能駐留在別台機器、甚至以別種語言實作的程序。它是分散式運算的支柱之一。舉例來說,在一個分散式計算環境裡,加法程序也許用 APL 寫、跑在 RS6000 上,減法程序用 C 寫、跑在某台 Unix 機器上;其他開發者要用的時候直接遠端呼叫即可,也可以換一台更好的計算器。
XML-RPC 把這套機制架在 HTTP 之上:請求與應答都是 XML 詞彙表。伺服器接收 XML-RPC 請求、回傳 XML-RPC 應答;用戶端則相反。雙方都必須依標準處理訊息。在 RPC 的世界裡,主角是「程序(procedure)」——伺服器提供的就是一堆可被呼叫的程序,每個程序可以收參數、回結果。
完整規範可查 https://www.xmlrpc.com/spec。以下是要點。
請求必須是 HTTP POST,本文主體是 XML。URL 指向哪裡並未寫在 XML 裡——若伺服器專門做 RPC 處理,路徑往往就是「/」。
<?xml version="1.0"?>
<methodCall>
<methodName>examples.getStateName</methodName>
<params>
<param>
<value><i4>41</i4></value>
</param>
</params>
</methodCall>
有效負載是一個 methodCall 結構,其中 methodName 描述要呼叫的方法;至於這個字串怎麼解讀,完全由伺服器決定——可以是執行檔名、資料庫裡的記錄名,或任何約定。params 底下可放多個 param,每個值都帶型別描述符:
| 標記 | 意義 |
|---|---|
<i4> 或 <int> | 四 bytes 帶正負號整數,例如 12 |
<boolean> | 0 代表 false,1 代表 true |
<string> | 字串,例如 Hello World |
<double> | 雙精度帶正負號浮點數,例如 -12.214 |
<dateTime.iso8601> | 日期時間,例如 19980717T14:08:55 |
<base64> | base64 編碼的二進位資料 |
值也可以是結構。用 <struct> 描述,裡頭每個 <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>
陣列則用 <array>,裡面必須有一個 <data>,再放任意多個 <value>。陣列本身沒有名字,元素型別可以各不相同:
<array>
<data>
<value><boolean>0</boolean></value>
<value><i4>9</i4></value>
<value><string>Hello</string></value>
</data>
</array>
struct 與 array 都可以互相嵌套,任何 <value> 裡都能再塞一層結構或陣列。
應答是一個 HTTP 回應,Content-Type 為 text/xml:
<?xml version="1.0"?>
<methodResponse>
<params>
<param>
<value><string>ABCDEFG</string></value>
</param>
</params>
</methodResponse>
如果程序呼叫失敗,<methodResponse> 裡改放一個 <fault> 結構,慣例是兩個成員:faultCode 與 faultString。
<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 服務,使用者、客戶端軟體、甚至其他企業就能把它們組裝成更高階的服務或終端應用。這種「更有效、更便宜、品質更好」的競爭,會直接把整體應用服務的水準往上推。
當然仍有未解的問題,例如要怎麼編目、索引、搜尋網路上的服務。UDDI 想處理這件事,但標準本身不簡單,業界反應也還不明朗。不過即使暫時不談對外服務,單是在企業內部採用 XML-RPC,就能改善程式碼的可重用性,並帶來一種全新的分散式運算模式。
對提供 Web 服務而言,PHP 是個相當理想的語言——寫好一支 PHP 程式放到適當位置,馬上就有一個能用 URL「呼叫」的服務。PHP 的 XML-RPC 實作有簡單也有複雜的,選擇不少。本文採用 Useful Information Company 的版本,程式碼與文件可從 https://xmlrpc.usefulinc.com/ 取得,核心只涉及兩個檔案:
<?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 '狀態代碼 ' . $_POST['stateno'] . ' 是 ' .
$v->scalarval() . '<br>';
print '<hr>這是伺服器的應答<br><pre>' .
htmlentities($r->serialize()) . '</pre><hr>' . "\n";
} else {
print '錯誤:';
print '代碼:' . $r->faultCode() .
' 原因:' . $r->faultString() . '<br>';
}
?>
這段程式先建立一個呼叫 examples.getStateName 的訊息,傳入型別 int、值為 14 的參數;接著建立描述目標 URL(路徑、主機、埠號)的用戶端;送出後取得應答物件並檢查錯誤,沒錯就印出結果。
幾個主要函式:
// 建立用戶端 $client = new xmlrpc_client($server_path, $server_hostname, $server_port); // 送出訊息,回傳 xmlrpcresp 實例 $response = $client->send($xmlrpc_message); // 建立訊息,$parameterArray 是 xmlrpcval 物件的陣列 $msg = new xmlrpcmsg($methodName, $parameterArray);
xmlrpcval 有三種建立形式:
<?php
$myVal = new xmlrpcval($stringVal);
$myVal = new xmlrpcval($scalarVal, 'int' | 'boolean' | 'string'
| 'double' | 'dateTime.iso8601' | 'base64');
$myVal = new xmlrpcval($arrayVal, 'array' | 'struct');
?>
第一種建立字串值,第二種明確指定值與型別,第三種則透過組合其他 xmlrpcval 來建構複雜物件:
<?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() 取得;在伺服器端則這樣建立:$resp = new xmlrpcresp($xmlrpcval);。取得值的方式是 $xmlrpcVal = $resp->value();,再視情況用 $val->scalarval() 取出純量。
面對複雜結構,xmlrpc.inc 還提供兩個好用的互轉函式:
$arr = xmlrpc_decode($xmlrpc_val); // xmlrpcval → PHP 陣列 $xmlrpc_val = xmlrpc_encode($phpval); // PHP 變數 → xmlrpcval(可遞迴)
要注意的是,xmlrpc_encode 不支援 base64、日期時間這類非基本型別。
<?php
$s = new xmlrpc_server(array(
'examples.myFunc' => array('function' => 'foo')
));
?>
傳進 xmlrpc_server 建構子的是一個關聯陣列:examples.myFunc 這個對外名稱對應到 foo 這個 PHP 函式,後者就稱為方法處理常式(method handler)。方法處理常式的骨架大致如下:
<?php
function foo($params) {
global $xmlrpcerruser; // 使用者錯誤碼起算值
// $params 是 xmlrpcval 物件的陣列
if ($err) {
return new xmlrpcresp(0, $xmlrpcerruser + 1, 'Error!');
} else {
return new xmlrpcresp(new xmlrpcval('Fine!', 'string'));
}
}
?>
有錯就回傳錯誤(錯誤碼從 $xmlrpcerruser + 1 起算),一切正常則回傳帶著結果的 xmlrpcresp。
伺服器端:
<?php
include('xmlrpc.inc');
include('xmlrpcs.inc');
function foo($params) {
global $xmlrpcerruser;
$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 ($_POST['number'] !== '') {
$f = new xmlrpcmsg('product', array(
new xmlrpcval($_POST['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 ' . $_POST['number'] . ' is ' . $v->scalarval() . '<br>';
print '<hr>來自伺服器的結果<br><pre>' .
htmlentities($r->serialize()) . '</pre><hr>' . "\n";
} else {
print '操作失敗:代碼 ' . $r->faultCode() .
' 原因:' . $r->faultString() . '<br>';
}
}
?>
<form method="post">
輸入一個數值
<input name="number" value="">
<input type="submit" value="go" name="submit">
</form>
把兩支程式分別放上去,開啟用戶端頁面輸入 5,就會得到 10。
XML-RPC 服務要真正跑得好,背後還需要不少基礎設施:分散式程序的編目與索引機制、各語言中更好用的 XML-RPC 介面、錯誤處理與版本管理的慣例等等。這些標準仍在演進,值得持續關注。
順帶一提,本文範例中的 $HTTP_POST_VARS 屬於舊版 PHP 寫法,在 PHP 5.4 之後已被移除,實作時請改用 $_POST;類別名稱中的 xmlrpc_client 在原始套件裡也常寫成 xmlrpc_client/XMLRPC_Client 混用,PHP 4 時代對大小寫不敏感,如今則需留意命名空間與自動載入的安排。