1. 云栖社区>
  2. PHP教程>
  3. 正文

webservice——nusoap详解

作者:用户 来源:互联网 时间:2017-12-01 13:00:52

webservice——nusoap详解 - 摘要: 本文讲的是webservice——nusoap详解, PHP SOAP服务器 用PHP和NuSoap来建立SOAP服务器非常容易。基本上,你只要写出你想要暴露给你的Web services的函数,然后用NuSoap去注册它们就可以了。OK,另外还需要两步才能完成PHP SOAP服务器的建立。

PHP SOAP服务器

用PHP和NuSoap来建立SOAP服务器非常容易。基本上,你只要写出你想要暴露给你的Web services的函数,然后用NuSoap去注册它们就可以了。OK,另外还需要两步才能完成PHP SOAP服务器的建立。首先你还要在你的PHP代码中创建NuSoap对象的一个实例,然后用HTTP POST方法将原始数据传给NuSoap进行处理

NuSOAP的使用比较简单,其中最常用到的类是soap_server和soapclient,其中soap_server用于创建 Webservice服务,类soapclient则用于调用Webservice.这两个类的定义都在lib/nusoap.php中,因此我们在创建 或调用Webservice接口程序时均需要引用该文件.  

 

NuSoap是PHP环境下的WebService编程工具,用于创建或调用WebService。它是一个开源软件,是完全采用PHP语言编写的、通过HTTP收发SOAP消息的一系列PHP类,由NuSphere Corporation(http://dietrich.ganx4.com/nusoap/  )开发。NuSOAP的一个优势是不需要扩展库的支持,这种特性使得NuSoap可以用于所有的PHP环境,不受服务器安全设置的影响。  

1.首先,去http://sourceforge.net/projects/nusoap/下载nusoap.zip
2.
服务端:建立 nusoapService.php 文件。

[php] view plaincopy
  1. <?php  
  2. require_once ("lib/nusoap.php");  
  3. $server = new soap_server ();  
  4. // 避免乱码  
  5. $server->soap_defencoding = 'UTF-8';  
  6. $server->decode_utf8 = false;  
  7. $server->xml_encoding = 'UTF-8';  
  8. $server->configureWSDL ('test'); // 打开 wsdl 支持  
  9. /* 
  10. 注册需要被客户端访问的程序 
  11. 类型对应值: bool->"xsd:boolean"    string->"xsd:string" 
  12. int->"xsd:int"     float->"xsd:float" 
  13. */  
  14. $server->register ( 'GetTestStr'// 方法名  
  15. array ("name" => "xsd:string" ), // 参数,默认为 "xsd:string"  
  16. array ("return" => "xsd:string" ) ); // 返回值,默认为 "xsd:string"  
  17. //isset  检测变量是否设置  
  18. $HTTP_RAW_POST_DATA = isset ( $HTTP_RAW_POST_DATA ) ? $HTTP_RAW_POST_DATA : '';  
  19. //service  处理客户端输入的数据  
  20. $server->service ( $HTTP_RAW_POST_DATA );  
  21. /** 
  22.  * 供调用的方法 
  23.  * @param $name 
  24.  */  
  25. function GetTestStr($name) {  
  26.     return "Hello,  { $name } !";  
  27. }  
  28. ?>  


3.客户端:建立nusoapClient.php 文件。


[php] view plaincopy
  1. <?php  
  2. require_once ("lib/nusoap.php");  
  3. /* 
  4. 通过 WSDL 调用 WebService 
  5. 参数 1 WSDL 文件的地址 (问号后的wsdl不能为大写) 
  6. 参数 2  指定是否使用 WSDL 
  7. $client = new soapclient('http://localhost/nusoapService.php?wsdl',true); 
  8. */  
  9. $client = new soapclient ( 'http://localhost/nusoapService.php' );  
  10. $client->soap_defencoding = 'UTF-8';  
  11. $client->decode_utf8 = false;  
  12. $client->xml_encoding = 'UTF-8';  
  13. // 参数转为数组形式传递  
  14. $paras = array ('name' => 'Bruce Lee' );  
  15. // 目标方法没有参数时,可省略后面的参数  
  16. $result = $client->call ( 'GetTestStr'$paras );  
  17. // 检查错误,获取返回值  
  18. if (! $err = $client->getError ()) {  
  19.     echo " 返回结果: "$result;  
  20. else {  
  21.     echo " 调用出错: "$err;  
  22. }  
  23. ?>  

[php] view plaincopy
  1. <?php  
  2. require_once ("lib/nusoap.php");  
  3. /* 
  4. 通过 WSDL 调用 WebService 
  5. 参数 1 WSDL 文件的地址 ( 问号后的 wsdl 不能为大写 ) 
  6. 参数 2  指定是否使用 WSDL 
  7. $client = new soapclient('http://localhost/nusoapService.php?wsdl',true); 
  8. */  
  9. $client = new soapclient ( 'http://localhost/nusoapService.php?wsdl',true);  
  10. $client->soap_defencoding = 'UTF-8';  
  11. $client->decode_utf8 = false;  
  12. $client->xml_encoding = 'UTF-8';  
  13. // 参数转为数组形式传递  
  14. $paras = array ('name' => 'Bruce Lee' );  
  15. // 目标方法没有参数时,可省略后面的参数  
  16. $client->call ( 'GetTestStr'$paras );  
  17. $document = $client->document;  
  18. echo $document;   
  19. ?>  

注:返回结果: Hello, { Bruce Lee } !

WSDL
WSDL是一种用于描述Web Service的XML语言。它是一种机读格式,把所有的访问服务所必须的信息提供给Web Service客户端。NuSOAP专门提供一个类进行WDSL文件的解析,并且从中提取信息。soapclient对象使用wsdl类来减轻开发者调用服务的难度。通过WSDL信息的帮助来创建报文,程序员仅仅需要知道操作的名字和参数就能调用它。

通过NuSOAP使用WSDL提供以下几点优点:
所有的服务元文件,如命名空间(namespaces),endpoint URLs,参数名(parameter names)等等都可以直接从WSDL文件获得,这样就允许客户端动态的适应服务器端的变化。因为从服务器随时可以获得,所以这些数据不再需要在用户脚本中使用硬性编码。
它允许我们使用soap_proxy类。这个类派生自soapclient类,增加了WDSL文件中详细列出的操作所对应的方法。现在用户通过它可以直接调用这些方法。
soapclient 类包含一个getProxy()方 法,它返回一个soap_proxy类的一个对象。soap_proxy类派生自soapclient类,增加了对应于 WSDL文档中定义的操作的方法, 并且允许用户调用一个endpoint的远程方法。这仅仅适用于soapclient对象用WDSL文件初始化的情况。优点是易于用户使用,缺点是性能--PHP中创建对象是耗时的--且不为功利目的服务 (and this functionality serves no utilitarian purpose)。


[php] view plaincopy
  1. <?php  
  2. require_once ("lib/nusoap.php");  
  3. $client = new soapclient ( 'http://localhost/nusoapService.php?wsdl',true);  
  4. $client->soap_defencoding = 'UTF-8';  
  5. $client->decode_utf8 = false;  
  6. $client->xml_encoding = 'UTF-8';  
  7. //生成proxy类    
  8. $proxy = $client->getProxy();    
  9. //调用远程函数    
  10. $sq = $proxy->GetTestStr('Bruce Lee');   
  11. if (!$err=$proxy->getError()) {    
  12. print_r($sq);    
  13. else {    
  14. print "ERROR: $err";    
  15. }    
  16.     
  17. print 'REQUEST:<xmp>'.$p->request.'</xmp>';    
  18. print 'RESPONSE:<xmp>'.str_replace('><'">/n<"$p->response).'</xmp>';    
  19. ?>    

第四步:运行server端文件页面:http://localhost/nusoapService.php生成的wsdl文件

webservice——nusoap详解

点击方法名称。这样我们通过在service中增加了几行代码我们就通过使用NuSOAP为service提供了一个可视化的文档。但是,这还不是所有我们能做的。

webservice——nusoap详解

我们在service中通过使用NuSOAP增加一些WSDL的调用我们可以为service生成WSDL还有一些其他的文档。与此不同的是,在 client中我们能做的就有些少了,至少在我们的这个简单的例子中是这样。下面所示的这个client跟没有使用WSDL的client没有什么不同 的,唯一的不同就是解析soapclent class是通过提供WSDL的URL来完成的,而不是之前的通过service endpoint。

 

NuSoap调用WebService出现乱码的解决方法:

[php] view plaincopy
  1. $client->soap_defencoding = 'utf-8';    
  2. $client->decode_utf8 = false;    
  3. $client->xml_encoding = 'utf-8';    

文件代码不能有任何输出,否则调用时会报类似如下错误: 
XML error parsing SOAP payload on line x(
行号): Reserved XML Name

 

nusoap实现WebService,不要开启 php SOAP 扩展,原因是nusoap的SoapClient类和php5内置的SOAP类有冲突。

解决方案

1. 修改php.ini不加载php5内置的soap扩展(windows下是php_soap.dll)。

2. 也有给nusoap的SoapClient类改名的。

身份认证

[php] view plaincopy
  1. <?php  
  2. header('content-type: text/xml; charset=UTF-8');  
  3. require_once('nusoap.php');  
  4. $params = array('AuthenticationHeader' => array(  
  5.     'Content-Type' => 'text/xml; charset=UTF-8',  
  6.     'SOAPAction' => 'YourFunstion',  
  7. )  
  8. );  
  9. $client = new nusoap_client('http://www.yourdomain.com/service.asmx?wsdl', true, '''''''');  
  10. $client->setHeaders('    
  11. <tns:AuthenticationHeader xmlns:tns="http://tempuri.org/webservice">  
  12.   <tns:UserName>username</tns:UserName>   
  13.   <tns:Password>password</tns:Password>     
  14.  </tns:AuthenticationHeader>  
  15. ');  
  16. $err = $client->getError();  
  17. if ($err) {  
  18.     echo '<h2>Constructor error</h2><pre>' . $err . '</pre>';  
  19. }  
  20. $result = $client->call('YourFunction'$params'''', false, true);  
  21. if ($client->fault) {  
  22.     echo '<h2>Fault</h2><pre>';  
  23.     print_r($result);  
  24.     echo '</pre>';  
  25. else {  
  26.     $err = $client->getError();  
  27.     if ($err) {  
  28.         echo '<h2>Error</h2><pre>' . $err . '</pre>';  
  29.     } else {  
  30.         echo '<h2>Result</h2><pre>';  
  31. //print_r($result);  
  32.         echo '</pre>';  
  33.     }  
  34. }  
  35. echo '<h2>Request</h2><pre>' . htmlspecialchars($client->request, ENT_QUOTES) . '</pre>';  
  36. echo '<h2>Response</h2><pre>' . htmlspecialchars($client->response, ENT_QUOTES) . '</pre>';  
  37. ?> 

以上是云栖社区小编为您精心准备的的内容,在云栖社区的博客、问答、公众号、人物、课程等栏目也有的相关内容,欢迎继续使用右上角搜索按钮进行搜索,以便于您获取更多的相关知识。