PHP中Web Service应用

 http://www.phpchina.com/html/84/n-33884.html

PHP中XML-RPC构造Web Service
发布时间:2008-11-14 15:49 　　作者: 网络转载 　　信息来源: www.phpq.net
PHP中集成了XML-RPC和SOAP两种协议的访问，都是集中在xmlrpc扩展当中。另外，在PHP的PEAR中，不管是PHP 4还是PHP 5，都已经默认集成了XML-RPC扩展，而且该扩展跟xmlrpc扩展无关，能够独立实现XML-RPC的协议交互，如果没有xmlrpc扩展，建议使用PEAR::XML-RPC扩展。
Web Service介绍
Web Service就是为了异构系统的通信而产生的，它基本的思想就是使用基于XML的HTTP的远程调用提供一种标准的机制，而省去建立一种新协议的需求。目前进行Web Service通信有两种协议标准，一种是XML-RPC，另外一种是SOAP。XML-RPC比较简单，出现时间比较早，SOAP比较复杂，主要是一些需要稳定、健壮、安全并且复杂交互的时候使用。
我们这里主要是以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
<?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
/**
* 函数：提供给客户端进行连接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 version="1.0" encoding="iso-8859-1"?>'';
$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来实现上面类似的操作，说不定会更简单，更适合你使用。
简单的使用XML-RPC进行Web Service交互就完成了，部分代码参考PHP手册，想获取详细信息建议参考手册，如果文章有不正确，请指正。
TAG: PHP WEB Web Service 构造
============================================================
拙议REST及其在PHP中的现状
当HTTP被发明出来的时候，其实REST就已经存在了。可惜这么多年来，WEB开发模式却越来越背离HTTP的本质，舍本逐末的追求起RPC之类的东西。此时REST重新回到人们的视线里，无疑让大家开始反思过去走过的弯路。
本文并不想从头介绍REST，只是想举例说明一下需要注意的问题：
先来看看人们对REST的困惑：
REST长啥样？
最一般的REST例子，类似下面的样子：
POST   /articles     创建
DELETE /articles/123 删除
PUT    /articles/123 更新或创建
GET    /articles/123 查看
顺便说说几个知识点：
GET操作是安全的。所谓安全是指不管进行多少次操作，资源的状态都不会改变。比如我用GET浏览文章，不管浏览多少次，那篇文章还在那，没有变化。当然，你可能说每浏览一次文章，文章的浏览数就加一，这不也改变了资源的状态么？这并不矛盾，因为这个改变不是GET操作引起的，而是用户自己设定的服务端逻辑造成的。
PUT，DELETE操作是幂等的。所谓幂等是指不管进行多少次操作，结果都一样。比如我用PUT修改一篇文章，然后在做同样的操作，每次操作后的结果并没有不同，DELETE也是一样。顺便说一句，因为GET操作是安全的，所以它自然也是幂等的。
POST操作既不是安全的，也不是幂等的，比如常见的POST重复加载问题：当我们多次发出同样的POST请求后，其结果是创建出了若干的资源。
安全和幂等的意义在于：当操作没有达到预期的目标时，我们可以不停的重试，而不会对资源产生副作用。从这个意义上说，POST操作往往是有害的，但很多时候我们还是不得不使用它。
还有一点需要注意的就是，创建操作可以使用POST，也可以使用PUT，区别在于POST是作用在一个集合资源之上的（/articles），而PUT操作是作用在一个具体资源之上的（/articles/123），再通俗点说，如果URL可以在客户端确定，那么就使用PUT，如果是在服务端确定，那么就使用POST，比如说很多资源使用数据库自增主键作为标识信息，而创建的资源的标识信息到底是什么只能由服务端提供，这个时候就必须使用POST。
浏览器不支持PUT/DELETE方法怎么办？
大部分浏览器只支持GET/POST方法，这使得我们无法完美的实现REST。对于这样的情况，大致有几种解决方法，一种是在表单里加入一个_method之类名字的隐藏字段，用于表示真正的方法，另一种是使用X-HTTP-METHOD-OVERRIDE头信息来重载POST。
HTTP方法够用么？
从上面的例子，我们可以看到，通过使用已有的HTTP方法：POST，DELETE，PUT，GET就可以完成资源的增删改查，但在实际情况中，我们需要做的操作往往并不仅仅局限在简单的增删改查操作中，比如说我们要把一篇文章“置顶”，但是HTTP方法里没有一个和“置顶”操作相对应的方法，这时候该怎么办呢？REST对类似问题的解决方案是：创建一个新的资源！在上面的例子里，我们可以这样：
PUT /toparticles/123
通过创建出一个新的资源（toparticles），我们就可以使用简单的HTTP方法通吃一切操作了。

REST反对使用Session么？
牢记一点，REST拒绝Session！这是因为REST强调无状态性。这里的状态指的的应用状态，也可以称之为会话状态。一旦在服务端保持了这样的状态，那么架构的可扩展性将大打折扣。在REST看来，任何类似的状态本身都应该是一个独立的资源。
Cookie对REST有害么？
一分为二的看，如果Cookie里保存的是应用状态的话，就没有问题。因为应用状态本来就属于客户端。但如果使用Cookie保存类似PHPSESSIONID之类的东西就不对了，因为这样的数据并不属于客户端状态，它只不过是使用Session的借口而已。
再来看看REST在PHP中的现状：
PHP里的REST实现案例不多，有点影响都就是CakePHP和Zend，下面分别看看他们的实现：
CakePHP：
设定路由：
Router::parseExtensions('xml');
Router::mapResources('articles');
编写控制器：
class ArticlesController extends AppController {
    var $components = array('RequestHandler');
    function view($id = null) {
        $article = $this->Article->findById($id);
        $this->set(compact('article'));
    }
    // ...
}
视图：

<articles>
<?php echo $xml->serialize($article); ?>
</articles>
差不多就这样了，相应的，还可以实现其他的功能，于是，如下REST操作便成为可能：
POST   /articles
DELETE /articles/123.xml
PUT    /articles/123.xml
GET    /articles/123.xml
总体看，CakePHP的REST实现基本上是按Rails风格来实现的，大体还过得去。
参考链接：
http://book.cakephp.org/view/476/rest
http://c7y.phparch.com/c/entry/1/art,cakephp-rest

ZendFramework：
ZendFramework通过Zend_Rest组件来实现Rest功能：
服务端：
require_once 'Zend/Rest/Server.php';
function sayHello($who, $when)
{
    return "Hello $who, Good $when";
}
$server = new Zend_Rest_Server();
$server->addFunction('sayHello');
$server->handle();
客户端：
require_once 'Zend/Rest/Client.php';
$client = new Zend_Rest_Client('http://path/to/server/script');
$client->sayHello('Davey', 'Day');
   
echo $client->get();

这时候，我们看一下Web服务器的日志，会发现生成了一条如下的记录：
GET /path/to/servier/script?method=sayHello&arg0=Davey&arg1=Day&rest=1 HTTP/1.1
我们发现，实际操作方法是由URL中的method=sayHello指定的，而HTTP固有方法（GET/POST等）则成为了摆设，这是典型的RPC风格，如果大家对比Zend_Rest和Zend_XmlRpc文档的话，会明显发现它们根本就是一个东西，所以说，Zend_Rest是一个REST伪实现。
参考链接：
http://framework.zend.com/manual/en/zend.rest.html
http://framework.zend.com/manual/en/zend.xmlrpc.html
=============================
此外，INFOQ上有几篇不错的文章：
http://www.infoq.com/cn/articles/rest-architecure
http://www.infoq.com/cn/articles/rest-introduction
http://www.infoq.com/cn/articles/rest-anti-patterns

=======================================================

NuSOAP笔记：如何创建复杂数据类型收藏

PHP已经有了内置的SOAP扩展，但是它不具备自动生成WSDL的能力，所以很多时候，NuSOAP还是有一定诱惑力的。
在应用稍微复杂点的时候，单靠integer, string等简单数据类型是不能满足需要的，这时候，就需要创建复杂数据类型，下面看看在NuSOAP中应该怎么做：
假设我们的应用里有一个“Member”对象，它有id，username，还有friends，直观一点表示，可能是类似下面的结构：
Array
(
    [id] => ...
    [username] => ...
    [friends] => Array
        (
            [0] => Array
                (
                    [id] => ...
                    [username] => ...
                    [friends] => Array(...)
                )
            [1] => Array
                (
                    [id] => ...
                    [username] => ...
                    [friends] => Array(...)
                )
        )
)
这里稍显复杂的地方就是有一点点递归的味道。下面看看用NuSOAP是如何表示这个数据类型的：
$nusoap->wsdl->addComplexType(
    'Members',
    'complexType',
    'array',
    '',
    'SOAP-ENC:Array',
    array(),
    array(
        array(
            'ref' => 'SOAP-ENC:arrayType',
            'wsdl:arrayType' => 'tns:Member[]'
        )
    ),
    'tns:Member'
);

$nusoap->wsdl->addComplexType(
    'Member',
    'complexType',
    'struct',
    'all',
    '',
    array(
        'id' => array('name' => 'id' , 'type' => 'xsd:integer'),
        'username' => array('name' => 'username', 'type' => 'xsd:string'),
        'friends' => array('name' => 'friends' , 'type' => 'tns:Members')
    )
);
如果使用的是PHP内建的SOAP扩展的话，应该怎么创建复杂数据类型呢？答案很简单：手写WSDL创建复杂数据类型！因为PHP内建的SOAP扩展不支持动态生成WSDL，所以只能手写，当然，如果你不了解WSDL规范，也可以先用NuSOAP生成一套，然后用到PHP内建的SOAP扩展中，^_^。