簡單對象協議（SOAP）簡介

2024-07-21 02:21:32

字體：大中小

來源：轉載

供稿：網友

簡單對象訪問協議-cnxml標準教程 
    2000-9-25    作者：何杭軍 
 
"soap是在非集中、分布環境中交換信息的輕量級協議。它是基于xml的協議，包括三個部分：封套(envelope)定義了消息內容和處理的框架、一套編碼規則用來表達應用定義數據類型的實例以及表達遠程過程調用和響應的協定。" 
——soap 1.1規范 
 
第一節 soap簡介 
 
soap(simple object access protocal，簡單對象訪問協議) 技術有助于實現大量異構程序和平臺之間的互操作性，從而使存在的應用能夠被廣泛的用戶所訪問。soap是把成熟的基于http的web技術與xml的靈活性和可擴展性組合在了一起。 
 
soap的一個主要目標是使存在的應用能被更廣泛的用戶所使用。為了實現這個目的，沒有任何soap api或soap 對象請求代理（soap orb），soap是假設你將使用盡可能多的存在的技術。幾個主要的corba廠商已經承諾在他們的orb產品中支持soap協議。微軟也承諾在將來的com版本中支持soap。developmentor已經開發了參考實現，它使得在任何平臺上的任何java或perl程序員都可以使用soap。而且ibm和sun也陸續支持了soap協議，和ms合作共同開發soap規范和應用。目前soap已經成為了w3c和ietf的參考標準之一。 
 
soap的指導理念是“它是第一個沒有發明任何新技術的技術”。它采用了已經廣泛使用的兩個協議：http和xml。http用于實現soap的rpc風格的傳輸，而xml是它的編碼模式。采用幾行代碼和一個xml解析器，http服務器（如ms的iis或apache）立刻成為了soap的orbs。因為目前超過一半的web服務器采用iis或apache, soap將會從這兩個產品的廣泛而可靠的使用中獲取利益。這并不意味著所有的soap請求必須通過web服務器來路由，傳統的web 服務器只是分派soap請求的一種方式。因此web服務如iis或apache對建立soap性能的應用是充分的，但決不是必要的。 
 
soap把xml的使用代碼化為請求和響應參數編碼模式，并用http作傳輸。這似乎有點抽象。具體地講，一個soap方法可以簡單地看作遵循soap編碼規則的http請求和響應。一個soap終端則可以看作一個基于http的url，它用來識別方法調用的目標。象corba/iiop一樣，soap不需要具體的對象被綁定到一個給定的終端，而是由具體實現程序來決定怎樣把對象終端標識符映射到服務器端的對象。 
 
soap請求是一個http post請求。soap請求的content-type必須用text/xml。而且它必須包含一個請求-uri。服務器怎樣解釋這個請求-uri是與實現相關的，但是許多實現中可能用它來映射到一個類或者一個對象。一個soap請求也必須用soapmethodname http頭來指明將被調用的方法。簡單地講，soapmethodname頭是被uri指定范圍的應用相關的方法名，它是用#符作為分隔符將方法名與uri分割開： 
 
soapmethodname: urn:strings-com:istring#reverse 
 
這個頭表明方法名是reverse，范圍uri是urn:strings-com:istring。在soap中，規定方法名范圍的名域uri在功能上等同于在dcom 或 iiop中規定方法名范圍的接口id。 
 
簡單的說，一個soap請求的http體是一個xml文檔，它包含方法中[in]和[in,out]參數的值。這些值被編碼成為一個顯著的調用元素的子元素，這個調用元素具有soapmethodname http頭的方法名和名域uri。調用元素必須出現在標準的soap <envelope>和<body>元素內（后面會更多討論這兩個元素）。下面是一個最簡單的soap方法請求： 
 
post /string_server/object17 http/1.1 
host: 209.110.197.2 
content-type: text/xml 
content-length: 152 
soapmethodname: urn:strings-com:istring#reverse         
<envelope> 
<body> 
  <m:reverse xmlns:m=''urn:strings-com:istring''> 
   <thestring>hello, world</thestring> 
  </m:reverse> 
