萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP 實作 SOAP WebService 完整步驟與代碼範例

前言

SOAP 是企業級應用整合常用的協議,PHP 內建 SoapServer 與 SoapClient 類別,配合 WSDL 定義,即可快速建立標準化的 Web 服務。本文將手把手帶你完成從介面定義、WSDL 生成、服務註冊到客戶端測試的完整流程。

專案目錄結構

service/
├── api.php              # 服務介面定義
├── api.wsdl             # 自動生成的 WSDL 文件
├── cometrue.php         # 服務啟動腳本
├── creat_wsdl.php       # WSDL 生成腳本
└── SoapDiscovery.class.php  # WSDL 生成輔助類(需自行下載)

實作步驟詳解

步驟 1:定義服務介面 api.php

<?php
/**
 * 服務介面類別
 * 所有 public 方法將自動暴露為 Web Service 操作
 */
class Api {
    /**
     * 測試方法
     * @param string $input 輸入字串
     * @return string 回傳字串
     */
    public function test($input) {
        return 'Server received: ' . $input;
    }

    /**
     * 取得當前伺服器時間
     * @return string 格式化時間
     */
    public function getServerTime() {
        return date('Y-m-d H:i:s');
    }
}
?>

步驟 2:生成 WSDL 文件 creat_wsdl.php

使用 SoapDiscovery.class.php 透過反射自動生成 WSDL:

<?php
require_once 'api.php';
require_once 'SoapDiscovery.class.php';

// 參數:類別名稱、服務名稱
$disco = new SoapDiscovery('Api', 'MySoapService');
$wsdlContent = $disco->getWSDL();

// 輸出到文件
file_put_contents('api.wsdl', $wsdlContent);
echo 'WSDL 文件生成成功:api.wsdl';
?>

在瀏覽器或 CLI 執行此腳本,即會在同目錄下產生 api.wsdl。

步驟 3:啟動 SOAP 服務 cometrue.php

<?php
require_once 'api.php';

// 實例化 SoapServer,指定 WSDL 與 SOAP 版本
$server = new SoapServer('api.wsdl', [
    'soap_version' => SOAP_1_2,
    'encoding' => 'UTF-8',
    'cache_wsdl' => WSDL_CACHE_NONE, // 開發階段關閉快取
]);

// 註冊服務類別(所有 public 方法自動公開)
$server->setClass('Api');

// 處理請求
$server->handle();
?>

步驟 4:客戶端測試 test_client.php

<?php
// 替換為實際可訪問的 cometrue.php URL
$wsdlUrl = 'https://your-domain.com/service/cometrue.php?wsdl';

try {
    $client = new SoapClient($wsdlUrl, [
        'trace' => true,           // 除錯用
        'exceptions' => true,      // 拋出例外
        'cache_wsdl' => WSDL_CACHE_NONE,
    ]);

    // 呼叫遠端方法
    $result = $client->test('Hello from Client!');
    echo '呼叫 test() 成功:' . $result . PHP_EOL;

    $time = $client->getServerTime();
    echo '伺服器時間:' . $time . PHP_EOL;

    // 除錯:查看最後請求/回應 XML
    // echo 'Request: ' . $client->__getLastRequest() . PHP_EOL;
    // echo 'Response: ' . $client->__getLastResponse() . PHP_EOL;

} catch (SoapFault $e) {
    echo 'SOAP 錯誤:' . $e->getMessage() . PHP_EOL;
} catch (Exception $e) {
    echo '其他錯誤:' . $e->getMessage() . PHP_EOL;
}
?>

常見問題與解決方案

問題原因解決方法
WSDL 生成失敗SoapDiscovery 類別不支援 PHP 8+ 語法改用官方 SoapServer 搭配手寫 WSDL,或使用 wsdl2phpgenerator
客戶端報錯 "looks like we got no XML document"服務端輸出了非 XML 內容(如錯誤訊息、空白字元)確保 cometrue.php 無任何 echo/print/空白輸出;開啟 display_errors=Off、log_errors=On
中文參數亂碼編碼不一致統一使用 UTF-8:PHP 文件存儲、SoapServer encoding 參數、資料庫連線、HTML meta 標籤
效能瓶頸SOAP XML 解析開銷大啟用 WSDL 快取 WSDL_CACHE_DISK;考慮改用 REST/JSON API

進階應用建議

  • 類別映射:使用 classmap 選項將複雜類型映射到 PHP 物件,避免操作 stdClass。
  • WS-Security:企業級應用可加入 UsernameToken 或 X.509 憑證驗證,需擴展 SoapHeader 處理。
  • 錯誤處理:在服務端使用 try-catch 捕獲業務異常,拋出 SoapFault 回傳標準錯誤代碼給客戶端。
  • 非 WSDL 模式:簡單場景可不使用 WSDL,直接在 SoapServer 建構時傳入 null 並用 addFunction 註冊單一函數。

總結

PHP 內建 SOAP 擴展提供了完整的伺服端與客戶端支援,配合 WSDL 自動生成工具,可快速建立符合 WS-I 規範的互操作服務。雖然現代架構傾向 REST/JSON,但在金融、電信、政府等強契約領域,SOAP 仍是主流選擇。掌握其建立與除錯流程,對維護舊系統或對接傳統企業系統至關重要。

copyright © 萬盛學電腦網 all rights reserved