想了解 SOAP 究竟是什麼,最好的方式就是自己動手建一套 SOAP 物件。本文帶你從零打造一個可運行的 SOAP 服務端與客戶端。
SOAP(Simple Object Access Protocol,簡單物件存取協定)是當時 XML 開發的熱點,也是微軟新一代 Visual Studio 與 .NET 策略的核心角色。若只想快速做出一個可用的 SOAP 服務,用 VB 6 搭配微軟的 SOAP Toolkit 即可;但若想真正理解 SOAP 的運作,就必須自己把信封、標頭與本文都寫出來。
本文的目標很具體:服務端以 ASP 撰寫,命名為 soap.ASP,放在個人 Web 伺服器根目錄(例如 \Inetpub\wwwroot)下,負責接收並處理 SOAP 請求;客戶端是一個由 Sub Main() 啟動的 VB 可執行檔。
SOAP 本質上是「呼叫—回應」機制,採客戶/伺服器架構:客戶端向位於網際網路某處的 Web 伺服器發出函式呼叫並附上參數,伺服器處理後回傳回應;呼叫與回應的內容與資料都以 XML 格式傳送。
以下用一個計算銷售稅額的函式作為例子:
Public Function GetSalesTax(ByVal pSalesTotal As Double) As Double
GetSalesTax = pSalesTotal * 0.04
End Function
很粗糙,但足夠示範(只適用稅率 4% 的地區)。它定義了函式名 GetSalesTax、一個參數 pSalesTotal(銷售金額)與一個返回值。以物件導向的角度看,pSalesTotal 是 IN 參數,返回值則是 OUT 參數。SOAP 服務端要做的事,就是偵聽客戶端呼叫 GetSalesTax 並傳入的 IN 參數,然後回傳帶有 OUT 參數的回應。
傳統 VB 裡,呼叫看起來是這樣:
dblSalesTax = GetSalesTax(100) ' 得到 4 ' 若 GetSalesTax 是外部物件(例如 MTS 上的 DLL) Dim objTax As New CTaxCalc dblSalesTax = objTax.GetSalesTax(100)
在 SOAP 中,遠端呼叫改以 XML 文件傳送,內容包含函式名與參數:
<GetSalesTax> <SalesTotal>100</SalesTotal> </GetSalesTax>
為確保伺服器能辨識並解讀請求,這段呼叫必須包進一個 SOAP 信封,信封使用 SOAP 封裝標準的命名空間:
<SOAP:Envelope xmlns:SOAP="urn:schemas-xmlsoap-org:soap.v1">
<SOAP:Header></SOAP:Header>
<SOAP:Body>
<GetSalesTax>
<SalesTotal>100</SalesTotal>
</GetSalesTax>
</SOAP:Body>
</SOAP:Envelope>
最後加上函式呼叫的命名空間,其作用等同函式宣告:
<SOAP:Envelope xmlns:SOAP="urn:schemas-xmlsoap-org:soap.v1">
<SOAP:Header></SOAP:Header>
<SOAP:Body>
<m:GetSalesTax xmlns:m="urn:myserver/soap:TaxCalc">
<SalesTotal>100</SalesTotal>
</m:GetSalesTax>
</SOAP:Body>
</SOAP:Envelope>
請求檔備好後即可送出。傳輸方式與瀏覽器表單一樣使用 HTTP POST;本文以 XMLHTTP(需 IE 5 以上)示範:
Dim objHTTP As New MSXML.XMLHTTPRequest
Dim strEnvelope As String
' 設定要送達的伺服器
objHTTP.open "post", "https://localhost/soap/soap.ASP", False
' 設定標準 SOAP/XML 標頭
objHTTP.setRequestHeader "Content-Type", "text/xml"
' 指定呼叫的函式
objHTTP.setRequestHeader "SOAPMethodName", _
"urn:myserver/soap:TaxCalc#GetSalesTax"
' 送出 SOAP 呼叫
objHTTP.send strEnvelope
' 取得回應
strReturn = objHTTP.responseText
soap.ASP 必須能接收 HTTP 請求、解析 SOAP 信封,取出函式名與參數:
<%
Set objReq = Server.CreateObject("Microsoft.XMLDOM")
' 載入請求到 XML DOM
objReq.Load Request
' 依輸入參數取值
strQuery = "SOAP:Envelope/SOAP:Body/m:GetSalesTax/SalesTotal"
varSalesTotal = objReq.SelectSingleNode(strQuery).Text
' 計算稅額
varSalesTax = varSalesTotal * 0.04
' 組裝回應信封
strTmp = _
"<soap:envelope xmlns:soap=""urn:schemas-xmlsoap-org:soap.v1"">" & _
"<soap:header></soap:header>" & _
"<soap:body>" & _
"<m:getsalestaxresponse xmlns:m=""urn:myserver/soap:TaxCalc"">" & _
"<salestax>" & varSalesTax & "</salestax>" & _
"</m:getsalestaxresponse>" & _
"</soap:body>" & _
"</soap:envelope>"
Response.Write strTmp
%>
回應信封的組裝方式與客戶端類似,差別只有兩處:把 IN 參數換成 OUT 參數,並把函式標記名標為回應(GetSalesTaxResponse)。字串拼接與建立 DOM 節點兩種寫法都可以,前者直觀,後者在結構複雜時更好維護。
客戶端收到後解碼取值:
Dim objReturn As New MSXML.DOMDocument objReturn.loadXML strReturn strQuery = "SOAP:Envelope/SOAP:Body/m:GetSalesTaxResponse/SalesTax" dblTax = objReturn.selectSingleNode(strQuery).Text Debug.Print dblTax
Sub Main()
Dim objHTTP As New MSXML.XMLHTTPRequest
Dim strEnvelope As String
Dim strReturn As String
Dim objReturn As New MSXML.DOMDocument
Dim dblTax As Double
Dim strQuery As String
' 建立 SOAP 信封
strEnvelope = _
"<soap:Envelope xmlns:soap=""urn:schemas-xmlsoap-org:soap.v1"">" & _
"<soap:Header></soap:Header>" & _
"<soap:Body>" & _
"<m:GetSalesTax xmlns:m=""urn:myserver/soap:TaxCalculator"">" & _
"<SalesTotal>100</SalesTotal>" & _
"</m:GetSalesTax>" & _
"</soap:Body>" & _
"</soap:Envelope>"
' 以 HTTP POST 送出
objHTTP.open "post", "https://localhost/soap.ASP", False
objHTTP.setRequestHeader "Content-Type", "text/xml"
objHTTP.setRequestHeader "SOAPMethodName", _
"urn:myserver/soap:TaxCalculator#GetSalesTax"
objHTTP.send strEnvelope
' 解析回應
strReturn = objHTTP.responseText
objReturn.loadXML strReturn
strQuery = "SOAP:Envelope/SOAP:Body/m:GetSalesTaxResponse/SalesTax"
dblTax = objReturn.selectSingleNode(strQuery).Text
Debug.Print dblTax
End Sub
Visual Studio 7 把 SOAP 協定的細節都藏了起來,開發起來輕鬆,但出問題時無所下手。理解信封、命名空間與 id 配對的機制,除錯時會省下大量時間。另外,範例中的 SOAPMethodName 標頭屬於早期草案做法,後續標準改以 SOAPAction 標頭傳達意圖;命名空間 URI 也從 urn 形式演進為 https://schemas.xmlsoap.org/soap/envelope/。若要在今日的環境實作,建議直接採用 SOAP 1.1/1.2 的正式規範,並優先選擇成熟框架而非手寫信封。