webService(php)的soap与nusoap服务端与客户端的通信

PHP SOAP服务器

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

在php5开始集成soap了，SOAP的使用比较简单，其中最常用到的类是SoapServer和SoapClient, 其中SoapServer用于创建Webservice服务端，类SoapClient则用于调用Webservice，也就是客户端。由于soap从php5便集成，只需要在php.ini里开启soap组件即可。

以windows下为例：

1	extension=php_soap.dll

Soap实例：

1、首先创建服务端，由于集成后的php5不需要引入任何soap支持文件，直接创建即可，例如访问地址设置为http://127.0.0.1/test.php。

01 02 03 04 05 06 07 08 09 10 11

class test{      function demo(){          return 'hello word' ;      } } //开始创建webservice //null可传入ip，第二个参数类似于授权标识，调用时会用到 $webService = new SoapServer(null, array ( 'uri' => 'test.php' )); //设置需要提供的类，setClass不难理解吧？ $webService ->setClass( 'test' ); $webService ->handle();

至此，soap服务端创建完成。

2、调用刚刚创建的soap服务，同理，由于集成后的php5不需要引入任何soap支持文件，直接调用即可。

1 2 3 4 5 6 7

$client = new SoapClient(null, array (      "location" => 'http://127.0.0.1/test.php' ,      "uri"      => 'test.php' ,  //请求标识，服务器和客户端必须对应 )); //至此，便可调用类里面的方法了 $demo = $client ->demo(); var_dump( $demo );

然而对于Nusoap来说，灵活性强于soap，它们的操作过程基本一致，只是处理过程有少许的偏差，NuSOAP的使用也比较简单,其中最常用到的类是soap_server和nusoap_client, 其中soap_server用于创建 Webservice服务端，类nusoap_client则用于调用Webservice，也就是客户端。这两个类的定义都在lib/nusoap.php中,因此我们在创建 或调用Webservice接口程序时均需要引用该文件。

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

提供nusoap下载：nusoap-0.9.5

Nusoap的实例：

1、首先要做的依然是创建服务端，刚刚说到了有少许的偏差，就在服务端创建这了，首先引入nusoap的支持类库

01 02 03 04 05 06 07 08 09 10 11

//引入nusoap支持类库 require_once ( 'lib/nusoap.php' ); $soap = new soap_server(); $soap ->configureWSDL( 'test' ); //这里要说明一下register这个函数，第一个参数是需要调用的方法，第二个参数是传入的数据，第三个参数是传出的数据。 $soap ->register( 'GetTestStr' ,          array ( "name" => "xsd:string" ), // 参数，默认为 "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 );

至此，nusoap的服务端已经创建好，假设地址为http://127.0.0.1/test.php。

2、调用nusoap。在这之前我在这里封装了一下，文件为class.nuSoapApi.php，代码如下。

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90

<?php /**   * nusoap扩展类   * Email:zhangyuan#tieyou.com   * @author hkshadow   */ //引入nusoap基类 require_once ( 'pto/nusoap/nusoap_new/lib/nusoap.php' );   class nuSoapApi extends nusoap_client{      private $_strSoapUrl = '' ; //wsdl url      private $_strSoapDefenCoding = 'utf-8' ; // 当前请求的HTTP内容类型的字符集。默认utf-8      private $_strXmlEnCoding = 'utf-8' ; //传入消息的字符集编码（响应）。默认utf-8      private $_arrParam = array (); //arrData      private $_objSoap = null; //初始化Nusoap对象            /**       * 构造函数       * @param str $_strSoapUrl       * @param 可选，默认为wsdl $_strSoapWsdl       */      public function __construct( $_strSoapUrl , $_strSoapWsdl = true){          if ( $this ->_objSoap === null){              $this ->_objSoap = new nusoap_client( $_strSoapUrl , $_strSoapWsdl );          }      }            /**       * 设置消息数据       * @param array $arrData       */      public function setArrParam( $arrData ){          $this ->_arrParam = $arrData ;      }            /**       * 设置xml编码       * @param true / false $bool       */      public function setDeCodeUtf8( $bool = false){          $this ->_objSoap->decode_utf8 = $bool ;      }            /**       * 设置http内容类型的字符编码       * @param str $strCode       */      public function setSoapDefenCoding( $strCode ){          if (! empty ( $strCode )){              $this ->_objSoap->soap_defencoding = $strCode ;          } else {              $this ->_objSoap->soap_defencoding = $this ->_strSoapDefenCoding;          }      }        public function setXmlEnCoding( $strCode ){          if (! empty ( $strCode )){              $this ->_objSoap->xml_encoding = $strCode ;          } else {              $this ->_objSoap->xml_encoding = $this ->_strXmlEnCoding;          }      }            /**       * 获取数据       */      public function getRequestData( $fun ){          $arrData = array ();          $arrData = $this ->_objSoap->call( $fun , $this ->_arrParam);          return $arrData ;      }        /**       *  数组转对象       * @param array $arrData       */      public function arrDataObj( $arrData ){          //引用地址，而非引用拷贝          $objStdClass = new stdClass();          foreach ( $arrData as $key => $value ){              if ( is_array ( $value )){                  $objStdClass -> $key = $this ->arrDataObj( $value );              } else {                  $objStdClass -> $key = $value ;              }          }          return $objStdClass ;      } } ?>

从这里开始调用执行过程：

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19

//定义webservice的请求url define( 'SERVICEDTS_WEBSERVER_URL' , 'http://127.0.0.1/test.php?wsdl' ); //引入刚刚封装的类 require_once ( 'lib/class.nuSoapApi.php' ); //调用nusoap扩展类 $client = new NusoapApi(SERVICEDTS_WEBSERVER_URL,true); $client ->setSoapDefenCoding( 'utf-8' ); $client ->setDeCodeUtf8(false); $client ->setXmlEnCoding( 'utf-8' ); $paras = array ( 'name' => 'hkshadow' ); $client ->setArrParam( $paras ); $result = $client ->getRequestData( 'GetTestStr' );   if (! $err = $client ->getError ()) {      echo " 返回结果： " , $result ; } else {      echo " 调用出错： " , $err ; } //输出Hello, { hkshadow } !

解说：

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)。

01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21

//调用nusoap扩展类 $client = new NusoapApi(SERVICEDTS_WEBSERVER_URL,true); $client ->setSoapDefenCoding( 'utf-8' ); $client ->setDeCodeUtf8(false); $client ->setXmlEnCoding( 'utf-8' ); $paras = array ( 'name' => 'hkshadow' ); $client ->setArrParam( $paras ); //      $result = $client->getRequestData('GetTestStr');   //生成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＞' ;

运行刚刚创建的服务端url，http://127.0.0.1/test.php，执行后的结果如下。

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

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

NuSoap调用WebService时可以对编码进行设置，出现乱码的解决方法如下：

1 2 3 4

$client = new nusoap_client( "http://127.0.0.1/test.php?wsdl" ,true);    $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

如果在开启php5内置的soap时，nusoap的SoapClient类和php5内置的SOAP类有冲突的话(我这里没有这样的情况，2种同时开放)：
解决方案
1. 修改php.ini不加载php5内置的soap扩展（windows下是php_soap.dll）。
2. 也有给nusoap的SoapClient类改名的。

至此，不论是php5内置的soap也好，还是nusoap扩展类也好，而对于webservice都是解决方案，从上面的部分例子可见，nusoap显得更灵活一些，而对于简单的webserice通信的话，php5内置的soap更快捷，不论是哪一种选择其一即可。

原文地址：http://www.mudbest.com/webservicephp%E7%9A%84soap%E4%B8%8Enusoap%E6%9C%8D%E5%8A%A1%E7%AB%AF%E4%B8%8E%E5%AE%A2%E6%88%B7%E7%AB%AF%E7%9A%84%E9%80%9A%E4%BF%A1/