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目录中。dll扩展文件的具体安装目录视你的php安装目录而定，此处仅为示例说明)，同时在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);

大致我们上面的例子就是提交一个叫做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来实现上面类似的操作，说不定会更简单，更适合你使用。有兴趣的读者可以尝试去完成。