soap = simple object access protocol,简单对象访问协议。它是一种轻量的、简单的、基于 xml 的协议,它被设计成在 web 上交换结构化的和固化的信息。 soap 可以和现存的许多因特网协议和格式结合使用,包括超文本传输协议( http),简单邮件传输协议(smtp),多用途网际邮件扩充协议(mime)。它还支持从消息系统到远程过程调用(rpc)等大量的应用程序。
通过 soap 协议实现的 web 服务,使全世界的程序员编写的类、函数可以集合起来,建成一个巨大的函数库,而且是语言无关的。这为软件事业描绘了一个灿烂的发展前景,只要网络连在一起,就可以实现代码级的逻辑共享,过去的跨进程、跨机器、跨网络的通信问题全部都解决了,而且 http协议是能够穿越防火墙的(其实是防火墙一般不封锁http协议的80端口,否则谁也别上互联网)。
难怪很多人非常看好这项技术,称其“激动人心”。而 web 服务实现起来又很简单,可以简单的基于现在互联网上无数的 web 平台来发布。简单的往往是最美的,web服务就是一个现实的例子。
php 中,在 php.ini 文件中开启了 php_soap.dll 扩展后,就可以支持 soap 了。
在soap扩展库中,主要包括三种对象。
1、soapserver
用于创建php服务器端页面时定义可被调用的函数及返回响应数据。创建一个soapserver对象的语法格式如下:
$soap = new soapserver($wsdl, $array);
其中,$wsdl为shoap使用得wsdl文件,wsdl 是描述 web service的一种标准格式,若将$wsdl设置为null,则表示不使用wsdl模式。$array是soapserver的属性信息,是一个数组。
soapserver对象的addfunction方法是用来声明哪个函数可以被客户端调用,语法格式如下:
$soap->addfunction($function_name);
其中,$soap是一个soapserver对象,$function_name是需要被调用的函数名。
soapserver对象的handle方法用来处理用户输入并调用相应的函数,最后返回给客户端处理的结果。语法格式如下:
$soap->handle([$soap_request]);
其中,$soap是一个soapserver对象,$soap_request是一个可选参数,用来表示用户的请求信息。如果不指定$soap_request,则表示服务器将接收用户的全部请求。
2、soapcliet
用于调用远程服务器上的soapserver页面,并实现了对相应函数的调用。创建一个soapclient对象的语法格式如下:
$soap = new soapclient($wsdl,$array);
其中,参数$wsdl和$array与soapserver相同。
创建soapclient对象后,调用服务端页面中的函数相当于调用了soapclient的方法,创建语法如下:
$soap->user_function($params);
其中,$soap是一个soapclient对象,user_function是服务器端要调用的函数,$params 是要传入函数的参数。
3、soapfault
soapfault用于生成soap访问过程中可能出现的错误。创建一个soapfault对象的语法格式如下:
$fault = new soapfault($faultcode,$faultstring);
其中,$faultcode是用户定义的错误代码,$faultstring是用户自定义的错误信息。soapfault 对象会在服务器端页面出现错误时自动生成,或者通过用户自行创建soapfault对象时生成。对于 soap访问时出现的错误,客户端可通过捕捉soapfalut对象来获得相应的错误信息。
在客户端捕获soapfault对象后,可以通过下面的代码获得错误代码和错误信息:
$fault->faultcode;//错误代码
$fault->faultstring;//错误信息
其中,$fault是在前面创建的soapfault对象。
示例:
文件 soapfunc.php:
/* 几个供client端调用的函数 */
function reverse($str)
{
$retval='';
if(strlen($str) {
return new soapfault('client','','invalid string');
}
for($i=1; $i {
$retval .= $str[(strlen($str)-$i)];
}
return $retval;
}
function add2numbers($num1, $num2)
{
if(trim($num1) != intval($num1))
{
return new soapfault('client','','the first number is invalid');
}
if(trim($num2) != intval($num2))
{
return new soapfault('client','','the second number is invalid');
}
return ($num1+$num2);
}
function gettime()
{
$time = date('y-m-d h:i:s',time());
return $time;
}
?>
文件 soapclsoapserverient.php 内容:
//先创建一个soapserver对象实例,然后将我们要暴露的函数注册,
//最后的handle()用来处理接受的soap请求
include_once('soapfunc.php');
error_reporting(7); //正式发布时,设为 0
date_default_timezone_set('prc'); //设置时区
$soap = new soapserver(null, array('uri'=>httr://test-rui));
$soap->addfunction('reverse');
$soap->addfunction('add2numbers');
$soap->addfunction('gettime');
$soap->addfunction(soap_functions_all);
$soap->handle();
?>
文件 soapclient.php 内容:
error_reporting(7);
try
{
$client = new soapclient(null, array('location'=>http://localhost:8080/_myphp5/soap/soapserver.php, 'uri'=>http://test-uri));
$str=this string will be reversed;
$reversed = $client->reverse($str);
echo if you reverse '$str', you will get '$reversed';
$n1 = 20;
$n2 = 33;
$sum = $client->add2numbers($n1,$n2);
echo
;
echo if you try $n1 + $n2, you will get $sum;
echo
;
echo the remoye system time is: .$client->gettime();
}
catch(soapfault $fault)
{
echo fault! code: . $fault->faultcode . string: . $fault->faultstring;
}
?>
php 中还实现了通过 wsdl 对 web 服务的发布。
wsdl 是一种用于描述web服务的语法规范,针对每个web服务来说,它是一个说明文档,对web服务的位置,协议和接口进行详细的说明.由web服务的开发者提供。
wsdl文件包括5部分:types, message,porttype,binding和service五部分.
1 types定义: 类型定义,独立于语言.对应于soap消息中要传输的元素信息的定义
2 message: 每个web方法对应两个message定义in和out.而message的定义包含了头和体
3 porttype: 每个web service对应一个porttype,该porttype中又包含了对其发布的方法, operation(操作)
4 bindings: 指定每porttype中每个操作(类以及方法)的绑定信息,包含input和output的消息的格式.
5 service: 每个web service绑定的port信息
web 服务除过按照前述的示例形式发布外,还可以通过 wsdl 文档来发布。
示例:
要发布的类,文件 myservice.php:
soap_1_2));
$server->setclass(service);
$server->handle();
?>
wsdl 描述文档,文件 testsoap.wsdl:
targetnamespace=urn:testsoap
xmlns:typens=urn:testsoap
xmlns:xsd=http://www.w3.org/2001/xmlschema
xmlns:soap=http://schemas.xmlsoap.org/wsdl/soap/
xmlns:soapenc=http://schemas.xmlsoap.org/soap/encoding/
xmlns:wsdl=http://schemas.xmlsoap.org/wsdl/
xmlns=http://schemas.xmlsoap.org/wsdl/>
调用代码,文件 client.php:
helloworld();
echo(
);
echo $client->add(10, 20);
?>
然而,wsdl 文档的编写是一件很麻烦的事情,无聊又容易出错。很多人认为那玩意儿不是人写的,但是,如果有好的软件工具,那玩意儿又是不需要人写的。zend 公司的 zed 5.0 系列和 zend studio for eclipse 6.0 原来是很好支持 wdsl 的可视化编辑和类的发布的(按照一个类文件智能生成),但 zend studio 7.0 之后,这方面功能有所减弱。但基于 eclipse 构建的 zend studio 7.x,还是有一个 wsdl 的可视化编辑器,功能也还够用,生成的 wsdl 文件与以前有细微的变化。需要程序员必须对 wsdl 文档里的标签和元素很熟悉。
附录:关于 php 开发 soap 的一些错误
1、开发的时候一定要关闭 php soap 的缓存,服务器和客户端都需要,不然会报:
fatal error: uncaught soapfault exception: [client] function (”test”) is not a valid method for this service in ……\clien.php:5 stack trace:
#0 [internal function]: soapclient->__call(’test’, array)
#1 d:\xampp\htdocs\clien.php(5): soapclient->test()
#2 {main}
关闭方法:
ini_set(soap.wsdl_cache_enabled, 0);
可以通过类似 $client->__getfunctions() 等方法查看 soap 的一些信息。
2、如果调试时报告不识别xml错误,请确保代码里没有空格等无关信息,比如 utf-8 编码文件的 bom 头。
作者:张庆(网眼) 西安 php 教育培训中心 2010-7-11
来自“网眼视界”:http://blog.why100000.com
作者微博:http://t.qq.com/zhangking
“十万个为什么”电脑学习网:http://www.why100000.com
以上就介绍了php 中使用 soap,包括了方面的内容,希望对php教程有兴趣的朋友有所帮助。
