XML SOAP

• SOAP 代表 **S**imple **O**bject **A**ccess **P**rotocol (簡單物件訪問協議)
• SOAP 是一種應用程式通訊協議
• SOAP 是一種用於傳送和接收訊息的格式
• SOAP 是平臺無關的
• SOAP 基於 XML
• SOAP 是 W3C 的一項推薦

為什麼要使用 SOAP？

Web 應用程式能夠透過 Internet 進行通訊非常重要。

應用程式之間通訊的最佳方式是 HTTP，因為所有 Internet 瀏覽器和伺服器都支援 HTTP。SOAP 的建立就是為了實現這一目標。

SOAP 提供了一種應用程式在不同作業系統、使用不同技術和程式語言之間進行通訊的方法。

SOAP 構建塊

SOAP 訊息是一個普通的 XML 文件，包含以下元素

• Envelope 元素，用於標識 XML 文件為 SOAP 訊息
• Header 元素，包含頭部資訊
• Body 元素，包含呼叫和響應資訊
• Fault 元素，包含錯誤和狀態資訊

以上所有元素都在 SOAP envelope 的預設名稱空間中宣告

http://www.w3.org/2003/05/soap-envelope

SOAP 編碼和資料型別的預設名稱空間是

http://www.w3.org/2003/05/soap-encoding

語法規則

以下是一些重要的語法規則

• SOAP 訊息 **必須** 使用 XML 進行編碼
• SOAP 訊息 **必須** 使用 SOAP Envelope 名稱空間
• SOAP 訊息 **不得** 包含 DTD 引用
• SOAP 訊息 **不得** 包含 XML 處理指令

Skeleton SOAP 訊息

SOAP Envelope 元素

必需的 SOAP Envelope 元素是 SOAP 訊息的根元素。此元素將 XML 文件定義為 SOAP 訊息。

示例

xmlns:soap 名稱空間

請注意上面示例中的 xmlns:soap 名稱空間。它應始終具有值："http://www.w3.org/2003/05/soap-envelope"。

該名稱空間將 Envelope 定義為 SOAP Envelope。

如果使用不同的名稱空間，應用程式將生成錯誤並丟棄該訊息。

encodingStyle 屬性

encodingStyle 屬性用於定義文件中使用的資料型別。此屬性可以出現在任何 SOAP 元素上，並且適用於該元素的以及所有子元素的名稱。

SOAP 訊息沒有預設編碼。

語法

示例

SOAP Header 元素

可選的 SOAP Header 元素包含關於 SOAP 訊息的應用程式特定資訊（如身份驗證、付款等）。

如果存在 Header 元素，它必須是 Envelope 元素的第一個子元素。

注意： Header 元素的所有直接子元素都必須是名稱空間限定的。

上面的示例包含一個帶有 "Trans" 元素的頭部，一個值為 1 的 "mustUnderstand" 屬性，以及值為 234 的內容。

SOAP 在預設名稱空間中定義了三個屬性。這些屬性是：mustUnderstand、actor 和 encodingStyle。

在 SOAP Header 中定義的屬性決定了接收者應如何處理 SOAP 訊息。

mustUnderstand 屬性

SOAP mustUnderstand 屬性可用於指示頭部條目對接收者來說是必需的還是可選的。

如果將 mustUnderstand="1" 新增到 Header 元素的子元素中，則表示處理 Header 的接收者必須識別該元素。如果接收者不識別該元素，它在處理 Header 時會失敗。

語法

示例

actor 屬性

SOAP 訊息可能從傳送方到接收方，在訊息路徑上傳遞不同的端點。但是，並非 SOAP 訊息的所有部分都可能針對最終端點，而是可能針對訊息路徑上一個或多個端點。

SOAP actor 屬性用於將 Header 元素指向特定的端點。

語法

示例

encodingStyle 屬性

encodingStyle 屬性用於定義文件中使用的資料型別。此屬性可以出現在任何 SOAP 元素上，並且適用於該元素的以及所有子元素的名稱。

SOAP 訊息沒有預設編碼。

語法

SOAP Body 元素

必需的 SOAP Body 元素包含傳送給訊息最終端點的實際 SOAP 訊息。

SOAP Body 元素的直接子元素可以是名稱空間限定的。

示例

上面的示例請求蘋果的價格。請注意，上面的 m:GetPrice 和 Item 元素是應用程式特定的元素。它們不是 SOAP 名稱空間的一部分。

SOAP 響應可能如下所示

SOAP Fault 元素

可選的 SOAP Fault 元素用於指示錯誤訊息。

SOAP Fault 元素包含 SOAP 訊息的錯誤和狀態資訊。

如果存在 Fault 元素，它必須作為 Body 元素的子元素出現。一個 Fault 元素在一個 SOAP 訊息中只能出現一次。

SOAP Fault 元素具有以下子元素

SOAP 故障程式碼

在描述故障時，必須在 faultcode 元素中使用下面定義的 faultcode 值

HTTP 協議

HTTP 透過 TCP/IP 進行通訊。HTTP 客戶端使用 TCP 連線到 HTTP 伺服器。建立連線後，客戶端可以向伺服器傳送 HTTP 請求訊息

然後伺服器處理請求，並將 HTTP 響應傳送回客戶端。響應包含一個狀態碼，指示請求的狀態

在上面的示例中，伺服器返回了狀態碼 200。這是 HTTP 的標準成功程式碼。

如果伺服器無法解碼請求，它可能會返回類似這樣的內容

SOAP 繫結

SOAP 規範定義了 SOAP 訊息的結構，而不是如何交換它們。這個空白由所謂的“SOAP 繫結”來填補。SOAP 繫結是允許使用傳輸協議有效交換 SOAP 訊息的機制。

大多數 SOAP 實現都提供了常見傳輸協議（如 HTTP 或 SMTP）的繫結。

HTTP 是同步的，並且被廣泛使用。SOAP HTTP 請求至少指定兩個 HTTP 頭部：Content-Type 和 Content-Length。

SMTP 是非同步的，並且用於最後手段或特定情況。

SOAP 的 Java 實現通常為 JMS (Java Messaging System) 協議提供特定的繫結。

Content-Type

SOAP 請求和響應的 Content-Type 頭部定義了訊息的 MIME 型別以及用於請求或響應的 XML 主體的字元編碼（可選）。

語法

示例

Content-Length

SOAP 請求和響應的 Content-Length 頭部指定了請求或響應正文中的位元組數。

語法

示例

SOAP 示例

在下面的示例中，將 GetStockPrice 請求傳送到伺服器。請求有一個 StockName 引數，以及一個將在響應中返回的 Price 引數。函式名稱空間定義在 "http://www.example.org/stock" 中。

SOAP 請求

SOAP 響應