yii2实现WebService 使用 SoapDiscovery

结合SoapDiscovery实现简单的WebService服务

1 修改php.ini文件

  php_soap.dll 

  extension=php_soap.dll

2 WebService 实现主要步骤

  • 生成wsdl描述文件
  • 使用SoapServer注册服务
  • 使用SoapClient调用服务

3 目录结构以及代码 

   根目录

  ==service目录

  ||== SoapDiscovery.php 【Soap wsdl文件生成类 】

  ||==SoapService.php 【web service 提供的列表】

  ==controllers目录

  ||==CreatewsController.php 【生成WSDL文件 】

  ||==ServiceController【注册、调用测试】

SoapDiscovery.php 【Soap wsdl文件生成类 】

<?php
/**
 * Created by PhpStorm.
 * User: 知电
 * Date: 2018-1-2
 * Time: 10:14
 */
namespace app\service;
/**
 * 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$
 * @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$
 * @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\" ?>\n";
        $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/\">\n";
        $headerWSDL.= "<types xmlns=\"http://schemas.xmlsoap.org/wsdl/\" />\n";

        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\">\n<soap:binding style=\"rpc\" transport=\"http://schemas.xmlsoap.org/soap/http\" />\n";
        $serviceWSDL = '<service name="' . $this->service_name . "\">\n<documentation />\n<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'] . "\" />\n</port>\n</service>\n";
        $messageWSDL = '';
        foreach ($methods as $method) {
            if ($method->isPublic() && !$method->isConstructor()) {
                $portTypeWSDL.= '<operation name="' . $method->getName() . "\">\n" . '<input message="tns:' . $method->getName() . "Request\" />\n<output message=\"tns:" . $method->getName() . "Response\" />\n</operation>\n";
                $bindingWSDL.= '<operation name="' . $method->getName() . "\">\n" . '<soap:operation soapAction="urn:' . $this->service_name . '#' . $this->class_name . '#' . $method->getName() . "\" />\n<input><soap:body use=\"encoded\" namespace=\"urn:$this->service_name\" encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\" />\n</input>\n<output>\n<soap:body use=\"encoded\" namespace=\"urn:$this->service_name\" encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\" />\n</output>\n</operation>\n";
                $messageWSDL.= '<message name="' . $method->getName() . "Request\">\n";
                $parameters = $method->getParameters();
                foreach ($parameters as $parameter) {
                    $messageWSDL.= '<part name="' . $parameter->getName() . "\" type=\"xsd:string\" />\n";
                }
                $messageWSDL.= "</message>\n";
                $messageWSDL.= '<message name="' . $method->getName() . "Response\">\n";
                $messageWSDL.= '<part name="' . $method->getName() . "\" type=\"xsd:string\" />\n";
                $messageWSDL.= "</message>\n";
            }
        }
        $portTypeWSDL.= "</portType>\n";
        $bindingWSDL.= "</binding>\n";
        //return sprintf('%s%s%s%s%s%s', $headerWSDL, $portTypeWSDL, $bindingWSDL, $serviceWSDL, $messageWSDL, '</definitions>');
        //生成wsdl文件,将上面的return注释
        $fso = fopen(dirname(__FILE__) . '/' . $this->class_name . ".wsdl", "w111");
        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\" ?>\n<disco:discovery xmlns:disco=\"http://schemas.xmlsoap.org/disco/\" xmlns:scl=\"http://schemas.xmlsoap.org/disco/scl/\">\n<scl:contractRef ref=\"http://" . $_SERVER['SERVER_NAME'] . ':' . $_SERVER['SERVER_PORT'] . $_SERVER['PHP_SELF'] . "?wsdl\" />\n</disco:discovery>";
    }
}
View Code

SoapService.php 【web service 提供的列表】

<?php
/**
 * Created by PhpStorm.
 * User: 知电
 * Date: 2018-1-2
 * Time: 10:14
 */
namespace app\service;

class SoapService
{
    public function HelloWorld() {
        return "Hello";
    }

    public function Add($a, $b) {
        return $a + $b;
    }

    public function SayHello($name){
        return 'Hell,'. $name;
    }
}
View Code

CreatewsController.php 【生成WSDL文件 】

<?php

namespace app\controllers;

use Yii;
use yii\web\Controller;
use app\service\SoapService;
use app\service\SoapDiscovery;

class CreatewsController extends Controller
{
    public function actionIndex()
    {
        $disco = new SoapDiscovery('\app\service\SoapService', 'soap'); //第一个参数是类名(生成的wsdl文件就是以它来命名的),即Service类,第二个参数是服务的名字(这个可以随便写)。
        $r = $disco->getWSDL();
    }
}
View Code

ServiceController.php【注册、调用测试】

<?php
/**
 * Created by PhpStorm.
 * User: 知电
 * Date: 2018-1-2
 * Time: 10:16
 */
namespace app\controllers;
use Yii;
use yii\web\Controller;
class ServiceController extends Controller
{
    public $ws_url = 'http://host.com/service/ws?wsdl'; //服务注册地址
    public function init()
    {
        Yii::$app->getRequest()->enableCsrfValidation = false;
    }

    /**
     * 服务地址注册  /service/ws
     */
    public function actionWs()
    {
        //设置Yii响应格式为XML
        \Yii::$app->response->format = \yii\web\Response::FORMAT_XML;
        $server = new \SoapServer(dirname(dirname(__FILE__)) . '/\service\app\service\SoapService.wsdl', array('soap_version' => SOAP_1_2));
        $server->setClass('\app\service\SoapService'); //注册Service类的所有方法
        $server->handle(); //处理请求
    }


    /**
     * 测试调用
     */
    public function actionTest()
    {
        $client = new \SoapClient($this->ws_url, array(
            'soap_version'   => SOAP_1_2,
            'cache_wsdl' => WSDL_CACHE_NONE
        ));
        echo 'SOAP 类型';
        echo '<pre>';
        var_dump($client->__getTypes());//获取服务器上数据类型
        echo ('</pre>');
        echo 'SOAP 方法';
        echo '<pre>';
        var_dump($client->__getFunctions());//获取服务器上提供的方法
        echo ('</pre>');
        echo ("执行的结果:");
        $result = $client->__soapCall('SayHello',[111]);
        var_dump($result);
    }
}
View Code

 

备注:生成WSDL文件后,需把WSDL里面的 address location更改一下变为实际的注册地址[参考ServiceController.php说明]

 eg:

官方文档 http://www.yiichina.com/tutorial/817

php 调用WebService 的常见方法 http://blog.csdn.net/sagatx/article/details/9318497

posted @ 2018-01-02 14:51 Dzs 阅读(...) 评论(...) 编辑 收藏