PHP Soap 服务器响应格式

Posted 2023-02-24

【中文标题】PHP Soap 服务器响应格式

【英文标题】：PHP Soap Server response formatting

【发布时间】：2014-06-25 13:51:26

【问题描述】：

我正在用 php 制作一个 SOAP Web 服务，它必须满足客户端 XSD 文件的要求。

这是客户端提供的 XSD 文件的链接：http://pastebin.com/MX1BZUXc

他们期望的响应如下所示：

[为了便于阅读，有些长线被打断，理论上问题与空格无关。]

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header />
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
          xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <CheckVersionResponse xmlns="http://www.---.---/---">
      <CheckversionResult>
        <ValidationOk>true</ValidationOk>
        <VersionNumber>1.4.0</VersionNumber>
        <CurrentRemoteServerTime
          >2014-05-02T09:35:20.368+02:00</CurrentRemoteServerTime>
      </CheckversionResult>
    </CheckVersionResponse>
  </s:Body>
</s:Envelope>

但是，我目前得到的响应是这样的：

<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" 
              xmlns:ns1="http://---.---/" 
              xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
              xmlns:enc="http://www.w3.org/2003/05/soap-encoding">
<env:Body xmlns:rpc="http://www.w3.org/2003/05/soap-rpc">
    <ns1:CheckVersionResponse 
      env:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
        <rpc:result>return</rpc:result>
        <return xsi:type="enc:Struct">
            <ValidationOk xsi:type="xsd:int">1</ValidationOk>
            <VersionNumber xsi:type="xsd:string"
              >1.4.0</VersionNumber>
            <CurrentRemoteServerTime xsi:type="xsd:string"
              >2014-05-08T10:31:49</CurrentRemoteServerTime>
        </return>
    </ns1:CheckVersionResponse>
</env:Body>
</env:Envelope>

这就是我创建 SOAP 网络服务的方式：

<?php

/* Helper class for my response object */
class CheckVersionResult extends stdClass

    /** @var bool */
    public $ValidationOk = '';
    /** @var string */
    public $VersionNumber = '';
    /** @var string */
    public $CurrentRemoteServerTime = '';


/* SOAP interface class */
class MySoapClass

    /**
     * Returns version
     *
     * @param string $param1
     * @param string $param2
     * @return CheckVersionResult
     */
    public function CheckVersion($param1, $param2)
    
        $data = new CheckVersionResult();
        $data->ValidationOk = 1;
        $data->VersionNumber = '1.4.0';
        $data->CurrentRemoteServerTime = date('Y-m-d\TH:i:s');
    


/* Controller class */
class WebserviceController 

    public function indexAction() 
        $soap = new Zend_Soap_Server();
        $soap->setClass('MySoapClass');
        $soap->setUri("http://---.---/");
        $mySoapClass = new MySoapClass();
        $soap->setObject($mySoapClass);
        $soap->setSoapVersion(SOAP_1_2);
        $soap->handle();
    

这就是我调用我的网络服务的方式：

$client = new SoapClient(null, array(
    "soap_version" => SOAP_1_2,
    "location" => "http://---.---/webservice/index",
    "uri" => "http://---.---/",
    "trace" => 1, // enable trace to view what is happening
    "exceptions" => 0, // disable exceptions
    "cache_wsdl" => 0)   // no wsdl
);

$client->CheckVersion('param1', 'param2');
header('Content-Type: application/xml; charset=utf-8');
echo $client->__getLastResponse();
die();

有谁知道如何根据我收到的 XSD 文件正确格式化我的 SOAP 响应？

【问题讨论】：

我在这里看到两个问题：a) 您错过了将 XSD 文件添加到您的问题 - 但您询问了它。 b) 您错过了根据 XSD 要求说出您在哪里看到的差异。两个 XML 块看起来都具有相同的元素（只是缺少一个空标头，我认为在 SOAP 中可以忽略它）。所以从格式化的角度来看，没有什么可做的，它不清楚你要的是什么。

我编辑了问题，添加了 XSD 文件

答案中缺少 CheckversionResult 元素，看起来它被替换为<return xsi:type="enc:Struct">，我想知道这是怎么回事。是 WSDL 模式吗？

不，这是非 WSDL 模式。我还从客户那里收到了一个 WSDL，说他们是 XSD 和 WSDL 文件的主人，所以我不应该自己生成这些文件。然而，这让我很困惑。 WSDL 文件不是将 SOAP 客户端指向 SOAP 服务器的文件吗？那么他们的 WSDL 文件应该如何指向我的 SOAP 服务器呢？

