以前写过一篇关于PHP Webservice的文章,但很简单,这段时间一直都在做基于nusoap的webservice接口,正好又深入学习了一下,今天就整体上对利用nusoap开发PHP的webservice程序进行一个说明和实例分析。
关于nusoap的介绍就不多说了,如果有不了解到朋友,可以参考一下这篇文章:Webservice工具soapUI下载和使用,在里面对nusoap进行了一个详细的介绍和说明。
利用nusoap我们可以只写很少量的代码,就完成其他语言需要手工构造xml的Webservice的WSDL的说明,这就给我们提供了很大的帮助,同时我们可以利用nusoap来丰富和完善我们写的webservice接口,接下来我就从一个实例入手,开始进行说明。
首先说明几个需要注意到地方:
1.利用nusoap编写的Webservice通常来说都是UTF-8编码的,因此我们在写客户端调用程序时一定要注意,传入的参数和返回的参数都是UTF-8编码的,否则就可能出现返回无内容的情况。
2.nusoap返回的WSDL页面内容一般是西文编码ISO-8859-1,这在我们的WSDL中如果有中文字符的话就会出现乱码的现象,即使你在调用程序和webservice接口中定义了编码为UTF-8也不管用,因为这个需要你对NuSOAP的nusoap.php文件代码中的设置字符编码的位置,如:header(“Content-Type: text/xml; charset=ISO-8859-1\r\n”),将其charset改为UTF-8,可以把文件中所有类似这种设置的位置都改掉,就可以正常显示中文了。
下面的代码,这是一个比较简单的Webservice服务端程序:
header("Content-Type: text/html,charset=utf-8"); include_once "lib/nusoap.php";
$server = new soap_server(); $server->configureWSDL('WebService','urn:wsdl'); $server->soap_defencoding = 'utf-8';
$server->register('search_user_info', array('custA' => 'xsd:array'), array('return' => 'xsd:string'), '','','rpc','encoded', '接口函数描述' );
function search_user_info($custA) { /** 功能代码 **/ return $string; }
$HTTP_RAW_POST_DATA = isset($HTTP_RAW_POST_DATA) ? $HTTP_RAW_POST_DATA : ''; $server->service($HTTP_RAW_POST_DATA);
主要分为几个部分:实例化soap类,注册Webservice函数,定义实现Webservice函数,实例化没什么可说的,定义实现函数就和我们平时写程序一样,完成要实现的功能即可,关于注册Webservice函数由于其涉及较多,我在这里进行一个简短的说明。
其实nusoap的关键就是在其注册接口函数register里,它根据我们传入register函数中的参数生成WSDL文件并展示出来。
register函数共接收9个参数,其中除第一个接口函数名是必须的,其他8个都是可选的,不过我们最常使用的是前三个参数:接口函数
名,传入参数类型,返回参数类型。参数的写法如上面代码,key值为参数变量名,value为参数的类型,如array或string。
第4个参数为命名空间,第5个为soapaction值,第6个参数为发送类型,默认值为rpc,还有一种是document,但不常用。第7个参数默认为encoded即可,第8个参数为函数说明,就是相当于该接口函数的代码注释,主要是对该函数使用的一个说明。它的关键就是我们在对外开放接口时,直接在webservice服务端直接显示使用说明,无需对每个人都提供一个说明,最后一个通常无需设置。
到此Webservice服务端代码基本完成,现在我们就可以写客户端代码来调用该Webservice接口了,通常由于Webservice函数的特殊性,我们需要学会使用nusoap对webservice函数进行判断错误所在和调试相关错误信息。
下面是一个简单调用的代码:
header("Content-Type: text/html; charset=utf-8"); require_once("lib/nusoap.php");
$weburl = "http://www.domain.com/webservice.php"; $client = new soapclient($weburl); $err = $client->getError(); if($err) { echo $err."<br>";exit(); } else {
/*定义要传递的数组*/ $custA['data']['key_val'] = 'IS25R1AGHB'; $custA['data']['start'] = 0; $custA['data']['num'] = 10;
$result = $client->call('get_cust_info',$custA);
print_r($client-response);
return $result;
}
这段简单的代码我想大家应该都能看明白,我就简单的说几点:
1.客户端调用时也需要加载nusoap.php文件
2.通过$err = $client->getError()判断webservice实例化是否正确,不正则我们可以通过输出错误信息来判断问题所在。
3.调用接口函数后,通过print_r($client-response)可以输出服务器端产生的输出信息,如果webservice接口中存在代码问题,则会在其中显示出来,我们可以根据其提示对接口函数进行快速修改。
4.最后就是输出接口函数的返回值$result,我们可以根据函数返回值来确定webservice接口函数调用是否成功。
以上就是我对利用nusoap开放webservice应用的一个整体的介绍,通过以上内容我们就可以构造输入自己的webservice接口函数了。
同时附上一些PHP Webservice开发的资源:
Nusoap库下载地址:http://sourceforge.net/projects/nusoap/files/nusoap/0.9.5/nusoap-0.9.5.zip/download
Nusoap文档下载:http://sourceforge.net/projects/nusoap/files/nusoap-docs/0.9.5/nusoap-docs-0.9.5.zip/download,很不错的文档介绍,只不过是全英文的,但它对nusoap进行相当全面的说明和函数介绍。
来源:红心草博客