PHP中使用XML-RPC構(gòu)造Web Service容易基礎(chǔ)
發(fā)表時(shí)間:2024-06-08 來(lái)源:明輝站整理相關(guān)軟件相關(guān)文章人氣:
[摘要]* 作者:heiyeluren* 時(shí)間:2006-03-05* 博客:http://blog.csdn.net/heiyeshuwu[ Web Service介紹 ]Web Service就是為了異構(gòu)系統(tǒng)的通信而產(chǎn)生的,它基本的思想就是使用基于XML的HTTP的遠(yuǎn)程調(diào)用提供一種標(biāo)準(zhǔn)的機(jī)制,而省去...
* 作者:heiyeluren
* 時(shí)間:2006-03-05
* 博客:http://blog.csdn.net/heiyeshuwu
[ Web Service介紹 ]
Web Service就是為了異構(gòu)系統(tǒng)的通信而產(chǎn)生的,它基本的思想就是使用基于XML的HTTP的遠(yuǎn)程調(diào)用提供一種標(biāo)準(zhǔn)的機(jī)制,而省去建立一種新協(xié)議的需求。目前進(jìn)行Web Service通信有兩種協(xié)議標(biāo)準(zhǔn),一種是XML-RPC,另外一種是SOAP。XML-RPC比較簡(jiǎn)單,出現(xiàn)時(shí)間比較早,SOAP比較復(fù)雜,主要是一些需要穩(wěn)定、健壯、安全并且復(fù)雜交互的時(shí)候使用。
PHP中集成了XML-RPC和SOAP兩種協(xié)議的訪問(wèn),都是集中在xmlrpc擴(kuò)展當(dāng)中。另外,在PHP的PEAR中,不管是PHP 4還是PHP 5,都已經(jīng)默認(rèn)集成了XML-RPC擴(kuò)展,而且該擴(kuò)展跟xmlrpc擴(kuò)展無(wú)關(guān),能夠獨(dú)立實(shí)現(xiàn)XML-RPC的協(xié)議交互,如果沒(méi)有xmlrpc擴(kuò)展,建議使用PEAR::XML-RPC擴(kuò)展。
我們這里主要是以XML-RPC來(lái)簡(jiǎn)單描述Web Service的交互過(guò)程,部分內(nèi)容來(lái)自PHP手冊(cè),更詳細(xì)內(nèi)容,建議參考手冊(cè)。
[ 安裝xmlrpc擴(kuò)展 ]
如果你的系統(tǒng)中沒(méi)有安裝xmlrpc的php擴(kuò)展,那么請(qǐng)正確安裝。
在Windows平臺(tái)下,首先把PHP安裝目錄下的擴(kuò)展php_xmlrpc.dll放到C:\Windows或者C:\Winnt目錄下,(PHP4的擴(kuò)展在C:\php\extensions目錄中,PHP5的擴(kuò)展在C:\php\ext目錄中),同時(shí)在C:\Windows\php.ini或者C:\Winnt\php.ini中把extension=php_xmlrpc.dll前面的分號(hào)";"去掉,然后重啟Web服務(wù)器后查看phpinfo()有沒(méi)有XML-RPC項(xiàng)目就能夠確定是否已經(jīng)正確安裝xmlrpc擴(kuò)展。
在Unix/Linux平臺(tái)下,如果沒(méi)有安裝xmlrpc擴(kuò)展,請(qǐng)?jiān)谥匦戮幾gPHP,在configure的時(shí)候請(qǐng)加入 --with-xmlrpc 選項(xiàng),然后查看phpinfo()看是否正常安裝xmlrpc。
(注意:以下操作都是建立在xmlrpc擴(kuò)張正常安裝前提下,請(qǐng)務(wù)必正確安裝。)
[ XML-RPC工作原理 ]
XML-RPC大致就是整個(gè)過(guò)程就是使用XML來(lái)進(jìn)行通信。首先構(gòu)造一個(gè)RPC 服務(wù)器端用來(lái)出來(lái)從RPC客戶端傳遞過(guò)來(lái)的使用XML封裝的請(qǐng)求,并且把處理結(jié)果通過(guò)XML的形式返回給RPC客戶端,客戶端就去分析XML獲取自己需要的數(shù)據(jù)。
XML-RPC的服務(wù)器端必須有現(xiàn)成的函數(shù)提供給客戶端調(diào)用,并且客戶端提交的請(qǐng)求中的函數(shù)和方法必須和服務(wù)器端的一致,否則將無(wú)法獲取所需要的結(jié)果。
下面我進(jìn)行簡(jiǎn)單的代碼來(lái)描述整個(gè)過(guò)程。
[ XML-RPC實(shí)踐 ]
服務(wù)器端使用xmlrpc_server_create函數(shù)產(chǎn)生一個(gè)服務(wù)器端,然后把需要需要暴露的RPC調(diào)用接口進(jìn)行注冊(cè),接受RPC客戶端POST過(guò)來(lái)的XML數(shù)據(jù),然后進(jìn)行處理,處理結(jié)果通過(guò)XML的形式顯示給客戶端。
代碼如下: rpc_server.php
<?php
/**
* 函數(shù):提供給RPC客戶端調(diào)用的函數(shù)
* 參數(shù):
* $method 客戶端需要調(diào)用的函數(shù)
* $params 客戶端需要調(diào)用的函數(shù)的參數(shù)數(shù)組
* 返回:返回指定調(diào)用結(jié)果
*/
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;
}
//產(chǎn)生一個(gè)XML-RPC的服務(wù)器端
$xmlrpc_server = xmlrpc_server_create();
//注冊(cè)一個(gè)服務(wù)器端調(diào)用的方法rpc_server,實(shí)際指向的是rpc_server_func函數(shù)
xmlrpc_server_register_method($xmlrpc_server, "rpc_server", "rpc_server_func");
//接受客戶端POST過(guò)來(lái)的XML數(shù)據(jù)
$request = $HTTP_RAW_POST_DATA;
//執(zhí)行調(diào)用客戶端的XML請(qǐng)求后獲取執(zhí)行結(jié)果
$xmlrpc_response = xmlrpc_server_call_method($xmlrpc_server, $request, null);
//把函數(shù)處理后的結(jié)果XML進(jìn)行輸出
header(''Content-Type: text/xml'');
echo $xmlrpc_response;
//銷毀XML-RPC服務(wù)器端資源
xmlrpc_server_destroy($xmlrpc_server);
?>
服務(wù)器端構(gòu)造好了,那么再構(gòu)造我們的RPC客戶端?蛻舳舜笾峦ㄟ^(guò)Socket訪問(wèn)XML-RPC服務(wù)器端的80端口,然后把需要調(diào)用的RPC接口封裝到XML里,通過(guò)POST請(qǐng)求提交給RPC服務(wù)器端,最后獲取服務(wù)器端返回結(jié)果。
代碼如下:rpc_client.php
<?php
/**
* 函數(shù):提供給客戶端進(jìn)行連接X(jué)ML-RPC服務(wù)器端的函數(shù)
* 參數(shù):
* $host 需要連接的主機(jī)
* $port 連接主機(jī)的端口
* $rpc_server XML-RPC服務(wù)器端文件
* $request 封裝的XML請(qǐng)求信息
* 返回:連接成功成功返回由服務(wù)器端返回的XML信息,失敗返回false
*/
function rpc_client_call($host, $port, $rpc_server, $request) {
//打開(kāi)指定的服務(wù)器端
$fp = fsockopen($host, $port);
//構(gòu)造需要進(jìn)行通信的XML-RPC服務(wù)器端的查詢POST請(qǐng)求信息
$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";
//把構(gòu)造好的HTTP協(xié)議發(fā)送給服務(wù)器,失敗返回false
if (!fputs($fp, $query, strlen($query)))
{
$errstr = "Write error";
return false;
}
//獲取從服務(wù)器端返回的所有信息,包括HTTP頭和XML信息
$contents = '''';
while (!feof($fp))
{
$contents .= fgets($fp);
}
//關(guān)閉連接資源后返回獲取的內(nèi)容
fclose($fp);
return $contents;
}
//構(gòu)造連接RPC服務(wù)器端的信息
$host = ''localhost'';
$port = 80;
$rpc_server = ''/~heiyeluren/rpc_server.php'';
//把需要發(fā)送的XML請(qǐng)求進(jìn)行編碼成XML,需要調(diào)用的方法是rpc_server,參數(shù)是get
$request = xmlrpc_encode_request(''rpc_server'', ''get'');
//調(diào)用rpc_client_call函數(shù)把所有請(qǐng)求發(fā)送給XML-RPC服務(wù)器端后獲取信息
$response = rpc_client_call($host, $port, $rpc_server, $request);
//分析從服務(wù)器端返回的XML,去掉HTTP頭信息,并且把XML轉(zhuǎn)為PHP能識(shí)別的字符串
$split = ''<?xml version="1.0" encoding="iso-8859-1"?>'';
$xml = explode($split, $response);
$xml = $split . array_pop($xml);
$response = xmlrpc_decode($xml);
//輸出從RPC服務(wù)器端獲取的信息
print_r($response);
?>
大致我們上面的例子就是提交一個(gè)叫做rpc_server的方法過(guò)去,參數(shù)是get,然后獲取服務(wù)器端的返回,服務(wù)器端返回的XML數(shù)據(jù)是:
<?xml version="1.0" encoding="iso-8859-1"?>
<methodResponse>
<params>
<param>
<value>
<string>This data by get method</string>
</value>
</param>
</params>
</methodResponse>
那么我們?cè)偻ㄟ^(guò)xmlrpc_decode函數(shù)把這個(gè)XML編碼為PHP的字符串,我們就能夠隨意處理了,整個(gè)Web Service交互完成。
[ 結(jié)束語(yǔ) ]
不管是XML-RPC也好,SOAP也罷,只要能夠讓我們穩(wěn)定、安全的進(jìn)行遠(yuǎn)程過(guò)程的調(diào)用,完成我們的項(xiàng)目,那么就算整個(gè)Web Service就是成功的。另外,如果可以的話,也可以嘗試使用PEAR中的XML-RPC來(lái)實(shí)現(xiàn)上面類似的操作,說(shuō)不定會(huì)更簡(jiǎn)單,更適合你使用。
簡(jiǎn)單的使用XML-RPC進(jìn)行Web Service交互就完成了,部分代碼參考PHP手冊(cè),想獲取詳細(xì)信息建議參考手冊(cè),如果文章有不正確,請(qǐng)指正。