</body> 
</envelope> 
soapmethodname頭必須與<body>下的第一個子元素相匹配，否則調用將被拒絕。這允許防火墻管理員在不解析xml的情況下有效地過濾對一個具體方法的調用。 
 
soap響應的格式類似于請求格式。響應體包含方法的[out]和 [in,out]參數，這個方法被編碼為一個顯著的響應元素的子元素。這個元素的名字與請求的調用元素的名字相同，但以response后綴來連接。下面是對前面的soap請求的soap響應： 
 
200 ok content-type: text/xml 
content-length: 162 
<envelope> 
<body> 
  <m:reverseresponse xmlns:m=''urn:strings-com:istring''> 
   <result>dlrow ,olleh</result> 
  </m:reverseresponse> 
</body> 
</envelope> 
這里響應元素被命名為reverseresponse，它是方法名緊跟response后綴。要注意的是這里是沒有soapmethodname http頭的。這個頭只在請求消息中需要，在響應消息中并不需要。 
 
第二節 soap體的核心 
 
soap的xml特性是為把數據類型的實例序列化成xml的編碼模式。為了達到這個目的，soap不要求使用傳統的rpc風格的代理。而是一個soap方法調用包含至少兩個數據類型：請求和響應。考慮這下面個com idl代碼： 
 
 
[ uuid(deadf00d-bead-bead-bead-baabaabaabaa) ] 
interface ibank : iunknown { 
hresult withdraw([in] long account, 
[out] float *newbalance, 
[in, out] float *amount 
[out, retval] variant_bool *overdrawn); 
} 
在任何rpc協議下，account和amount參數的值將出現在請求消息中，newbalance、overdrawn參數的值，還有amount參數的更新值將出現在響應消息中。 
 
soap把方法請求和方法響應提升到了一流狀態。在soap中，請求和響應實際上類型的實例。為了理解一個方法比如ibank::withdraw怎樣映射一個soap請求和響應類型，考慮下列的數據類型： 
 
struct withdraw { 
long account; 
float amount; 
}; 
 
這時所有的請求參數被打包成為單一的結構類型。同樣下面的數據表示打包所有響應參數到單一的數據類型。 
 
struct withdrawresponse { 
float newbalance; 
float amount; 
variant_bool overdrawn; 
}; 
再給出下面的簡單的visual basic程序，它使用了以前定義的ibank接口： 
 
dim bank as ibank 
dim amount as single 
dim newbal as single 
dim overdrawn as boolean 
amount = 100 
set bank = getobject("soap:http://bofsoap.com/am") 
overdrawn = bank.withdraw(3512, amount, newbal) 
            
          
這里，在發送請求消息之前，參數被序列化成為一個請求對象。同樣被響應消息接收到的響應對象被反序列化為參數。一個類似的轉變同樣發生在調用的服務器端。 
 
當通過soap調用方法時，請求對象和響應對象被序列化成一種已知的格式。每個soap體是一個xml文檔，它具有一個顯著的稱為<envelope>的根元素。標記名<envelope>由soap uri (urn:schemas-xmlsoap-org:soap.v1)來劃定范圍，所有soap專用的元素和屬性都是由這個uri來劃定范圍的。soap envelope包含一個可選的<header>元素，緊跟一個必須的<body>元素。<body>元素也有一個顯著的根元素，它或者是一個請求對象或者是一個響應對象。下面是一個ibank::withdraw請求的編碼： 
 
<soap:envelope xmlns:soap=''urn:schemas-xmlsoap-org:soap.v1''> 
<soap:body> 
  <ibank:withdraw xmlns:ibank=''urn:uuid:deadf00d-bead-bead-bead-baabaabaabaa''> 
   <account>3512</account> 
   <amount>100</amount> 
  </ibank:withdraw> 
</soap:body> 
</soap:envelope> 
下列響應消息被編碼為： 
<soap:envelope xmlns:soap=''urn:schemas-xmlsoap-org:soap.v1''> 
<soap:body> 
  <ibank:withdrawresponse xmlns:ibank=''urn:uuid:deadf00d-bead-bead-bead-baabaabaabaa''> 
   <newbalance>0</newbalance> 
   <amount>5</amount> 
   <overdrawn>true</overdrawn> 
  </ibank:withdrawresponse> 
