PHP-WebService

0.WebService中Endpoint、Disco、WSDL都是做什么的？

1.环境(当前测试为WAMP, 其中根目录为测试目录)

　　开启WebService支持, 将php.ini中的extension=php_soap.dll前的注释去掉, 重启服务器

2.有两种形式的WebService

　　A.非标准的WebService, 可能只有PHP能使用(未测试)

　　B.标准的WebService, 就必须要使用wsdl(web service description language)

　　C.SoapServer(mixed $wsdl [, $options])

　　　　$wsdl 如果不使用WSDL则设置$wsdl为Null就可以，反之填写WSDL文件的地址，可以是相对路径或是web网址

　　　　options:

　　　　　　uri 命名空间 non-WSDL必选

　　　　　　location 服务所在位置 non-WSDL必选

　　　　　　encoding 设置编码 可选

　　　　　　soap_version 设置soap服务版本 SOAP_1_1 or SOAP_1_2 可选

3.先实现非WSDL(NO-WSDL)方式

　　注意: WebService方法只能return，不能输出。

　　A.创建server.php

<?php
    function get_info() {
        return date('Y-m-d H:i:s');
    }

    $soap_server = new SoapServer(null, array('uri' => 'http://localhost/server.php'));    
    $soap_server->addFunction('get_info');
    $soap_server->handle();

　　B.创建client.php, location表示WebService中服务文件的访问地址, uri表示命名空间, 要与要调用的webserivce中的uri一致

<?php
    $soap_client = new SoapClient(null, array('location' => 'http://localhost/server.php', 'uri' => 'http://localhost/server.php'));
    echo $soap_client->get_info();

　　C.访问http://localhost/client.php

　　

4.实现WSDL方式

　　创建wsdl文件, 并且集合服务(也可以拆为两个文件, 分别提供swdl内容或者生成wsdl文件、提供服务), 可以使用zend studio或者使用第三方工具生成, 此处使用SoapDiscovery类来生成

　　SoapDiscovery.class.php代码如下

<?php

/**
 * Copyright (c) 2005, Braulio Jos?Solano Rojas
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 * 
 *     Redistributions of source code must retain the above copyright notice, this list of
 *     conditions and the following disclaimer. 
 *     Redistributions in binary form must reproduce the above copyright notice, this list of
 *     conditions and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution. 
 *     Neither the name of the Solsoft de Costa Rica S.A. nor the names of its contributors may
 *     be used to endorse or promote products derived from this software without specific
 *     prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 *
 * @version $Id: SoapDiscovery.class.php 66 2013-04-10 07:12:21Z ideaa $
 * @copyright 2005 
 */

/**
 * SoapDiscovery Class that provides Web Service Definition Language (WSDL).
 * 
 * @package SoapDiscovery
 * @author Braulio Jos?Solano Rojas
 * @copyright Copyright (c) 2005 Braulio Jos?Solano Rojas
 * @version $Id: SoapDiscovery.class.php 66 2013-04-10 07:12:21Z ideaa $
 * @access public
 * */
class SoapDiscovery {

    private $class_name = '';
    private $service_name = '';

    /**
     * SoapDiscovery::__construct() SoapDiscovery class Constructor.
     * 
     * @param string $class_name
     * @param string $service_name
     * */
    public function __construct($class_name = '', $service_name = '') {
        $this->class_name = $class_name;
        $this->service_name = $service_name;
    }