WSDL 文件定义了服务。它可以由 SOAP 客户端使用，以便知道远程过程（以及参数和返回值的类型），还可以为服务器定义相同的过程。 XSD 定义了类型。两者都可以用于客户端和服务器。通常使用 WSDL 更容易实现。

【参考方案1】：

您必须构造一个正确的 wsdl 文件。现在您的服务器以默认的 rpc 样式运行。尝试使用：http://framework.zend.com/manual/1.12/en/zend.soap.autodiscovery.html 与不同的 WSDL 绑定样式。

类似这样的：

server.php:

<?php

error_reporting(E_ALL);
ini_set('display_errors', 1);

set_include_path(get_include_path().';./library/;./library/Zend');

require_once 'Zend/Loader/Autoloader.php';

$autoloader = Zend_Loader_Autoloader::getInstance();
$autoloader->setFallbackAutoloader(true);

/* Helper class for my response object */
class CheckVersionResult extends stdClass

    /** @var bool */
    public $ValidationOk = '';
    /** @var string */
    public $VersionNumber = '';
    /** @var string */
    public $CurrentRemoteServerTime = '';


/* SOAP interface class */
class MySoapClass

    /**
     * Returns version
     *
     * @param string $param1
     * @param string $param2
     * @return CheckVersionResult
     */
    public function CheckVersion($param1, $param2)
    
        $data = new CheckVersionResult();
        $data->ValidationOk = 1;
        $data->VersionNumber = '1.4.0';
        $data->CurrentRemoteServerTime = date('Y-m-d\TH:i:s');

        return $data;
    


$mySoapClass = new MySoapClass();


if(isset($_GET['wsdl'])) 
    $autodiscover = new Zend_Soap_AutoDiscover();
    $autodiscover->setClass('MySoapClass');

    $autodiscover->setOperationBodyStyle(
    array('use' => 'literal',
          'namespace' => 'http://localhost/stack/23537231/server.php')
    );

    $autodiscover->setBindingStyle(
        array('style' => 'document',
          'transport' => 'http://localhost/stack/23537231/server.php')
    );

    $autodiscover->handle();
 else 
    // pointing to the current file here
    $soap = new Zend_Soap_Server("http://localhost/stack/23537231/server.php?wsdl", array(
        'cache_wsdl'=> WSDL_CACHE_NONE,
        'classmap'  => array(
            'CheckVersionResult'=>'CheckVersionResult',
        )

    ));
    $soap->setClass('MySoapClass');
    $soap->handle();

client.php

<?php

error_reporting(E_ALL);
ini_set('display_errors', 1);

set_include_path(get_include_path().';./library/;./library/Zend');

require_once 'Zend/Loader/Autoloader.php';

$autoloader = Zend_Loader_Autoloader::getInstance();
$autoloader->setFallbackAutoloader(true);

/* Helper class for my response object */
class CheckVersionResult extends stdClass

    /** @var bool */
    public $ValidationOk = '';
    /** @var string */
    public $VersionNumber = '';
    /** @var string */
    public $CurrentRemoteServerTime = '';


$client = new SoapClient('http://localhost/stack/23537231/server.php?wsdl', array(
        "trace" => 1, // enable trace to view what is happening
        "exceptions" => 1, // disable exceptions
        "cache_wsdl" => WSDL_CACHE_NONE,
        'classmap'  => array(
            'CheckVersionResult'=>'CheckVersionResult',
        ))   // no wsdl
);

$ret = $client->CheckVersion('param1', 'param2');
header('Content-Type: application/xml; charset=utf-8');

echo $client->__getLastResponse();
die();

有了这个，我有这个：

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <SOAP-ENV:Body>
    <ns1:CheckVersionResponse>
      <return xsi:type="ns1:CheckVersionResult">
        <ValidationOk xsi:type="xsd:boolean">true</ValidationOk>
        <VersionNumber xsi:type="xsd:string">1.4.0</VersionNumber>
        <CurrentRemoteServerTime xsi:type="xsd:string">2014-05-19T22:22:59</CurrentRemoteServerTime>
      </return>
    </ns1:CheckVersionResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

旁注：我认为您的回复是有效的肥皂回复。因此，如果客户端是有效的soap客户端，它应该能够解析响应并仍然使用它。

【讨论】：

嗨，格雷格，感谢您的回复。这是一个有效的soap 响应，但它不能通过客户端的XSD 进行验证。我在问题中添加了 XSD。我可以构造一个 WSDL 文件，但我也从客户端获得了一个 WSDL 文件，因此它们是 XSD 和 WSDL 文件的主人。我应该在我的服务器上使用他们的 WSDL 文件吗？但是他们的 wsdl 文件如何指向我的网络服务呢？我很困惑！