PHP中使用XML-RPC构造WebService简单入门

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:phpextensions目录中，PHP5的扩展在C:phpext目录中)，同时在C:Windowsphp.ini或者C:Winntphp.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

<?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

<?php
/**

//TABLE

create table tableurl(

id int(5),

sort int(2),

click int(6),

getday date,

name char(30),

link char(40),

brief char(50),

PRIMARY KEY (id)

)

//XML FILE

------------------------------

<?php

require("db.inc.php");

if(empty($order))

{$order='hot';

}

switch($order)

{

case 'hot':

$querystring="select * from tableurl order by click desc LIMIT 20";

break;

case 'new':

$querystring="select * from tableurl order by getday desc LIMIT 20";

}

$result=mysql_query($querystring,$db);

echo "<?xml version="1.0" encoding="gb2312"?>n";

echo "<?xml-stylesheet type="text/xsl" href="sitelist.xsl"?>";

今天工作上碰到一个问题 由于我们的项目数据太少 所以需要从web search那边借调数据，他们只给我们提供了一个xml的接口。因此，我们需要把xml的数据转化成html呈现给大家。由于项目是基于php的，所以就摒弃了用js来读取xml选择了继续使用php。不过，我以前从来没有做过此类的尝试 所以找了很多网上资料同时参照了php的工作手册，发现在php4的环境下 用parser函数是一个比较好的选择（当然也可以用dom 但是需要对服务器重新进行配置 php5对dom支持得比较好）。

虽然以前没有接触过此类问题，但是还是很快就解决了，不过在解决和摸索的过程中发现网上关于此类的资料虽然不少，但是参差不齐，很多描述不是很具体，还是操作手册比较管用。

好了，言归正传：

parser是php内置的一个用来处理xml的解析器，它的工作由三个事件组成：起始标签、 读取数据、结束标签。

也就是说在对xml进行处理的时候每当碰到起始标签、数据和结束标签的时候函数会做相应的动作来完成对xml数据的转换。

php中对xml读取的相关函数的介绍：

引用:

------------------------------------------------------------------

对象 XML解析函数 描述
元素 xml_set_element_handler() 元素的开始和结束
字符数据 xml_set_character_data_handler() 字符数据的开始
外部实体 xml_set_external_entity_ref_handler() 外部实体出现
未解析外部实体 xml_set_unparsed_entity_decl_handler() 未解析的外部实体出现
处理指令 xml_set_processing_instruction_handler() 处理指令的出现
记法声明 xml_set_notation_decl_handler() 记法声明的出现
默认 xml_set_default_handler() 其它没有指定处理函数的事件

-------------------------------------------------------------------

下面就给大家举一个小小的例子用parser函数来读取xml数据：



<?php
$parser = xml_parser_create(); //创建一个parser编辑器
xml_set_element_handler($parser, "startElement", "endElement");//设立标签触发时的相应函数 这里分别为startElement和endElenment
xml_set_character_data_handler($parser, "characterData");//设立数据读取时的相应函数
$xml_file="1.xml";//指定所要读取的xml文件,可以是url
$filehandler = fopen($xml_file, "r");//打开文件




while ($data = fread($filehandler, 4096))
{
xml_parse($parser, $data, feof($filehandler));
}//每次取出4096个字节进行处理

fclose($filehandler);
xml_parser_free($parser);//关闭和释放parser解析器
$name=false;
$position=false;
function startElement($parser_instance, $element_name, $attrs) //起始标签事件的函数
{
global $name,$position;
if($element_name=="NAME")

本例中的php文件读取、显示xml文件内容

以下为php文件的内容，把该php文件和slashdot.xml放在同一个文件夹即可

<?php
$open_tags = array(
'STORY' => '<STORY>',
'TITLE' => '<TITLE>',
'URL' => '<URL>',
'AUTHOR'=> '<AUTHOR>'
);
$close_tags = array(
'STORY' => '</STORY>',
'TITLE' => '</TITLE>',
'URL' => '</URL>',
'AUTHOR'=> '</AUTHOR>'
);
?>

<?php
//下面就是定义函数来提取数据：

// 处理开始标记的属性指
// $attrs是一个多维数组，键值为属性名， 值就是该属性的值
function startElement($parser, $name, $attrs=''){
global $open_tags, $temp, $current_tag;
$current_tag = $name;
if ($format = $open_tags[$name]){
switch($name){
case 'STORY':
echo '新的故事: ';
break;
default:
break;
}
}
}

// $current_tag告诉我们正在处理的标记，我们随后会在characterData函数中使用
//
// 当碰到</STORY>标记时我们知道要flush所有的临时变量预备操作下一个标记
<lt;/STORY>',
'TITLE' => '</TITLE>',
'URL' => '</URL>',
'AUTHOR'=> '</AUTHOR>'
);
?>

<?php
//下面就是定义函数来提取数据：

// 处理开始标记的属性指
// $attrs是一个多维数组，键值为属性名， 值就是该属性的值
function startElement($parser, $name, $attrs=''){
global $open_tags, $temp, $current_tag;
$current_tag = $name;
if ($format = $open_tags[$name]){
switch($name){
case 'STORY':
echo '新的故事: ';
break;
default:
break;
}
}
}

// $current_tag告诉我们正在处理的标记，我们随后会在characterData函数中使用
//
// 当碰到</STORY>标记时我们知道要flush所有的临时变量预备操作下一个标记
function endElement($parser, $name, $attrs=''){
global $close_tags, $temp, $current_tag;
if ($format = $close_tags[$name]){
switch($name){
case 'STORY':
return_page($temp);
$temp = '';
break;

PHP5中增强了XML的支持，使用DOM扩展了XML操作的能耐。这些函数作为 PHP5 核心的一部分，无需被安装即可使用。

　　下面的例子简单的演示了DOM对XML的操作，具体解释请看代码中的注释

<?
/************************************************
** use XML in PHP5
** reference site:
** http://cn.php.net/manual/zh/ref.dom.php
** the follow codes need PHP5 support
*************************************************/