</soap:body> 
</soap:envelope> 
注意[in, out]參數出現在兩個消息中。在檢查了請求和響應對象的格式后，你可能已經注意到序列化格式通常是： 
 
<t:typename xmlns:t=''namespaceuri''> 
<fieldname1>field1value</fieldname1> 
<fieldname2>field2value</fieldname2> 
  ...... 
</t:typename> 
在請求的情況下，類型是隱式的c風格的結構，它由對應方法中的[in]和[in, out]參數組成。對響應來說，類型也是隱式的c風格的結構，它由對應方法中的[out]和[in, out]參數組成。這種每個域對應一個子元素的風格有時被稱為元素正規格式(enf)。一般情況下，soap只用xml特性來傳達描述包含在元素內容中信息的注釋。 
 
象dcom和iiop一樣，soap支持協議頭擴展。soap用可選的<header>元素來傳載被協議擴展所使用的信息。如果客戶端的soap軟件包含要發送頭信息，原始的請求將可能如圖9所示。在這種情況下命名causality的頭將與請求一起序列化。收到請求后，服務器端軟件能查看頭的名域uri，并處理它識別出的頭擴展。這個頭擴展被http://comstuff.com uri識別，并期待一個如下的對象： 
 
struct causality { 
uuid id; 
}; 
在這種情況下的請求，如果頭元素的uri不能被識別，頭元素可以被安全地忽略。 
 
但你不能安全的忽略所有的soap體中的頭元素。如果一個特定的soap頭對正確處理消息是很關鍵的，這個頭元素能被用soap屬性mustunderstand=’true’標記為必須的。這個屬性告訴接收者頭元素必須被識別并被處理以確保正確的使用。為了強迫前面causality頭成為一個必須的頭，消息將被寫成如下形式： 
 
<soap:envelope xmlns:soap=''urn:schemas-xmlsoap-org:soap.v1''> 
<soap:header> 
  <causality soap:mustunderstand=''true''xmlns="http://comstuff.com"> 
   <id>362099cc-aa46-bae2-5110-99aac9823bff</id> 
  </causality> 
</soap:header> 
</soap:envelope> 
soap軟件遇到不能識別必須的頭元素情況時，必須拒絕這個消息并出示一個錯誤。如果服務器在一個soap請求中發現一個不能識別的必須的頭元素，它必須返回一個錯誤響應并且不發送任何調用到目標對象。如果客戶端在一個soap請求中發現一個不能識別出的必須的頭元素，它必須向調用者返回一個運行時錯誤。在com情況下，這將映射為一個明顯的hresult。 
 
 
第三節 soap數據類型 
 
在soap消息中，每個元素可能是一個soap結構元素、根元素、存取元素或一個獨立的元素。在soap中，soap:envelope、soap:body和soap:header是唯一的組成元素。它們的基本關系由下列xml schema所描述: 
 
<schema targetnamespace=''urn:schemas-xmlsoap-org:soap.v1''> 
<element name=''envelope''> 
<type> 
  <element name=''header'' type=''header'' minoccurs=''0'' /> 
  <element name=''body'' type=''body''minoccurs=''1'' /> 
</type> 
</element> 
</schema> 
在soap元素的四種類型中，除了結構元素外都被用作表達類型的實例或對一個類型實例的引用。 
 
根元素是顯著的元素，它是soap:body 或是 soap:header的直接的子元素。其中soap: body只有一個根元素，它表達調用、響應或錯誤對象。這個根元素必須是soap:body的第一個子元素，它的標記名和域名uri必須與http soapmethodname頭或在錯誤消息情況下的soap:fault相對應。而soap:header元素有多個根元素，與消息相聯系的每個頭擴展對應一個。這些根元素必須是soap:header的直接子元素，它們的標記名和名域uri表示當前存在擴展數據的類型。 
 
存取元素被用作表達類型的域、屬性或數據成員。一個給定類型的域在它的soap表達將只有一個存取元素。存取元素的標記名對應于類型的域名。考慮下列java 類定義： 
 
