WCF Tips之三
WCF支持對Stream對象的操作，尤其對于傳遞size過(guò)大的消息而言，如要考慮傳遞消息的效率，WCF推薦通過(guò)Stream進(jìn)行操作。
然而，WCF對于Stream操作規定了一些限制，在我們編寫(xiě)相關(guān)程序時(shí)，需要特別注意：
1、綁定的限制
如果需要使用Stream操作，可以使用的綁定只能是BasicHttpBinding，NetTcpBinding以及NetNamedPipeBinding。此外，在使用Stream操作時(shí)，不能使用Reliable Messaging。如果考慮到消息安全，則此方式是不可取的。
2、對Stream對象的限制
要作為服務(wù)操作所傳遞的消息對象，這樣的對象必須是可序列化的。遺憾的是，FileStream類(lèi)的定義卻是不支持序列化的，我們能夠使用的Stream對象，包括Stream，MemoryStream等。使用Stream類(lèi)對象是大多數Stream操作的首選。
一個(gè)有趣的現象是FileStream與Stream類(lèi)型的轉換。例如在服務(wù)契約的操作中，有如下的實(shí)現：
public Stream TransferDocument(Document document)
{
FileStream stream = new FileStream
(document.LocalPath, FileMode.Open, FileAccess.Read);
return stream;
}
注意，操作TransferDocument()的返回類(lèi)型為Stream，而方法的實(shí)現中，返回的對象則為FileStream類(lèi)型。由于Stream類(lèi)是FileStream類(lèi)的父類(lèi)，這樣的實(shí)現沒(méi)有問(wèn)題。
然而，在客戶(hù)端調用該操作時(shí)，卻不能將操作的返回值賦給FileStream類(lèi)型的對象，如下所示：
FileStream stream = m_service.TransferDocument(doc);
此時(shí)獲得的Stream對象則為null。因而，我們只能這樣調用操作：
Stream stream = m_service.TransferDocument(doc);
但是，還有一個(gè)奇怪的問(wèn)題是WCF并不支持Stream對象Length屬性的序列化，也就是說(shuō)，在客戶(hù)端我們不能使用服務(wù)操作返回的Stream對象的Length屬性。諸如stream.Length的調用會(huì )拋出NotSupportedException異常。
3、TransferMode的限制
若要使用Stream操作，必須修改綁定的TransferMode屬性。該屬性的默認值為Buffered。我們應該根據操作中Stream對象的參數類(lèi)型，以決定TransferMode的值分別為Streamed、StreamedRequest或者StreamedResponse。
4、MaxReceivedMessageSize的限制
MaxReceivedMessageSize屬性的默認值為64kb，如果傳遞的Stream對象一旦超過(guò)了MaxReceivedMessageSize屬性的設置值，則客戶(hù)端在操作該對象時(shí)，就會(huì )出現CommunicationException異常。因此，我們應根據實(shí)際需要設置MaxReceivedMessageSize的值。MaxReceivedMessageSize屬性的取值范圍為1-9223372036854775807（Int32.MaxValue）。如果設置值不在該范圍之內，則無(wú)法通過(guò)編譯。編程方式設置為：
binding.MaxReceivedMessageSize = 120000;
配置文件的設置方式為：
<binding …… maxReceivedMessageSize="120000"/>
5、操作參數的限制
WCF對包含了Stream對象的操作參數進(jìn)行嚴格的限制，它只允許這樣的操作只能包含一個(gè)Stream對象，這里所謂的一個(gè)Stream對象，是包含return對象，out和ref對象在內的。也就是說(shuō)如下的操作定義都是錯誤的：
void Transfer(Stream s1, Stream s2);
void Transfer(Stream s1, out Stream s2);
void Transfer(Stream s1, ref Stream s2);
Stream Transfer(Stream stream);
如果定義了這樣的操作，則會(huì )出現運行時(shí)錯誤。
6、實(shí)例激活類(lèi)型的限制
由于Stream操作受到綁定的限制，只能使用BasicHttpBinding，NetTcpBinding以及NetNamedPipeBinding綁定，因此必然會(huì )影響服務(wù)實(shí)例的激活類(lèi)型，最主要的是對Session模式的影響。首先BasicHttpBinding并不支持Session模式的激活類(lèi)型。NetTcpBinding以及NetNamedPipeBinding綁定雖然支持Session模式，但是由于Stream操作不支持可靠消息傳遞，即不能將ReliableSession設置為true。因此在定義服務(wù)契約的SessionMode時(shí)，不能將其值設置為SessionMode.Required，否則會(huì )拋出異常。
實(shí)際上，Stream操作（指TransferMode不為Buffered）本身并不支持Session模式。即使我們在使用NetTcpBinding時(shí)，將服務(wù)契約的SessionMode設置為Allowed，并將服務(wù)的InstanceContextMode設置為PerSession，服務(wù)的執行方式仍然是PerCall方式。（如果不是Stream操作，這樣的設置服務(wù)應為PerSession模式）
因此，在執行Stream操作時(shí)，即使按照Session模式對服務(wù)進(jìn)行設置，如果我們通過(guò)OperationContext.Current.SessionId去獲得會(huì )話(huà)ID，其值應該為空。
此外，由于傳輸的Stream對象較大，可能會(huì )消耗過(guò)長(cháng)的時(shí)間，因而建議增大綁定的SendTimeout屬性值。例如設置為10分鐘。編程方式設置為：
binding.SendTimeout = TimeSpan.FromMinutes(10);
配置文件的設置方式為：
<binding …… sendTimeout="00:10:00"/>
注意，對綁定的相關(guān)設置必須要求服務(wù)端與客戶(hù)端的配置一致。最佳實(shí)踐是均通過(guò)配置文件進(jìn)行設置。例如在我的應用程序中是這樣設置的：
<basicHttpBinding>
<binding name="DocumentExplorerServiceBinding"
sendTimeout="00:10:00"
transferMode="Streamed"
messageEncoding="Text"
textEncoding="utf-8"
maxReceivedMessageSize="9223372036854775807">
</binding>
</basicHttpBinding>
