PHP中使用XML-RPC構造Web Service簡單入門

Web Service就是為了異構系統的通訊而產生的，它基本的思想就是使用基於XML的HTTP的遠程調用提供一種標準的機制，而省去建立一種新協議的需求。目前進行Web Service通訊有兩種協議標準，一種是XML-RPC，另外一種是SOAP。XML-RPC比較簡單，出現時間比較早，SOAP比較複雜，主要是一些需要穩定、健壯、安全並且複雜互動的時候使用。

 

* 作者：heiyeluren
* 時間：2006-03-05
* 部落格：http://blog.csdn.net/heiyeshuwu

[  Web Service介紹 ]

Web Service就是為了異構系統的通訊而產生的，它基本的思想就是使用基於XML的HTTP的遠程調用提供一種標準的機制，而省去建立一種新協議的需求。目前進行Web Service通訊有兩種協議標準，一種是XML-RPC，另外一種是SOAP。XML-RPC比較簡單，出現時間比較早，SOAP比較複雜，主要是一些需要穩定、健壯、安全並且複雜互動的時候使用。

PHP中整合了XML-RPC和SOAP兩種協議的訪問，都是集中在xmlrpc擴充當中。另外，在PHP的PEAR中，不管是PHP 4還是PHP 5，都已經預設整合了XML-RPC擴充，而且該擴充跟xmlrpc擴充無關，能夠獨立實現XML-RPC的協議互動，如果沒有xmlrpc擴充，建議使用PEAR::XML-RPC擴充。

我們這裡主要是以XML-RPC來簡單描述Web Service的互動過程，部分內容來自PHP手冊，更詳細內容，建議參考手冊。

[  安裝xmlrpc擴充 ]

如果你的系統中沒有安裝xmlrpc的php擴充，那麼請正確安裝。

在Windows平台下，首先把PHP安裝目錄下的擴充php_xmlrpc.dll放到C:/Windows或者C:/Winnt目錄下，(PHP4的擴充在C:/php/extensions目錄中，PHP5的擴充在C:/php/ext目錄中)，同時在C:/Windows/php.ini或者C:/Winnt/php.ini中把extension=php_xmlrpc.dll前面的分號";"去掉，然後重啟Web伺服器後查看phpinfo()有沒有XML-RPC項目就能夠確定是否已經正確安裝xmlrpc擴充。

在Unix/Linux平台下，如果沒有安裝xmlrpc擴充，請在重新編譯PHP，在configure的時候請加入 --with-xmlrpc 選項，然後查看phpinfo()看是否正常安裝xmlrpc。

(注意：以下操作都是建立在xmlrpc擴張正常安裝前提下，請務必正確安裝。)

[  XML-RPC工作原理 ]

XML-RPC大致就是整個過程就是使用XML來進行通訊。首先構造一個RPC 伺服器端用來出來從RPC用戶端傳遞過來的使用XML封裝的請求，並且把處理結果通過XML的形式返回給RPC用戶端，用戶端就去分析XML擷取自己需要的資料。

XML-RPC的伺服器端必須有現成的函數提供給用戶端調用，並且用戶端提交的請求中的函數和方法必須和伺服器端的一致，否則將無法擷取所需要的結果。

下面我進行簡單的代碼來描述整個過程。

[  XML-RPC實踐 ]

伺服器端使用xmlrpc_server_create函數產生一個伺服器端，然後把需要需要暴露的RPC調用介面進行註冊，接受RPC用戶端POST過來的XML資料，然後進行處理，處理結果通過XML的形式顯示給用戶端。

代碼如下： rpc_server.php

<?php
/**
 * 函數：提供給RPC用戶端調用的函數
 * 參數：
 * $method 用戶端需要調用的函數
 * $params 用戶端需要調用的函數的參數數組
 * 返回：返回指定調用結果
 */
function rpc_server_func($method, $params) {
 $parameter = $params[0];
   if ($parameter == "get")
   {
       $return = 'This data by get method';
   }
   else
   {
       $return = 'Not specify method or params';
   }
   return $return;
}

//產生一個XML-RPC的伺服器端
$xmlrpc_server = xmlrpc_server_create();

