设为首页 收藏本站
查看: 1523|回复: 0

[经验分享] php 的webservice类库NuSoap介绍

[复制链接]

尚未签到

发表于 2017-3-31 09:49:45 | 显示全部楼层 |阅读模式
NuSOAP是PHP环境下的WEB服务编程工具,用于创建或调用WEB服务。它是一个开源软件,当前版本是0.9.5,支持SOAP1.1、WSDL1.1,可以与其他支持SOAP1.1和WSDL1.1的系统互操作。NuSOAP完全由PHP语言编写,由一系列PHP类组成,不需要扩展库的支持,这种特性使得NuSOAP可以用于所有的PHP环境,不受服务器安全设置的影响。

1.NuSOAP的获取和安装
  NuSOAP项目建立在SourceForge上,网络地址是:
  http://sourceforge.net/projects/nusoap/
  http://sourceforge.net/projects/nusoap/files/nusoap/
  或http://dietrich.ganx4.com/nusoap,这里,
  可以下载到NuSOAP的最新的版本。
  NuSOAP的安装比较简单,把下载的NuSOAP的文件拷贝到服务器上,可以放在独立的目录里,也可以与程序代码放在相同的目录里,只要你的PHP代码能够访问到这些文件就可以了。
  本文的测试环境基于PHP5.2.6和NuSOAP0.9.5版本,NuSOAP安装在WEB目录“/nusoap”里,有两个子目录,lib和samples。其中,lib目录下存放NuSOAP的所有源代码文件,samples目录下是NuSOAP开发小组提供一些的例子。测试文件存放在WEB目录“/nusoap”里。



2.NuSOAP的使用
  NuSOAP由一PHP的类组成,其中最常用到的是类soap_server和类soalclient。类soap_server用于创建WEB服务,类soapclient在访问WEB服务时会用到。

2.1一个简单的例子:HelloWorld
  这个例子将利用NuSOAP创建一个简单的WEB服务,并利用NuSOAP创建一个客户端程序,调用这个服务。这个服务唯一的功能就是向客户端返回一个字符串“HelloWorld”。首先,创建WEB服务程序代码文件“/nusoap/nusoap_server1.php”:


//把 NuSOAP 的源文件包含到当前的代码文件里
<?php
require_once("lib/nusoap.php");
//定义服务程序
function hello() {
return 'Hello World!';
}
//初始化服务对象 , 这个对象是类 soap_server 的一个实例
$soap = new soap_server;
//调用服务对象的 register 方法注册需要被客户端访问的程序。
//只有注册过的程序,才能被远程客户端访问到。
$soap->register('hello');
//最后一步,把客户端通过 post 方式提交的数据,传递给服务对象的 service 方法。
//service 方法处理输入的数据,调用相应的函数或方法,并且生成正确的反馈,传回给客户端。
$soap->service($HTTP_RAW_POST_DATA);
?>


至此,WEB服务程序代码文件已经建好,接下来,创建一个客户端程序代码文件“/nusoap/nusoap_client1.php”,调用WEB服务:
//把 NuSOAP 的源文件包含到当前的代码文件里
<?php
require_once("lib/nusoap.php");
//初始化客户端对象,这个对象是类 soapclient 的一个实例,
//把服务程序的 URL 地址传递给soapclient类的构造函数。
$client = new soapclient('http://127.0.0.1/nusoap/nusoap_server1.php');
//利用客户端对象的 call 方法调用 WEB 服务的程序
$str=$client->call('hello');
//客户端对象的 getError() 方法可以用来检查调用过程是否出现错误。
//如果没有错误, getError() 方法返回 false ;如果有错误, getError()方法返回错误信息。
if (!$err=$client->getError()) {
echo " 程序返回 :",htmlentities($str,ENT_QUOTES);
} else {
echo " 错误 :",htmlentities($err,ENT_QUOTES);
}
?>
  

  至此,客户端程序也建立好了,打开浏览器,访问客户端程序,看一下结果。这个例子,浏览器会显示字符串:“程序返回:HelloWorld!”

2.2传递参数和返回错误信息的方法
  再通过例子说明传递参数和返回错误信息的方法。这个例子实现两个字符串的连接,参数是两个字符串,返回值是由两个参数连接而成的字符串。首先,创建服务程序代码文件“/nusoap/nusoap_server2.php”,完整的代码如下:

