PHP 建立與呼叫 WebService (SOAP) 完整實戰範例

PHP 建立與呼叫 WebService (SOAP) 完整實戰範例

WebService 採用 XML + HTTP 跨平台交換資料，核心標準包含 SOAP (傳輸協定)、WSDL (服務描述)、UDDI (註冊發現)。PHP 透過 SoapServer / SoapClient 類別原生支援。

架構概覽

[Client] --SOAP Request (HTTP POST)--> [Server (SoapServer)]
                                    <-- SOAP Response (XML) --

步驟 1：定義服務類別 (Service.php)

<?php
// Service.php - 實際業務邏輯
class Service {
    public function Hello() {
        return 'hello good';
    }
    public function Add($a, $b) {
        return $a + $b;
    }
}
?>

步驟 2：自動生成 WSDL (creat_wsdl.php)

需下載 SoapDiscovery.class.php (開源工具類)，或使用 Zend Studio 等 IDE 圖形化生成。

<?php
// creat_wsdl.php
include_once('Service.php');
include_once('SoapDiscovery.class.php');

$wsdl = new SoapDiscovery('Service', 'soap');  // 類名、服務名
$wsdl->getWSDL();  // 輸出 Service.wsdl 並直接輸出至瀏覽器
?>

執行後將輸出內容另存為 Service.wsdl 放置於服務端同目錄。

步驟 3：建立 SOAP 伺服器端點 (server.php)

<?php
// server.php
include_once('Service.php');

$server = new SoapServer('Service.wsdl', array(
    'soap_version' => SOAP_1_2,
    'cache_wsdl'   => WSDL_CACHE_NONE,  // 開發階段關閉快取
));
$server->setClass('Service');  // 註冊所有 public 方法
$server->handle();             // 處理請求
?>

步驟 4：客戶端呼叫 (client.php)

<?php
// client.php
ini_set('soap.wsdl_cache_enabled', 0);  // 關閉 WSDL 快取 (開發必備)

$client = new SoapClient('https://localhost/soap/Service.wsdl', array(
    'trace'      => 1,        // 除錯用
    'exceptions' => true,     // 拋出 SoapFault 異常
));

try {
    echo $client->Add(1, 2);           // 輸出 3
    // 或使用 __soapCall
    // echo $client->__soapCall('Add', array(1, 2));
} catch (SoapFault $e) {
    echo "SOAP Error: {$e->getMessage()}";
    // 除錯：var_dump($client->__getLastRequest(), $client->__getLastResponse());
}
?>

進階主題

複雜型別 (Complex Types)

WSDL 中定義 <complexType>，PHP 端對應 stdClass 或自定類別 + __set/__get，或使用 SoapVar 指定編碼。

認證與 Header

$header = new SoapHeader('https://ns.example.com', 'AuthToken', array('user'=>'a','pass'=>'b'));
$client->__setSoapHeaders($header);

呼叫 Java/.NET WebService

• 確認對方提供的 WSDL 可正常解析
• 注意命名空間 (targetNamespace) 一致性
• 參數型別嚴格對應 (如 Java long → PHP int)
• 若遇 looks like we got no XML document，檢查是否為 REST/JSON 而非 SOAP

常見問題排查