PHP采用XML-RPC构造Web Service实例教程


Posted in PHP onJuly 16, 2014

一、概述:

目前进行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来实现上面类似的操作,说不定会更简单,更适合你使用。有兴趣的读者可以尝试去完成。

PHP 相关文章推荐
PHP_MySQL教程-第一天
Mar 18 PHP
php Ajax乱码
Apr 09 PHP
ajax 的post方法实例(带循环)
Jul 04 PHP
ThinkPHP实现支付宝接口功能实例
Dec 02 PHP
php自定文件保存session的方法
Dec 10 PHP
php自定义加密与解密程序实例
Dec 31 PHP
深入解析PHP的Yii框架中的event事件机制
Mar 17 PHP
PHP二维数组矩形转置实例
Jul 20 PHP
Thinkphp通过一个入口文件如何区分移动端和PC端
Apr 18 PHP
php利用ob_start()清除输出和选择性输出的方法
Jan 18 PHP
PHP常见的几种攻击方式实例小结
Apr 29 PHP
yii2.0框架场景的简单使用示例
Jan 25 PHP
ThinkPHP应用模式扩展详解
Jul 16 #PHP
CodeIgniter模板引擎使用实例
Jul 15 #PHP
PHP以mysqli方式连接类完整代码实例
Jul 15 #PHP
destoon实现底部添加你是第几位访问者的方法
Jul 15 #PHP
destoon实现调用热门关键字的方法
Jul 15 #PHP
destoon实现资讯信息前面调用它所属分类的方法
Jul 15 #PHP
destoon实现首页显示供应、企业、资讯条数的方法
Jul 15 #PHP
You might like
社区(php&amp;&amp;mysql)四
2006/10/09 PHP
php实现批量压缩图片文件大小的脚本
2014/07/04 PHP
php打乱数组二维数组多维数组的简单实例
2016/06/17 PHP
PHP二分查找算法示例【递归与非递归方法】
2016/09/29 PHP
完美解决在ThinkPHP控制器中命名空间的问题
2017/05/05 PHP
PHP观察者模式实例分析【对比JS观察者模式】
2019/05/22 PHP
网页常用特效代码整理
2006/06/23 Javascript
JavaScript中函数(Function)的apply与call理解
2015/07/08 Javascript
js判断子窗体是否关闭的方法
2015/08/11 Javascript
JavaScript实现的浮动层框架用法实例分析
2015/10/10 Javascript
浅谈JS中的!=、== 、!==、===的用法和区别
2016/09/24 Javascript
微信小程序 页面跳转和数据传递实例详解
2017/01/19 Javascript
jQuery使用siblings获取某元素所有同辈(兄弟姐妹)元素用法示例
2017/01/30 Javascript
Angular.js中处理页面闪烁的方法详解
2017/03/09 Javascript
微信小程序动态的加载数据实例代码
2017/04/14 Javascript
纯js实现画一棵树的示例
2017/09/05 Javascript
vue嵌套路由与404重定向实现方法分析
2018/05/04 Javascript
微信小程序自定义多选事件的实现代码
2018/05/17 Javascript
浅析vue-router原理
2018/10/19 Javascript
js实现开关灯效果
2020/03/30 Javascript
[53:10]2018DOTA2亚洲邀请赛 4.6 淘汰赛 VP vs VG 第一场
2018/04/11 DOTA
[48:18]DOTA2-DPC中国联赛 正赛 RNG vs Dynasty BO3 第二场 1月29日
2021/03/11 DOTA
解决pycharm安装后代码区不能编辑的问题
2018/10/28 Python
python字典和json.dumps()的遇到的坑分析
2020/03/11 Python
css3遮罩层镂空效果的多种实现方法
2020/05/11 HTML / CSS
校园网站的创业计划书范文
2013/12/30 职场文书
物流仓储计划书
2014/01/10 职场文书
运动会广播稿150字
2014/02/19 职场文书
高中军训感言400字
2014/02/24 职场文书
私人会所最新创业计划书范文
2014/03/24 职场文书
食品安全责任书
2014/04/15 职场文书
投标授权委托书范文
2014/08/02 职场文书
公司授权委托书格式范文
2014/10/02 职场文书
简单总结SpringMVC拦截器的使用方法
2021/06/28 Java/Android
一篇文章带你深入了解Mysql触发器
2021/08/02 MySQL
分享提高 Python 代码的可读性的技巧
2022/03/03 Python