PHP中XML-RPC構造Web Service

PHP中集成瞭XML-RPC和SOAP兩種協議的訪問,都是集中在xmlrpc擴展當中。另外,在PHP的PEAR中,不管是PHP 4還是PHP 5,都已經默認集成瞭XML-RPC擴展,而且該擴展跟xmlrpc擴展無關,能夠獨立實現XML-RPC的協議交互,如果沒有xmlrpc擴展,建議使用PEAR::XML-RPC擴展。


Web Service介紹


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


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


安裝xmlrpc擴展


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


在Windows平臺下,首先把PHP安裝目錄下的擴展php_xmlrpc.dll放到C:Windows或者C:Winnt目錄下,(PHP4的擴展在C:phpextensions目錄中,PHP5的擴展在C:phpext目錄中),同時在C:Windowsphp.ini或者C: Winntphp.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
User_Agent: XML-RPC Client
Host: “.$host.”
Content-Type: text/xml
Content-Length: “.strlen($request).”

“.$request.”
“;


   //把構造好的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手冊,想獲取詳細信息建議參考手冊,如果文章有不正確,請指正。
本篇文章來源於 PHP資訊 原文鏈接:http://www.phpchina.com/html/84/n-33884.html

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。 必填欄位標示為 *