Chinaunix

标题: PHP Cookbook读书笔记 – 第15章创建Web服务 [打印本页]
作者: 听老歌    时间: 2011-11-22 16:58
标题: PHP Cookbook读书笔记 – 第15章创建Web服务
本帖最后由 听老歌 于 2011-11-22 17:03 编辑

PHP Cookbook读书笔记 – 第15章创建Web服务






实现一个REST的WEB服务
实现一个REST的web服务相对还是比较简单的，用到了HTTP的GET、POST、PUT、DELETE特性。其PHP的处理代码和普通处理POST和GET十分相似

view sourceprint?
  1. 01 // 转换到大写  

  3. 02 $request_method = strtoupper($_SERVER['REQUEST_METHOD']);  

  5. 03   

  7. 04 switch ($request_method) {  

  9. 05 case 'GET':  

  11. 06     $action = 'search';  

  13. 07     break;  

  15. 08 case 'POST':  

  17. 09     $action = 'add';  

  19. 10     break;  

  21. 11 case 'PUT':  

  23. 12     $action = 'update';  

  25. 13     break;  

  27. 14 case 'DELETE':  

  29. 15     $action = 'delete';  

  31. 16     break;  

  33. 17 default:  

  35. 18     // 无效的动作  

  37. 19     exit();  

  39. 20 }  

  41. 21 //处理完返回XML格式或Json等格式的结果
复制代码
这段代码就是对4种不同的请求进行处理，SQL与REST的对应关系可以看下表
  1. SQL REST
  2. CREATE POST
  3. SELECT GET
  4. UPDATE PUT
  5. DELETE DELETE