<?php
require_once("lib/nusoap.php");
function concatenate($str1,$str2) {
if (is_string($str1) && is_string($str2))
return $str1 . $str2;
else
return new soap_fault(' 客户端 ','','concatenate 函数的参数应该是两个字符串 ');
}
$soap = new soap_server;
$soap->register('concatenate');
$soap->service($HTTP_RAW_POST_DATA);
?>

  与2.1节WEB服务程序的代码比较,这里的代码结构大体是相同的。注意以下两点:


  • 服务程序的定义不同,带有两个参数。NuSOAP注册服务程序的过程还是一样的,都是调用服务对象的register方法。
  • 这里使用了NuSOAP的一个新类soap_fault。当传入的两个参数有一个不是字符串时,程序通过这个类把错误信息返回给客户端。这个类的构造函数有4个参数:

  fault
  code

  必填参数,建议值为“Client”或“Server”,指明错误是客户端的错误还是服务端的错误。
  faultactor
  预留项,现在还没有使用
  faultstring
  错误的描述信息
  faultdetail
  可选项,XML格式的数据,说明详细的错误信息
  客户端程序代码文件“/nusoap/nusoap_client2.php”的完整内容如下:

<?php
require_once("lib/nusoap.php");
$client = new soapclient('http://127.0.0.1/nusoap/nusoap_server2.php');
$parameters=array(' 字符串 1',' 字符串 2');
$str=$client->call('concatenate',$parameters);
if (!$err=$client->getError()) {
echo " 程序返回 :",$str;
} else {
echo " 错误 :",$err;
}
?>
  


  NuSOAP的客户端调用带参数的WEB服务时,使用数组传递参数。$parameters是一个数组,其中依次是每个参数的值。客户端在调用远程的服务程序时,使用带有两个参数的call方法,第一个参数是服务程序的名称,第二个参数是服务程序的参数数组,这里是$parameters。通过浏览器访问上面的客户端程序,浏览器上会显示字符串:“程序返回:字符串1字符串2”
  接下来,试着给WEB服务程序传入错误参数,修改上面的客户端程序,把生成参数数组的语句改成:$parameters=array(“字符串”,12),再通过浏览器访问客户端程序,浏览器上会显示字符串:“错误:客户端:concatenate函数的参数应该是两个字符串”。WEB服务程序判断传入的参数有一个不是字符串,通过soap_fault给客户端返回错误信息。

2.3调试的方法
  NuSOAP中常用的调试方法有三种:

2.3.1soapclient类的request和response成员变量
  最直接的调试方法就是检查访问WEB服务的过程中,客户端发出的request信息和服务端返回的response信息。soapclient类的request和response成员变量包含这些信息,在程序中显示出这两个变量的内容,可以帮助分析程序运行的情况。看下面的代码:

<?php
require_once("lib/nusoap.php");
$client = new soapclient('http://127.0.0.1/nusoap/nusoap_server2.php');
$parameters=array(' 字符串 1',' 字符串 2');
$str=$client->call('concatenate',$parameters);
if (!$err=$client->getError()) {
echo " 程序返回 :",$str;
} else {
echo " 错误 :",$err;
}
//下面显示request和response 变量的内容
echo '<p/>';
echo 'Request:';
echo '<pre>',htmlspecialchars($client->request,ENT_QUOTES),'</pre>';
echo 'Response:';
echo '<pre>',htmlspecialchars($client->response,ENT_QUOTES ),'</pre>';
?>
  



2.3.2soapclient类的debug_str成员变量
  soapclient类的debug_str成员变量提供了更为详细的调试信息,查看这个变量的内容,可以更好地帮助程序调试。

2.3.3WEB服务程序提供的调试方法
  WEB服务程序代码中,在创建soap_server类的实例前,定义变量$debug=1。调试信息作为备注,放在SOAP消息的尾部返回客户端,客户端通过查看WEB服务的response信息来查看调试信息。

<?php
require_once("lib/nusoap.php");
function concatenate($str1,$str2) {
if (is_string($str1) && is_string($str2))
return $str1 . $str2;
else
return new soap_fault(' 客户端 ','','concatenate 函数的参数应该是两个字符串 ');
}
$debug=1; //定义调试
$soap = new soap_server;
$soap->register('concatenate');
$soap->service($HTTP_RAW_POST_DATA);
?>

2.4对WSDL的支持
  NuSOAP内部通过类"WSDL"实现对WSDL的支持。对于NuSOAP的用户来说,不需要关心内部的WSDL类是如何工作的,正确地使用soap_server类和soapclient类就可以实现对WSDL的支持。

2.4.1创建支持WSDL的WEB服务
  为了实现WEB服务程序对WSDL的支持,需要使用soap_server的configureWSDL方法,并且在调用soap_server的register方法注册WEB服务程序时,需要提供更详细的参数。看下面的代码,代码的文件名是“/nusoap/nusoap_server3.php”。

<?php
require_once("lib/nusoap.php");
function concatenate($str1,$str2) {
if (is_string($str1) && is_string($str2))
return $str1 . $str2;
else
return new soap_fault(' 客户端 ','','concatenate 函数的参数应该是两个字符串 ');
}
$soap = new soap_server;
$soap->configureWSDL('concatenate'); // 初始化对 WSDL 的支持
// 注册服务
$soap->register('concatenate',
array("str1"=>"xsd:string","str2"=>"xsd:string"), // 输入参数的定义
array("return"=>"xsd:string") // 返回参数的定义
);
$HTTP_RAW_POST_DATA = isset($HTTP_RAW_POST_DATA) ? $HTTP_RAW_POST_DATA : '';
$soap->service($HTTP_RAW_POST_DATA);
?>

  现在打开浏览器,访问刚才建立的文件,http://127.0.0.1/nusoap/nusoap_server3.php,结果如下:



