php webservice调用实例方法
nusoap是php环境下的webservice编程工具,用于创建或调用webservice。
它是一个开源软件,是完全采用php语言编写的、通过http收发soap消息的一系列php类,由nusphere corporation(http://dietrich.ganx4.com/nusoap/ )开发。
nusoap的一个优势是不需要扩展库的支持,这种特性使得nusoap可以用于所有的php环境,不受服务器安全设置的影响。
方法一:直接调用
<?
include(‘NuSoap.php');
// 创建一个soapclient对象,参数是server的WSDL
$client = new soapclient(‘http://localhost/Webservices/Service.asmx?WSDL', ‘wsdl');
// 参数转为数组形式传递
$aryPara = array(‘strUsername'=>'username', ‘strPassword'=>MD5(‘password'));
// 调用远程函数
$aryResult = $client->call(‘login',$aryPara);
//echo $client->debug_str;
$document=$client->document;
echo <<<SoapDocument
<?xml version=”1.0″ encoding=”GB2312″?>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle=”http://schemas.xmlsoap.org/soap/encoding/” xmlns:SOAP-ENV=”http://schemas.xmlsoap.org/soap/envelope/” xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:SOAP-ENC=”http://schemas.xmlsoap.org/soap/encoding/” xmlns:si=”http://soapinterop.org/xsd“>
<SOAP-ENV:Body>
$document
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
SoapDocument;
?>
方法二:代理方式调用
<?
require(‘NuSoap.php');
//创建一个soapclient对象,参数是server的WSDL
$client=new soapclient(‘http://localhost/Webservices/Service.asmx?WSDL', ‘wsdl');
//生成proxy类
$proxy=$client->getProxy();
//调用远程函数
$aryResult=$proxy->login(‘username',MD5(‘password'));
//echo $client->debug_str;
$document=$proxy->document;
echo <<<SoapDocument
<?xml version=”1.0″ encoding=”GB2312″?>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle=”http://schemas.xmlsoap.org/soap/encoding/” xmlns:SOAP-ENV=”http://schemas.xmlsoap.org/soap/envelope/” xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:SOAP-ENC=”http://schemas.xmlsoap.org/soap/encoding/” xmlns:si=”http://soapinterop.org/xsd“>
<SOAP-ENV:Body>
$document
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
SoapDocument;
?>
许多使用NuSoap 调用.NET WebService或J2EE WebService的朋友可能都遇到过中文乱码问题,下面介绍这一问题的出现的原因和相应的解决方法。
NuSoap调用WebService出现乱码的原因:
通常进行WebService开发时都是用的UTF-8编码,这时我们需要设置:
同时,需要让xml以同样的编码方式传递:
如果遇到NuSoap调用WebService出现乱码,请参考 解决方法:
开启了调试功能,发现$client->response返回结果正确,为什么$result = $client->call($action, array(‘parameters' => $param)); 却是乱码呢?
当xml_encoding设置为UTF-8时,NuSoap会检测decode_utf8的设置,如果为true,会执行 PHP 里面的utf8_decode函数,而NuSoap默认为true。
因此,需要设置:
补充
1、nusoap 的获取和安装
nusoap 项目建立在 sourceforge 上,网络地址是: http://sourceforge.net/projects/nusoap/ ,这里,可以下载到 nusoap 的最新的版本。
nusoap 的安装比较简单,把下载的 nusoap 的文件拷贝到服务器上,可以放在独立的目录里,也可以与程序代码放在相同的目录里,只要你的 php 代码能够访问到这些文件就可以了。
本文的测试环境基于 php4.3.2 和 nusoap 0.7.2 版本, nusoap 安装在 web 目录“ /nusoap ”里,有两个子目录, lib 和 samples 。其中, lib 目录下存放 nusoap 的所有源代码文件, samples 目录下是nusoap开发小组提供一些的例子。测试文件存放在 web 目录“ /nusoap ”里。
2、nusoap 的使用
nusoap 由一 php 的类组成,其中最常用到的是类soap_server和类soalclient。类soap_server 用于创建 web 服务,类soapclient在访问web服务时会用到。
例子: hello world
利用 nusoap 创建一个简单的 web 服务,并利用 nusoap 创建一个客户端程序,调用这个服务。
用于向客户端返回一个字符串“ hello world ”。
首先,创建 web 服务程序代码文件“ /nusoap/nusoap_server1.php ”:
web 服务程序代码文件创建成功。
接下来,创建一个客户端程序代码文件“ /nusoap/nusoap_client1.php ”,调用 web 服务:
至此,客户端程序也建立好了,打开浏览器,访问客户端程序,浏览器会显示字符串:“程序返回 :Hello World! ”
2.2 传递参数和返回错误信息的方法
传递参数和返回错误信息的方法。
例子,实现两个字符串的连接,参数是两个字符串,返回值是由两个参数连接而成的字符串。
首先,创建服务程序代码文件“ /nusoap/nusoap_server2.php ”。
与 2.1 节 web 服务程序的代码比较,这里的代码结构大体是相同的。
注意两点:
服务程序的定义不同,带有两个参数。 NuSOAP 注册服务程序的过程还是一样的,都是调用服务对象的 register 方法。
这里使用了 NuSOAP 的一个新类 soap_fault 。当传入的两个参数有一个不是字符串时,程序通过这个类把错误信息返回给客户端。
这个类的构造函数有 4 个参数:
fault
code
必填参数 , 建议值为“ Client ”或“ Server ”,指明错误是客户端的错误还是服务端的错误。
faultactor
预留项,现在还没有使用
faultstring
错误的描述信息
faultdetail
可选项, XML 格式的数据 , 说明详细的错误信息
客户端程序代码文件“ /nusoap/nusoap_client2.php ”的完整内容:
nusoap 的客户端调用带参数的 web 服务时,使用数组传递参数。 $parameters 是一个数组,其中依次是每个参数的值。、
客户端在调用远程的服务程序时,使用带有两个参数的 call 方法,第一个参数是服务程序的名称,第二个参数是服务程序的参数数组,这里是 $parameters 。
通过浏览器访问上面的客户端程序,浏览器上会显示字符串:“ 程序返回 : 字符串 1 字符串 2 ”
接下来,试着给 web 服务程序传入错误参数,修改上面的客户端程序,把生成参数数组的语句改成: $parameters=array(“ 字符串 ”,12) ,再通过浏览器访问客户端程序,浏览器上会显示字符串:“错误 : 客户端 : concatenate 函数的参数应该是两个字符串”。
web 服务程序判断传入的参数有一个不是字符串,通过 soap_fault 给客户端返回错误信息。
2.3 调试的方法
NuSOAP中常用的调试方法有三种:
2.3.1 soapclient 类的 request 和 response 成员变量
最直接的调试方法:检查访问 WEB 服务的过程中,客户端发出的 request 信息和服务端返回的 response 信息。
soapclient 类的 request 和 response 成员变量包含这些信息,在程序中显示出这两个变量的内容,可以帮助分析程序运行的情况。
代码:
2.3.2 soapclient 类的 debug_str 成员变量
soapclient 类的 debug_str 成员变量提供了更为详细的调试信息,查看这个变量的内容,可以更好地帮助程序调试。
2.3.3 web 服务程序提供的调试方法
web 服务程序代码中,在创建 soap_server 类的实例前,定义变量 $debug=1 。
调试信息作为备注,放在 soap 消息的尾部返回客户端,客户端通过查看 web 服务的 response 信息来查看调试信息。
例子:
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。
现在打开浏览器,访问刚才建立的文件,http://127.0.0.1/nusoap/nusoap_server3.php,结果如下:
concatenate
View the WSDL for the service. Click on an operation name to view it's details.
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 ”
2.4.3 代理的使用
NuSOAP 提供代理的方法调用远程 WEB 服务。
这种方法,在客户端程序里面创建一个远程服务的代理对象,通过代理直接调用远程的 WEB 服务,而不需要通过 soalclient 类的 call 方法。
例子: