NuSOAP webservice接口使用详解

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

require_once ("lib/nusoap.php");

$server = new soap_server ();

// 避免乱码

$server->soap_defencoding = 'UTF-8';

$server->decode_utf8 = false;

$server->xml_encoding = 'UTF-8';

$server->configureWSDL ('test'); // 打开 wsdl 支持

/*

注册需要被客户端访问的程序

类型对应值: bool->"xsd:boolean"    string->"xsd:string"

int->"xsd:int"     float->"xsd:float"

*/

$server->register ( 'GetTestStr', // 方法名

array ("name" => "xsd:string" ), // 参数,默认为 "xsd:string"

array ("return" => "xsd:string" ) ); // 返回值,默认为 "xsd:string"

//isset  检测变量是否设置

$HTTP_RAW_POST_DATA = isset ( $HTTP_RAW_POST_DATA ) ? $HTTP_RAW_POST_DATA : '';

//service  处理客户端输入的数据

$server->service ( $HTTP_RAW_POST_DATA );

/**

 * 供调用的方法

 * @param $name

 */

function GetTestStr($name) {

	return "Hello,  { $name } !";

}

?>



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

 


<?php

require_once ("lib/nusoap.php");

/*

通过 WSDL 调用 WebService

参数 1 WSDL 文件的地址 (问号后的wsdl不能为大写)

参数 2  指定是否使用 WSDL

$client = new soapclient('http://localhost/nusoapService.php?wsdl',true);

*/

$client = new soapclient ( 'http://localhost/nusoapService.php' );

$client->soap_defencoding = 'UTF-8';

$client->decode_utf8 = false;

$client->xml_encoding = 'UTF-8';

// 参数转为数组形式传递

$paras = array ('name' => 'Bruce Lee' );

// 目标方法没有参数时,可省略后面的参数

$result = $client->call ( 'GetTestStr', $paras );

// 检查错误,获取返回值

if (! $err = $client->getError ()) {

	echo " 返回结果: ", $result;

} else {

	echo " 调用出错: ", $err;

}

?>

 

<?php

require_once ("lib/nusoap.php");

/*

通过 WSDL 调用 WebService

参数 1 WSDL 文件的地址 ( 问号后的 wsdl 不能为大写 )

参数 2  指定是否使用 WSDL

$client = new soapclient('http://localhost/nusoapService.php?wsdl',true);

*/

$client = new soapclient ( 'http://localhost/nusoapService.php?wsdl',true);

$client->soap_defencoding = 'UTF-8';

$client->decode_utf8 = false;

$client->xml_encoding = 'UTF-8';

// 参数转为数组形式传递

$paras = array ('name' => 'Bruce Lee' );

// 目标方法没有参数时,可省略后面的参数

$client->call ( 'GetTestStr', $paras );

$document = $client->document;

echo $document; 

?>


注: 返回结果: 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

require_once ("lib/nusoap.php");

$client = new soapclient ( 'http://localhost/nusoapService.php?wsdl',true);

$client->soap_defencoding = 'UTF-8';

$client->decode_utf8 = false;

$client->xml_encoding = 'UTF-8';

//生成proxy类  

$proxy = $client->getProxy();  

//调用远程函数  

$sq = $proxy->GetTestStr('Bruce Lee'); 

if (!$err=$proxy->getError()) {  

print_r($sq);  

} else {  

print "ERROR: $err";  

}  

  

print 'REQUEST:<xmp>'.$p->request.'</xmp>';  

print 'RESPONSE:<xmp>'.str_replace('><', ">\n<", $p->response).'</xmp>';  

?>  


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

 

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

 

NuSOAP webservice接口使用详解

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

 

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

$client->soap_defencoding = 'utf-8';  

$client->decode_utf8 = false;  

$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

header('content-type: text/xml; charset=UTF-8');

require_once('nusoap.php');

$params = array('AuthenticationHeader' => array(

    'Content-Type' => 'text/xml; charset=UTF-8',

    'SOAPAction' => 'YourFunstion',

)

);

$client = new nusoap_client('http://www.yourdomain.com/service.asmx?wsdl', true, '', '', '', '');

$client->setHeaders('  

<tns:AuthenticationHeader xmlns:tns="http://tempuri.org/webservice">

  <tns:UserName>username</tns:UserName> 

  <tns:Password>password</tns:Password>   

 </tns:AuthenticationHeader>

');

$err = $client->getError();

if ($err) {

    echo '<h2>Constructor error</h2><pre>' . $err . '</pre>';

}

$result = $client->call('YourFunction', $params, '', '', false, true);

if ($client->fault) {

    echo '<h2>Fault</h2><pre>';

    print_r($result);

    echo '</pre>';

} else {

    $err = $client->getError();

    if ($err) {

        echo '<h2>Error</h2><pre>' . $err . '</pre>';

    } else {

        echo '<h2>Result</h2><pre>';

//print_r($result);

        echo '</pre>';

    }

}

echo '<h2>Request</h2><pre>' . htmlspecialchars($client->request, ENT_QUOTES) . '</pre>';

echo '<h2>Response</h2><pre>' . htmlspecialchars($client->response, ENT_QUOTES) . '</pre>';

?>


 


你可能感兴趣的:(webservice)