package com.bofsoap.ibank; 
public class adjustment { 
public int account ; 
public float amount ; 
} 
在一個soap消息中被序列化的實例如下所示： 
 
<t:adjustment xmlns:t=''urn:develop-com:java:com.bofsoap.ibank''> 
  <account>3514</account> 
  <amount>100.0</amount> 
</t:adjustment> 
在這個例子中，存取元素account和amount被稱著簡單存取元素。對引用簡單類型的存取元素，元素值被簡單地編碼為直接在存取元素下的字符數據，如上所示。對引用組合類型的存取元素（就是那些自身用子存取元素來構造的存取元素），有兩個技術來對存取元素進行編碼。最簡單的方法是把被結構化的值直接嵌入在存取元素下。考慮下面的java類定義： 
 
package com.bofsoap.ibank; 
public class transfer { 
public adjustment from; 
public adjustment to; 
} 
如果用嵌入值編碼存取元素，在soap中一個序列化的transfer對象如下所示： 
 
<t:transfer xmlns:t=''urn:develop-com:java:com.bofsoap.ibank''> 
<from> 
  <account>3514</account> 
  <amount>-100.0</amount> 
</from> 
<to> 
  <account>3518</account> 
  <amount>100.0</amount> 
</to> 
</t:transfer> 
在這種情況下，adjustment對象的值被直接編碼在它們的存取元素下。在考慮組合存取元素時，需要說明幾個問題。先考慮上面的transfer類。類的from和to的域是對象引用，它可能為空。soap用xml schemas的null屬性來表示空值或引用。下面例子表示一個序列化的transfer對象，它的from域是空的： 
 
<t:transfer xmlns:t=''urn:develop-com:java:com.bofsoap.ibank'' 
xmlns:xsd=''http://www.w3.org/1999/xmlschema/instance''> 
<from xsd:null=''true'' /> 
<to> 
  <account>3518</account> 
  <amount>100.0</amount> 
</to> 
</t:transfer> 
在不存在的情況下， xsd:null屬性的隱含值是false。給定元素的能否為空的屬性是由xml schema定義來控制的。例如下列xml schema將只允許from存取元素為空： 
 
<type name=''transfer'' > 
<element name=''from'' type=''adjustment'' nullable=''true'' /> 
<element name=''to'' type=''adjustment'' nullable=''false''/> 
</type> 
在一個元素的schema聲明中如果沒有nullable屬性，就意味著在一個xml文檔中的元素是不能為空的。null存取元素的精確格式當前還在修訂中要了解用更多信息參考最新版本的soap規范。 
 
與存取元素相關的另一個問題是由于類型關系引起的可代換性。由于前面的adjustment類不是一個final類型的類，transfer對象的from和to域實際引用繼承類型的實例是可能的。為了支持這種類型兼容的替換，soap使用一個名域限定的類型屬性的xml schema約定。這種類型屬性的值是一個對元素具體的類型的限制的名字。考慮下面的adjustment擴展類： 
 
package com.bofsoap.ibank; 
public class auditedadjustment extends adjustment { 
public int auditlevel; 
} 
給出下面java語言： 
 
transfer xfer = new transfer(); 
xfer.from = new auditedadjustment(); 
xfer.from.account = 3514; 
xfer.from.amount = -100; 
xfer.from.auditlevel = 3; 
xfer.to = new adjustment(); 
xfer.to.account = 3518; 
xfer.from.amount = 100; 
 
在soap中transfer對象的序列化形式如下所示： 
 
<t:transfer xmlns:xsd=''http://www.w3.org/1999/xmlschema'' 
xmlns:t=''urn:develop-com:java:com.bofsoap.ibank''> 
  <from xsd:type=''t:auditedadjustment'' > 
   <account>3514</account> 
   <amount>-100.0</amount> 
   <auditlevel>3</auditlevel > 
  </from> 
  <to> 
   <account>3518</account> 
   <amount>100.0</amount> 
  </to> 
</t:transfer> 
 