复制代码
对于需要授权的访问在rest中如何实现，书中并没有提及。现在很多开放API都是需要授权后才能使用的，它的实现原理是每次请求时需要携带一个额外的参数，这个参数就是经过加密的验证授权信息的。
以SOAP方式提供数据
使用ext/soap的SOAPServer类实现不带WSDL的WEB服务，你会发现SOAPServer来搭建WEB服务和写PHP的普通类差别并不大(当然也可以用函数），就是在实例化一个SOAPServer时将类名什么的与之关联，下面是一个简单的例子

view sourceprint?
  1. 1 class pc_SOAP_return_time {  

  3. 2     public function return_time() {  

  5. 3         return date('Ymd\THis');  

  7. 4     }  

  9. 5 }  

  11. 6   

  13. 7 $server = new SOAPServer(null, array('uri'=>'urn:pc_SOAP_return_time'));  

  15. 8 $server->setClass('pc_SOAP_return_time');  

  17. 9 $server->handle();
复制代码
客户端调用服务的代码如下：

view sourceprint?
  1. 1 $opts = array('location' => 'http://api.example.org/getTime',  

  3. 2               'uri' => 'urn:pc_SOAP_return_time');  

  5. 3 $client = new SOAPClient(null, $opts);  

  7. 4 $result = $client->__soapCall('return_time', array());  

  9. 5 print "The local time is $result.\n";
复制代码
用函数来处理的书中也有做介绍，因为我满脑子OO，就省略了。

如果客户端调用一个服务端不存在的方法时，服务器会以一个SOAP故障作为应答，如果希望控制应答的内容，可以通过__call()方法来实现，如下面代码所示：

view sourceprint?
  1. 01 class pc_SOAP_Process_All_Methods {  

  3. 02   

  5. 03     // Handle any undefined methods here  

  7. 04     public function __call($name, $args) {  

  9. 05         // ...  

  11. 06     }  

  13. 07 }  

  15. 08   

  17. 09 $server = new SOAPServer(null, array('uri'=>'urn:pc_SOAP_Process_All_Methods'));  

  19. 10 $server->setClass('pc_SOAP_Process_All_Methods');  

  21. 11 $server->handle();
复制代码
在SOAP方法中接受参数
在服务端定义方法是增加参数，然后在客户端调用时SOAPClient->__soapCall('return_time', array(参数数组));是不是很简单，上面的代码各修改1处即可

view sourceprint?
  1. 01 class pc_SOAP_return_time {  

  3. 02 //第一处不同，增加了$tz参数  

  5. 03     public function return_time($tz = '') {  

  7. 04         if ($tz) { $my_tz = date_default_timezone_set($tz); }  

  9. 05         $date = date('Ymd\THis');  

  11. 06         if ($tz) { date_default_timezone_set(ini_get('date.timezone')); }  

  13. 07         return $date;  

  15. 08     }  

  17. 09 }  

  19. 10   

  21. 11 $server = new SOAPServer(null,array('uri'=>'urn:pc_SOAP_return_time'));  

  23. 12 $server->setClass('pc_SOAP_return_time');  

  25. 13 $server->handle();
复制代码
客户端调用
view sourceprint?
  1. 1 $opts = array('location' => 'http://api.example.org/getTime',  

  3. 2               'uri' => 'urn:pc_SOAP_return_time');  

  5. 3 $client = new SOAPClient(null, $opts);  

  7. 4 //第二处不同，将tz设置为奥斯陆  

  9. 5 $result = $client->__soapCall('return_time', array('tz' => 'Europe/Oslo'));  

  11. 6 print "The local time is $result.\n";
复制代码
自动生成WSDL文件
前面已经说了，ext/soap扩展不支持WSDL自动生成功能，可以考虑手工生成WSDL文件（相信大家是不会这么做的），还有就是可以通过下面这几种非官方的脚本来实现，需要注意的是这几种方式都没能完全支持SOAP和WSDL规则，如果要很好的使用需要对它们进行仔细研究

  2. WSDL_Gen, by George Schlossnagle

  4. [url]http://www.schlossnagle.org/~george/blog/index.php?/archives/234-WSDLGeneration.html[/url]

  6. wsdl-writer, by Katy Coe based on code by David Griffin

  8. [url]http://www.djkaty.com/drupal/php-wsdl[/url]

  10. Web service helper, by David Kingma

  12. [url]http://jool.nl/new/[/url]
复制代码
处理SOAP头部信息
当ext/soap发现一个带有SOAP头的客户端请求时，它首先会尝试调用一个具有相同名字的函数。调用完成后，会继续调用在SOAP主体中指定的函数。这样就可以使你基于SOAP头部数据来执行任何预请求的事务。

但是，ext/soap服务器端不会以编程的方式对SOAP头部和主体进行真正的区分。当ext/soap发现一个SOAP头时，它会在处理主体之前尝试调用与该头部元素同名的方法。

如果SOAP客户端指定的头部不存在，ext/soap会跳过该方法直接转到主体中。如果头部中的mustUnderstand 属性标记为true，那么SOAPServer就会放出一个SOAP故障。

view sourceprint?
  1. 01 $opts = array('location' => 'http://api.example.org/getTime',  

  3. 02               'uri' => 'urn:pc_SOAP_return_time');  

  5. 03 $client = new SOAPClient(null, $opts);  

  7. 04 $set_timezone = new SOAPVar('Europe/Oslo', XSD_STRING);  

  9. 05   

  11. 06 //设置SOAP头部  

  13. 07 $tz = new SOAPHeader('urn:pc_SOAP_return_time', 'set_timezone', $set_timezone);  

  15. 08   

  17. 09 $result = $client->__soapCall('return_time', array(), array(), array($tz));  

  19. 10 print "The local time is $result.\n";
复制代码
生成SOAP头信息
view sourceprint?
  1. 01 class pc_SOAP_return_time {  

  3. 02     public function return_time() {  

  5. 03         $tz = date_default_timezone_get();  

  7. 04   

  9. 05         //生成头部信息  

  11. 06         $header = new SoapHeader('urn:pc_SOAP_return_time', 'get_timezone', $tz);  

  13. 07   

  15. 08         $GLOBALS['server']->addSoapHeader($header);  

  17. 09         return date('Ymd\THis');  

  19. 10     }  

  21. 11 }  

  23. 12 $server = new SOAPServer(null, array('uri'=>'urn:pc_SOAP_return_time'));  

  25. 13 $server->setClass('pc_SOAP_return_time');  

  27. 14 $server->handle();
复制代码
由于在方法的作用域中不能轻易地访问到$server对象，需要通过$GLOBALS数组来访问该对象。响应时会包含下面的SOAP头：

view sourceprint?
  1. 1 <SOAP-ENV:HEADER>  

  3. 2 <NS1:GET_TIMEZONE>America/Los Angeles</NS1:GET_TIMEZONE>  

  5. 3 </SOAP-ENV:HEADER>
复制代码
用SOAP头实现验证
因为没有办法强制ext/soap请求SOAP头部信息，所以需要在每个需要验证的方法内添加一个判断语句对pc_authenticate_user进行判断，如果客户端没有通过验证则抛出一个SOAP故障

view sourceprint?
  1. 01 function pc_authenticate_user($username, password) {  

  3. 02     // authenticate user  

  5. 03     $is_valid = true; // Implement your lookup here  

  7. 04   

  9. 05     if ($is_valid) {  

  11. 06         return true;  

  13. 07     } else {  

  15. 08         return false;  

  17. 09     }  

  19. 10 }  

  21. 11   

  23. 12   

  25. 13 class pc_SOAP_return_time {  

  27. 14     private $authenticated;  

  29. 15   

  31. 16     public function __construct() {  

  33. 17         $this->authenticated = false;  

  35. 18     }  

  37. 19   

  39. 20     public function authenticate_user($args) {  

  41. 21         // Throw SOAP fault for invalid username and password combo  

  43. 22         if (! pc_authenticate_user($args->username,  

  45. 23                                    $args->password)) {  

  47. 24   

  49. 25             throw new SOAPFault("Incorrect username and password combination.", 401);  

  51. 26         }  

  53. 27   

  55. 28         $this->authenticated = true;  

  57. 29     }  

  59. 30   

  61. 31     // Rest of SOAP Server methods here...  

  63. 32     public function soap_method() {  

  65. 33         if ($this->authenticated) {  

  67. 34             // Method body here...  

  69. 35         } else {  

  71. 36             throw new SOAPFault("Must pass authenticate_user Header.", 401);  

  73. 37         }  

  75. 38     }  

  77. 39   

  79. 40 }  

  81. 41   

  83. 42 $server = new SOAPServer(null, array('uri'=>'urn:pc_SOAP_return_time'));  

  85. 43 $server->setClass('pc_SOAP_return_time');  

  87. 44   

  89. 45 $server->handle();
复制代码




欢迎光临 Chinaunix (http://bbs.chinaunix.net/) Powered by Discuz! X3.2