concatenate
  ViewtheWSDLfortheservice.Clickonanoperationnametoviewit&apos;sdetails.



  • concatenate




  点击函数名称concatenate,可以看到对函数的描述。点击"WSDL",或者访问WEB服务文件,并在后面加上查询字符串"?wsdl"(http://127.0.0.1/nusoap/nusoap_server3.php?wsdl),可以得到WEB服务的WSDL内容。

2.4.2通过WSDL调用WEB服务
  通过WSDL调用WEB服务,与不通过WSDL调用WEB服务,程序的结构大体相同。区别在于,通过WSDL调用WEB服务,初始化soapclient类时,传入两个参数到soapclient的构造函数,第一个参数是WSDL文件的地址,第二个参数指定是否使用WSDL,指定为true即可。看下面的代码,代码的文件名是“/nusoap/nusoap_client3.php”

<?php
require_once("lib/nusoap.php");
$client = new soapclient('http://127.0.0.1/nusoap/nusoap_server3.php?wsdl',true);
$parameters=array(' 字符串 1',' 字符串 2');
$str=$client->call('concatenate',$parameters);
if (!$err=$client->getError()) {
echo " 程序返回 :",$str;
} else {
echo " 错误 :",$err;
}
?>
  


2.4.3代理的使用
  NuSOAP提供代理的方法调用远程WEB服务。这种方法,在客户端程序里面创建一个远程服务的代理对象,通过代理直接调用远程的WEB服务,而不需要通过soalclient类的call方法。看下面的代码。

<?php
require_once("lib/nusoap.php");
$client = new soapclient('http://127.0.0.1/nusoap/nusoap_server3.php?wsdl',true);
$proxy=$client -> getProxy(); // 创建代理对象 (soap_proxy 类 )
$str=$proxy->concatenate(" 参数 1"," 参数 2"); // 直接调用 WEB 服务
if (!$err=$proxy->getError()) {
echo " 程序返回 :",$str;
} else {
echo " 错误 :",$err;
}
?>

运维网声明 1、欢迎大家加入本站运维交流群:群②:261659950 群⑤:202807635 群⑦870801961 群⑧679858003
2、本站所有主题由该帖子作者发表,该帖子作者与运维网享有帖子相关版权
3、所有作品的著作权均归原作者享有,请您和我们一样尊重他人的著作权等合法权益。如果您对作品感到满意,请购买正版
4、禁止制作、复制、发布和传播具有反动、淫秽、色情、暴力、凶杀等内容的信息,一经发现立即删除。若您因此触犯法律,一切后果自负,我们对此不承担任何责任
5、所有资源均系网友上传或者通过网络收集,我们仅提供一个展示、介绍、观摩学习的平台,我们不对其内容的准确性、可靠性、正当性、安全性、合法性等负责,亦不承担任何法律责任
6、所有作品仅供您个人学习、研究或欣赏,不得用于商业或者其他用途,否则,一切后果均由您自己承担,我们对此不承担任何法律责任
7、如涉及侵犯版权等问题,请您及时通知我们,我们将立即采取措施予以解决
8、联系人Email:admin@iyunv.com 网址:www.yunweiku.com

所有资源均系网友上传或者通过网络收集,我们仅提供一个展示、介绍、观摩学习的平台,我们不对其承担任何法律责任,如涉及侵犯版权等问题,请您及时通知我们,我们将立即处理,联系人Email:kefu@iyunv.com,QQ:1061981298 本贴地址:https://www.yunweiku.com/thread-357973-1-1.html 上篇帖子: [转]PHP大型Web应用入门(一) 下篇帖子: 一个练习php环境安装的好方法
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

扫码加入运维网微信交流群X

扫码加入运维网微信交流群

扫描二维码加入运维网微信交流群,最新一手资源尽在官方微信交流群!快快加入我们吧...

扫描微信二维码查看详情

客服E-mail:kefu@iyunv.com 客服QQ:1061981298


QQ群⑦:运维网交流群⑦ QQ群⑧:运维网交流群⑧ k8s群:运维网kubernetes交流群


提醒:禁止发布任何违反国家法律、法规的言论与图片等内容;本站内容均来自个人观点与网络等信息,非本站认同之观点.


本站大部分资源是网友从网上搜集分享而来,其版权均归原作者及其网站所有,我们尊重他人的合法权益,如有内容侵犯您的合法权益,请及时与我们联系进行核实删除!



合作伙伴: 青云cloud

快速回复 返回顶部 返回列表