在這里xsd:type屬性引用一個名域限定的類型名，它能被反序列化程序用于實例化對象的正確類型。因為to存取元素引用到一個被預料的類型的實例（而不是一個可代替的繼承類型），xsd:type屬性是不需要的。 
 
剛才的transfer類設法回避了一個關鍵問題。如果正被序列化的transfer對象用下面這種方式初始化將會發生什么情況： 
 
transfer xfer = new transfer(); 
xfer.from = new adjustment(); 
xfer.from.account = 3514; xfer.from.amount = -100; 
xfer.to = xfer.from; 
基于以前的議論，在soap 中transfer對象的序列化形式如下所示： 
 
<t:transfer xmlns:t=''urn:develop-com:java:com.bofsoap.ibank''> 
<from> 
  <account>3514</account> 
  <amount>-100.0</amount> 
</from> 
<to> 
  <account>3514</account> 
  <amount>-100.0</amount> 
</to> 
</t:transfer> 
這個表達有兩個問題。首先最容易理解的問題是同樣的信息被發送了兩次,這導致了一個比實際所需要消息的更大的消息。一個更微妙的但是更重要的問題是由于反序列化程序不能分辨兩個帶有同樣值的adjustment對象與在兩個地方被引用的一個單一的adjustment對象的區別，兩個存取元素間的身份關系就被丟失。如果這個消息接收者已經在結果對象上執行了下面的測試，(xfer.to == xfer.from)將不會返回true。 
 
void processtransfer(transfer xfer) { 
if (xfer.to == xfer.from) 
handledoubleadjustment(xfer.to); 
else 
handleadjustments(xfer.to, xfer.from); 
} 
為了支持必須保持身份關系的類型的序列化，soap支持多引用存取元素。目前我們接觸到的存取元素是單引用存取元素，也就是說，元素值是嵌入在存取元素下面的，而且其它存取元素被允許引用那個值（這很類似于在ndr中的[unique]的概念）。多引用存取元素總是被編碼為只包含已知的soap:href屬性的空元素。soap:href屬性總是包含一個代碼片段標識符，它對應于存取元素引用到的實例。如果to和from存取元素已經被編碼為多引用存取元素，序列化的transfer對象如下所示： 
 
<t:transfer  xmlns:t=''urn:develop-com:java:com.bofsoap.ibank''>       
<from soap:href=''#id1'' />        
<to soap:href=''#id1'' />        
</t:transfer> 
這個編碼假設與adjustment類兼容的一個類型的實例已經在envelope中的其它地方被序列化，而且這個實例已經被用soap:id屬性標記，如下所示： 
 
<t:adjustment soap:id=''id1''xmlns:t=''urn:develop-com:java:com.bofsoap.ibank''> 
  <account>3514</account> 
  <amount>-100.0</amount> 
</t:adjustment> 
 
 
第四節結語 
 
一個遺留的http問題還需要進一步闡明。soap支持(但不需要)http擴展框架約定來指定必須的http頭擴展。這些約定主要有兩個目的。首先，它們允許任意的uri被用于限定給定的http頭的范圍(類似xml名域)。第二,這些約定允許把必須的頭與可選的頭區分開來(象soap:mustunderstand)。下面是一個使用http擴展框架來把soapmethodname頭定義成為一個必須的頭擴展： 
 
m-post /foobar http/1.1 
host: 209.110.197.2 
man: "urn:schemas-xmlsoap-org:soap.v1; ns=42" 
42-soapmethodname: urn:bobnsid:ifoo#doit 
man頭映射soap uri到前綴為42的頭，并表示沒有認出soap的服務器必須返回一個http錯誤，狀態代碼為501 (沒有被實現) 或 510 (沒有被擴展)。http方法必須是m-post，表明目前是必須的頭擴展。soap是一個被類型化的序列化格式，它恰巧用http 作為請求/響應消息傳輸協議。soap被設計為與正將出現的xml schema規范密切配合，并支持在internet的任何地方運行的com、corba、perl、tcl、和java、c、python或 php等程序間的互操作性。

上一篇：股票報價的WebService（轉天極網）之四

下一篇：WSDL文件詳解（轉貼）下