    /**
     * SoapDiscovery::getWSDL() Returns the WSDL of a class if the class is instantiable.
     * 
     * @return string
     * */
    public function getWSDL() {
        if (empty($this->service_name)) {
            throw new Exception('No service name.');
        }
        $headerWSDL = "<?xml version="1.0" ?>
";
        $headerWSDL.= "<definitions name="$this->service_name" targetNamespace="urn:$this->service_name" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="urn:$this->service_name" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns="http://schemas.xmlsoap.org/wsdl/">
";
        $headerWSDL.= "<types xmlns="http://schemas.xmlsoap.org/wsdl/" />
";

        if (empty($this->class_name)) {
            throw new Exception('No class name.');
        }

        $class = new ReflectionClass($this->class_name);

        if (!$class->isInstantiable()) {
            throw new Exception('Class is not instantiable.');
        }

        $methods = $class->getMethods();

        $portTypeWSDL = '<portType name="' . $this->service_name . 'Port">';
        $bindingWSDL = '<binding name="' . $this->service_name . 'Binding" type="tns:' . $this->service_name . "Port">
<soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http" />
";
        $serviceWSDL = '<service name="' . $this->service_name . "">
<documentation />
<port name="" . $this->service_name . 'Port" binding="tns:' . $this->service_name . "Binding"><soap:address location="http://" . $_SERVER['SERVER_NAME'] . ':' . $_SERVER['SERVER_PORT'] . $_SERVER['PHP_SELF'] . "" />
</port>
</service>
";
        $messageWSDL = '';
        foreach ($methods as $method) {
            if ($method->isPublic() && !$method->isConstructor()) {
                $portTypeWSDL.= '<operation name="' . $method->getName() . "">
" . '<input message="tns:' . $method->getName() . "Request" />
<output message="tns:" . $method->getName() . "Response" />
</operation>
";
                $bindingWSDL.= '<operation name="' . $method->getName() . "">
" . '<soap:operation soapAction="urn:' . $this->service_name . '#' . $this->class_name . '#' . $method->getName() . "" />
<input><soap:body use="encoded" namespace="urn:$this->service_name" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" />
</input>
<output>
<soap:body use="encoded" namespace="urn:$this->service_name" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" />
</output>
</operation>
";
                $messageWSDL.= '<message name="' . $method->getName() . "Request">
";
                $parameters = $method->getParameters();
                foreach ($parameters as $parameter) {
                    $messageWSDL.= '<part name="' . $parameter->getName() . "" type="xsd:string" />
";
                }
                $messageWSDL.= "</message>
";
                $messageWSDL.= '<message name="' . $method->getName() . "Response">
";
                $messageWSDL.= '<part name="' . $method->getName() . "" type="xsd:string" />
";
                $messageWSDL.= "</message>
";
            }
        }
        $portTypeWSDL.= "</portType>
";
        $bindingWSDL.= "</binding>
";
        return sprintf('%s%s%s%s%s%s', $headerWSDL, $portTypeWSDL, $bindingWSDL, $serviceWSDL, $messageWSDL, '</definitions>');
        //生成wsdl文件, 将上面的return注释, 去掉以下两行注释
        //$fso = fopen($this->class_name . ".wsdl", "w");
        //fwrite($fso, sprintf('%s%s%s%s%s%s', $headerWSDL, $portTypeWSDL, $bindingWSDL, $serviceWSDL, $messageWSDL, '</definitions>'));
    }

    /**
     * SoapDiscovery::getDiscovery() Returns discovery of WSDL.
     * 
     * @return string
     * */
    public function getDiscovery() {
        return "<?xml version="1.0" ?>
<disco:discovery xmlns:disco="http://schemas.xmlsoap.org/disco/" xmlns:scl="http://schemas.xmlsoap.org/disco/scl/">
<scl:contractRef ref="http://" . $_SERVER['SERVER_NAME'] . ':' . $_SERVER['SERVER_PORT'] . $_SERVER['PHP_SELF'] . "?wsdl" />
</disco:discovery>";
    }

}

　　server_wsdl.php代码如下

<?php
    //提供服务的类
    class Person {
        public function get_info() {
            $info = array(
                'name' => 'John',
                'age' => 25,
                'sex' => 'Man'
            );
            return serialize($info);
        }
    }
    
    //如果请求的是wsdl文件, 就用SoapDiscovery生成wsdl并返回
    if (!empty($_SERVER['QUERY_STRING']) && strcasecmp($_SERVER['QUERY_STRING'], 'wsdl') === 0) {
        include 'SoapDiscovery.class.php';
        //第一个参数是类名(生成的wsdl文件就是以它来命名的)即Person类, 第二个参数是服务的名字(这个可以随便写)
        $d = new SoapDiscovery('Person', 'Person');
        //以xml格式返回
        header('Content-Type:text/xml');
        echo $d->getWSDL();
    } else {
        $soap_server = new SoapServer("http://{$_SERVER['SERVER_NAME']}:{$_SERVER['SERVER_PORT']}{$_SERVER['PHP_SELF']}?wsdl");
        $soap_server->setClass('Person');
        $soap_server->handle();
    }

　　client_wsdl.php文件代码如下

<?php
    $soap_client = new SoapClient("http://localhost:80/server_wsdl.php?wsdl");
    $info = unserialize($soap_client->get_info());
    echo $info['name'];

　　在浏览器中访问http://localhost/client_wsdl.php

　　

常见问题

　　问题：使用WSDL（非NO-WSDL）时，Fatal error: SOAP-ERROR: Parsing WSDL: Couldn't load from 'http://xxx?wsdl'

　　解决：可以使用file_get_contents('http://xxx?wsdl');尝试获取返回数据，我的是报错了。。。返回的非XML，因为这种模式下$_SERVER['HTTP_USER_AGENT']竟然为空！！！！还有一种情况为不在IP白名单。。。。

　　问题：有的时候使用WSDL不稳定，N次出现一次连接失败

　　解决：使用NO-WSDL。。- -!