php的xmlrpc应用实例讲解

Posted by phper star | Posted in PHP | Posted on 2011-5-22 0:15

                                                 XMLRPC   
【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。

【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
/***************************************
* function      提供给客户端调用的函数
* parameter     $method  客户端调用的函数
*               $params 客户端需要调用的函数的参数数组
* return        返回调用结果
****************************************/

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
/**********************
*function   提供给客户端进行连接XML-RPC服务器端的函数
*parameter  $host        需要连接的主机
*           $port        连接主机的端口
*           $rpc_server  XML-RPC服务器端文件
*           $request     封装的xml请求信息
*return     连接成功之后返回服务器端的xml信息,失败则返回flase
*************************/

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: ".strl;

    //把构造好的HTTP协议发送给服务器,失败返回false
    if(!fputs($fp,$query,strlen($query))){
        $errstr="write error";
        return flase;
    }

    //获取从服务器端返回的所有信息,包括HTTP头和XML信息
    $contents="";
    while(!feof($fp)){
        $contents.=fgets($fp);
    }

    //关闭连接资源后返回获取的内容
    fclose($fp);
    return $contents;
}

//构造连接rpc_server的信息
$host="localhost";
$port=80;
$rpc_server="prc_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);

//输出从prc_server获取的信息
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简单实例,php_xmlrpc拓展,php xmlrpc的工作原理讲解与演示