WCF操作Stream傳遞size過大消息
WCF做一款功能強大的分布式開發(fā)框架,支持的應用還歐式比較廣泛的。比如WCF操作Stream就是其中一種。特別是對于傳遞size過大的消息時,更需要這種支持操作。#t#
然而,WCF對于Stream操作規(guī)定了一些限制,在我們編寫相關(guān)程序時,需要特別注意:
WCF操作Stream1、綁定的限制
如果需要使用Stream操作,可以使用的綁定只能是BasicHttpBinding,NetTcpBinding以及NetNamedPipeBinding。此外,在使用Stream操作時,不能使用Reliable Messaging。如果考慮到消息安全,則此方式是不可取的。
WCF操作Stream2、對Stream對象的限制
要作為服務操作所傳遞的消息對象,這樣的對象必須是可序列化的。遺憾的是,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異常。
WCF操作Stream3、TransferMode的限制
若要使用Stream操作,必須修改綁定的TransferMode屬性。該屬性的默認值為Buffered。我們應該根據(jù)操作中Stream對象的參數(shù)類型,以決定TransferMode的值分別為Streamed、StreamedRequest或者StreamedResponse。
WCF操作Stream4、MaxReceivedMessageSize的限制
MaxReceivedMessageSize屬性的默認值為64kb,如果傳遞的Stream對象一旦超過了MaxReceivedMessageSize屬性的設(shè)置值,則客戶端在操作該對象時,就會出現(xiàn)CommunicationException異常。因此,我們應根據(jù)實際需要設(shè)置MaxReceivedMessageSize的值。MaxReceivedMessageSize屬性的取值范圍為1-9223372036854775807(Int32.MaxValue)。如果設(shè)置值不在該范圍之內(nèi),則無法通過編譯。編程方式設(shè)置為:
binding.MaxReceivedMessageSize = 120000;
配置文件的設(shè)置方式為:
< binding …… maxReceivedMessageSize="120000"/>
WCF操作Stream5、操作參數(shù)的限制
WCF對包含了Stream對象的操作參數(shù)進行嚴格的限制,它只允許這樣的操作只能包含一個Stream對象,這里所謂的一個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)運行時錯誤。
WCF操作Stream6、實例激活類型的限制
由于Stream操作受到綁定的限制,只能使用BasicHttpBinding,NetTcpBinding以及NetNamedPipeBinding綁定,因此必然會影響服務實例的激活類型,最主要的是對Session模式的影響。首先BasicHttpBinding并不支持Session模式的激活類型。NetTcpBinding以及NetNamedPipeBinding綁定雖然支持Session模式,但是由于Stream操作不支持可靠消息傳遞,即不能將ReliableSession設(shè)置為true。因此在定義服務契約的SessionMode時,不能將其值設(shè)置為SessionMode.Required,否則會拋出異常。
實際上,Stream操作(指TransferMode不為Buffered)本身并不支持Session模式。即使我們在使用NetTcpBinding時,將服務契約的SessionMode設(shè)置為Allowed,并將服務的InstanceContextMode設(shè)置為PerSession,服務的執(zhí)行方式仍然是PerCall方式。(如果不是Stream操作,這樣的設(shè)置服務應為PerSession模式)
因此,在執(zhí)行Stream操作時,即使按照Session模式對服務進行設(shè)置,如果我們通過OperationContext.Current.SessionId去獲得會話ID,其值應該為空。
此外,由于傳輸?shù)腟tream對象較大,可能會消耗過長的時間,因而建議增大綁定的SendTimeout屬性值。例如設(shè)置為10分鐘。編程方式設(shè)置為:
binding.SendTimeout = TimeSpan.FromMinutes(10);
配置文件的設(shè)置方式為:
< binding …… sendTimeout="00:10:00"/>
注意,對綁定的相關(guān)設(shè)置必須要求服務端與客戶端的配置一致。最佳實踐是均通過配置文件進行設(shè)置。例如在我的應用程序中是這樣設(shè)置的:
- < basicHttpBinding>
- < binding name="Documen
tExplorerServiceBinding"- sendTimeout="00:10:00"
- transferMode="Streamed"
- messageEncoding="Text"
- textEncoding="utf-8"
- maxReceivedMessageSize=
"9223372036854775807">- < /binding>
- < /basicHttpBinding>