Yii2结合SoapDiscovery， 实现Soap服务

Yii2结合SoapDiscovery， 实现Soap WebService服务

SOAP Web Service 一般PHPER们不会遇到，一旦有这个需求，写Wsdl描述文件，尤其是给C#之类的调用方，还是很伤脑筋的。

大家都知道把大象装冰箱，统共分几步，其实实现PHP SOAP也就三步：

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

所以，本人就以Yii2框架为例，一步步实现实现web service, 仅供参考。

Soap wsdl文件生成类 app\service\SoapDiscovery.php

注意， SoapDiscovery类来源于网络，本文中有所改动，结合yii2, 加入了namesapce, 特此声明。

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 = "\n";
        $headerWSDL.= "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.= "\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 = '';
        $bindingWSDL = '\n\n";
        $serviceWSDL = '\n\nservice_name . 'Port" binding="tns:' . $this->service_name . "Binding\">\n\n\n";
        $messageWSDL = '';
        foreach ($methods as $method) {
            if ($method->isPublic() && !$method->isConstructor()) {
                $portTypeWSDL.= '\n" . '\n
getName() . "Response\" />\n\n";
                $bindingWSDL.= '\n" . '\nservice_name\" encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\" />\n\n
\nservice_name\" encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\" />\n
\n\n";
                $messageWSDL.= '\n";
                $parameters = $method->getParameters();
                foreach ($parameters as $parameter) {
                    $messageWSDL.= '\n";
                }
                $messageWSDL.= "\n";
                $messageWSDL.= '\n";
                $messageWSDL.= '\n";
                $messageWSDL.= "\n";
            }
        }
        $portTypeWSDL.= "\n";
        $bindingWSDL.= "\n";
        //return sprintf('%s%s%s%s%s%s', $headerWSDL, $portTypeWSDL, $bindingWSDL, $serviceWSDL, $messageWSDL, '');
        //生成wsdl文件，将上面的return注释
        $fso = fopen(dirname(__FILE__) . '/' . $this->class_name . ".wsdl", "w");
        fwrite($fso, sprintf('%s%s%s%s%s%s', $headerWSDL, $portTypeWSDL, $bindingWSDL, $serviceWSDL, $messageWSDL, ''));
    }

    /**
     * SoapDiscovery::getDiscovery() Returns discovery of WSDL.
     *
     * @return string
     * */
    public function getDiscovery() {
        return "\n\n\n";
    }

}

web service 类 app\service\SoapService.php

namespace app\service;

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

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

控制器

• 生成wsdl app\controllers\CreatewsController.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();
    }
}

• 注册web service app\controllers\ServiceController.php

getRequest()->enableCsrfValidation = false;
    }
    
    /**
     * 服务地址注册  ／service/ws
     */
    public function actionWs()
    {
        //设置Yii响应格式为XML 
        \Yii::$app->response->format = \yii\web\Response::FORMAT_XML;
        $server = new \SoapServer(dirname(__FILE__) . '/\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 '
';
        echo 'SOAP types';
        print_r($client->__getTypes());
        echo 'SOAP Functions';
        print_r($client->__getFunctions());

        $result = $client->__soapCall('Add', [1, 2]);
        var_dump($result);


    }
}



 
 
Websercie & Rest 测试软件
 
 
 
  
 SoapUI 大杀器
 
 
 
 
 
   
  

    SoapUI 
  
 
 
 
 
 
  
 Chrome插件 轻量级，相当够用了。
 
 
 
 
 
  
 
   
 
     
   
 
  
 
  

    Boomerang.png 
  
 
 
 
 
参考资料&常见问题
 
 
 
  
The SoapServer class
 
  
The SoapClient class
 
  
调用.NET SOAP，传参
 
  
PHP Soap Error - Procedure 'xxx' not present
 
  
缓存问题， 设置 'cache_wsdl' => WSDL_CACHE_NONE