//首先要创建一个DOMDocument对象
$dom = new DomDocument();
//然后载入XML文件
$dom -> load("test.xml");

//输出XML文件
//header("Content-type: text/xml;charset=gb2312");
//echo $dom -> saveXML();

//保存XML文件，返回值为int（文件大小，以字节为单位）
//$dom -> save("newfile.xml");

echo "<hr/>取得所有的title元素:<hr/>";
$titles = $dom -> getElementsByTagName("title");
foreach ($titles as $node)
{
echo $node -> textContent . "<br/>";
//这样也可以
//echo $node->firstChild->data . "<br/>";
}

/*
echo "<hr/>从根结点遍历所有结点：<br/>";
foreach ($dom->documentElement->childNodes as $items) {
//假如节点是一个元素(nodeType == 1)并且名字是item就继续循环
if ($items->nodeType == 1 && $items->nodeName == "item") {
foreach ($items->childNodes as $titles) {
//假如节点是一个元素，并且名字是title就打印它.
if ($titles->nodeType == 1 && $titles->nodeName == "title") {
print $titles->textContent . "n";
}
}
}
}
*/

//使用XPath查询数据
echo "<hr/>使用XPath查询的title节点结果:<hr/>";
$xpath = new domxpath($dom);
$titles = $xpath->query("/rss/channel/item/title");
foreach ($titles as $node)
{
echo $node->textContent."<br/>";
}
/*
这样和使用getElementsByTagName()方法差不多，但是Xpath要强大的多
深入一点可能是这样：
/rss/channel/item[position() = 1]/title 返回第一个item元素的所有
/rss/channel/item/title[@id = '23'] 返回所有含有id属性并且值为23的title
/rss/channel/&folder&/title 返回所有articles元素下面的title(译者注：&folder&代表目录深度)
*/


//向DOM中写入新数据
$item = $dom->createElement("item");
$title = $dom->createElement("title");
$titleText = $dom->createTextNode("title text");
$title->appendChild($titleText);
$item->appendChild($title);
$dom->documentElement->getElementsByTagName('channel')->item(0)->appendChild($item);

//从DOM中删除节点
//$dom->documentElement->RemoveChild($dom->documentElement->getElementsByTagName("channel")->item(0));
//或者使用xpath查询出节点再删除