//註冊一個伺服器端調用的方法rpc_server，實際指向的是rpc_server_func函數
xmlrpc_server_register_method($xmlrpc_server, "rpc_server", "rpc_server_func");

//接受用戶端POST過來的XML資料
$request = $HTTP_RAW_POST_DATA;

//執行調用用戶端的XML請求後擷取執行結果
$xmlrpc_response = xmlrpc_server_call_method($xmlrpc_server, $request, null);

//把函數處理後的結果XML進行輸出
header('Content-Type: text/xml');
echo $xmlrpc_response;

//銷毀XML-RPC伺服器端資源
xmlrpc_server_destroy($xmlrpc_server);
?>

伺服器端構造好了，那麼再構造我們的RPC用戶端。用戶端大致通過Socket訪問XML-RPC伺服器端的80連接埠，然後把需要調用的RPC介面封裝到XML裡，通過POST請求提交給RPC伺服器端，最後擷取伺服器端返回結果。

代碼如下：rpc_client.php

<?php
/**
 * 函數：提供給用戶端進行串連XML-RPC伺服器端的函數
 * 參數：
 * $host  需要串連的主機
 * $port  串連主機的連接埠
 * $rpc_server XML-RPC伺服器端檔案
 * $request  封裝的XML請求資訊
 * 返回：串連成功成功返回由伺服器端返回的XML資訊，失敗返回false
 */
function rpc_client_call($host, $port, $rpc_server, $request) {

   //開啟指定的伺服器端
   $fp = fsockopen($host, $port);

   //構造需要進行通訊的XML-RPC伺服器端的查詢POST請求資訊
   $query = "POST $rpc_server HTTP/1.0/nUser_Agent: XML-RPC Client/nHost: ".$host."/nContent-Type: text/xml/nContent-Length: ".strlen($request)."/n/n".$request."/n";

   //把構造好的HTTP協議發送給伺服器，失敗返回false
   if (!fputs($fp, $query, strlen($query)))
   {
       $errstr = "Write error";
       return false;
   }
  
   //擷取從伺服器端返回的所有資訊，包括HTTP頭和XML資訊
   $contents = '';
   while (!feof($fp))
   {
       $contents .= fgets($fp);
   }

   //關閉串連資源後返回擷取的內容
   fclose($fp);
   return $contents;
}

//構造串連RPC伺服器端的資訊
$host  = 'localhost';
$port  = 80;
$rpc_server = '/~heiyeluren/rpc_server.php';

//把需要發送的XML請求進行編碼成XML，需要調用的方法是rpc_server，參數是get
$request = xmlrpc_encode_request('rpc_server', 'get');

//調用rpc_client_call函數把所有請求發送給XML-RPC伺服器端後擷取資訊
$response = rpc_client_call($host, $port, $rpc_server, $request);

//分析從伺服器端返回的XML，去掉HTTP頭資訊，並且把XML轉為PHP能識別的字串
$split = '<?xml version="1.0" encoding="iso-8859-1"?>';
$xml =  explode($split, $response);
$xml = $split . array_pop($xml);
$response = xmlrpc_decode($xml);

//輸出從RPC伺服器端擷取的資訊
print_r($response);

?>

大致我們上面的例子就是提交一個叫做rpc_server的方法過去，參數是get，然後擷取伺服器端的返回，伺服器端返回的XML資料是：

<?xml version="1.0" encoding="iso-8859-1"?>
<methodResponse>
<params>
 <param>
  <value>
   <string>This data by get method</string>
  </value>
 </param>
</params>
</methodResponse>

那麼我們再通過xmlrpc_decode函數把這個XML編碼為PHP的字串，我們就能夠隨意處理了，整個Web Service互動完成。

[  結束語 ]

不管是XML-RPC也好，SOAP也罷，只要能夠讓我們穩定、安全的進行遠程過程的調用，完成我們的項目，那麼就算整個Web Service就是成功的。另外，如果可以的話，也可以嘗試使用PEAR中的XML-RPC來實現上面類似的操作，說不定會更簡單，更適合你使用。

簡單的使用XML-RPC進行Web Service互動就完成了，部分代碼參考PHP手冊，想擷取詳細資料建議參考手冊，如果文章有不正確，請指正。