PHP中使用XML-RPC構造Web Service簡單入門
目前進行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
/** * 函數:提供給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
/** * 函數:提供給客戶端進行連接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 = explode($split, $response);
$xml = $split . array_pop($xml);
$response = xmlrpc_decode($xml);
//輸出從RPC服務器端獲取的信息
print_r($response);
?>
<?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交互完成。
推薦文章
2025-01-18
2024-11-28
2024-11-09
2024-10-25
2024-06-25
2024-01-04
2023-11-06
2023-10-30
2023-10-13
2023-10-10
穩定
產品高可用性高并發貼心
項目群及時溝通專業
產品經理1v1支持快速
MVP模式小步快跑承諾
我們選擇聲譽堅持
10年專注高端品質開發