談談WCF Stream對象限制操作
WCF還是比較常用的,于是我研究了一下WCF支持Stream對象的支持限制,在這里拿出來和大家分享一下,希望對大家有用。WCF支持Stream操作,尤其對于傳遞size過大的消息而言,如要考慮傳遞消息的效率,WCF推薦通過Stream進行操作。然而,WCF Stream操作規(guī)定了一些限制,在我們編寫相關(guān)程序時,需要特別注意:
1、綁定的限制
如果需要使用Stream操作,可以使用的綁定只能是BasicHttpBinding,NetTcpBinding以及NetNamedPipeBinding。此外,在使用Stream操作時,不能使用Reliable Messaging。如果考慮到消息安全,則此方式是不可取的。
2、對Stream對象的限制
#T#要作為服務操作所傳遞的消息對象,這樣的對象必須是可序列化的。遺憾的是,F(xiàn)ileStream類的定義卻是不支持序列化的,我們能夠使用的Stream 對象,包括Stream,MemoryStream等。使用Stream類對象是大多數(shù)Stream操作的***。一個有趣的現(xiàn)象是FileStream與Stream類型的轉(zhuǎn)換。例如在服務契約的操作中,有如下的實現(xiàn):
- public Stream TransferDocument(Document document) { FileStream stream = new FileStream (document.LocalPath, FileMode.Open, FileAccess.Read); return stream; }
注意,操作TransferDocument()的返回類型為Stream,而方法的實現(xiàn)中,返回的對象則為FileStream類型。由于Stream類是FileStream類的父類,這樣的實現(xiàn)沒有問題。
然而,在客戶端調(diào)用該操作時,卻不能將操作的返回值賦給FileStream類型的對象,如下所示:
- FileStream stream = m_service.TransferDocument(doc);
此時獲得的Stream對象則為null。因而,我們只能這樣調(diào)用操作:
- Stream stream = m_service.TransferDocument(doc);
但是,還有一個奇怪的問題是WCF并不支持Stream對象Length屬性的序列化,也就是說,在客戶端我們不能使用服務操作返回的Stream對象的 Length屬性。諸如stream.Length的調(diào)用會拋出NotSupportedException異常。
3、TransferMode的限制
若要使用Stream操作,必須修改綁定的TransferMode屬性。該屬性的默認值為Buffered。我們應該根據(jù)操作中WCF Stream對象的參數(shù)類型,以決定TransferMode的值分別為Streamed、StreamedRequest或者StreamedResponse。
4、MaxReceivedMessageSize的限制
MaxReceivedMessageSize屬性的默認值為64kb,如果傳遞的Stream對象一旦超過了 MaxReceivedMessageSize屬性的設(shè)置值,則客戶端在操作該對象時,就會出現(xiàn)CommunicationException異常。因此,我們應根據(jù)實際需要設(shè)置MaxReceivedMessageSize的值。MaxReceivedMessageSize屬性的取值范圍為 1-9223372036854775807(Int32.MaxValue)。如果設(shè)置值不在該范圍之內(nèi),則無法通過編譯。編程方式設(shè)置為:
- <binding …… maxReceivedMessageSize="120000"/>
5、操作參數(shù)的限制
WCF Stream操作參數(shù)嚴格的限制,它只允許這樣的操作只能包含一個Stream對象,這里所謂的一個WCF Stream對象,是包含return對象,out和ref對象在內(nèi)的。也就是說如下的操作定義都是錯誤的:
- void Transfer(Stream s1, Stream s2); void Transfer(Stream s1, out Stream s2); void Transfer(Stream s1, ref Stream s2); Stream Transfer(Stream stream);
如果定義了這樣的操作,則會出現(xiàn)運行時錯誤。
此外,由于傳輸?shù)腤CF Stream對象較大,可能會消耗過長的時間,因而建議增大綁定的SendTimeout屬性值。例如設(shè)置為10分鐘。編程方式設(shè)置為:
- binding.SendTimeout = TimeSpan.FromMinutes(10);
配置文件的設(shè)置方式為:
- <binding …… sendTimeout="00:10:00"/>
注意,對綁定的相關(guān)設(shè)置必須要求服務端與客戶端的配置一致。***實踐是均通過配置文件進行設(shè)置。例如在我的應用程序中是這樣設(shè)置的:
- <basicHttpBinding> <binding name="DocumentExplorerServiceBinding" sendTimeout="00:10:00"
transferMode="Streamed" messageEncoding="Text" textEncoding="utf-8" maxReceivedMessageSize="9223372036854775807">
</binding> </basicHttpBinding>