WCF異步調(diào)用技巧掌握
WCF是一款功能強大的開發(fā)框架，可以幫助我們實現(xiàn)跨平臺的互聯(lián)網(wǎng)解決方案。在這里我們可以學習到有關WCF異步調(diào)用的一些實現(xiàn)方法。#t#
WCF與Web Service不同的是，當我們定義了服務契約的操作時，不管是通過ChannelFactory創(chuàng)建服務代理對象，還是通過SvcUtil的默認方式生 成服務代理對象，客戶端在調(diào)用這些代理對象時，都無法直接實現(xiàn)WCF異步調(diào)用。例如，對于如下的服務操作定義：
- [OperationContract]
- Stream TransferDocument(Document document);
在調(diào)用代理對象的方法時，我們無法找到對應于TransferDocument()操作的BeginTransferDocument()和EndTransferDocument()異步方法。
這 樣的設計使得我們無法通過編程方式WCF異步調(diào)用服務的操作，除非我們在定義服務接口時，直接加入相關操作的異步方法。然而，這又直接導致了服務的設計與方法 調(diào)用方式之間的耦合
。一個好的框架設計要素在于，不管客戶端的調(diào)用方式（同步或者異步），服務的設計與實現(xiàn)應該是一致的。對于服務的設計者而言，在設計之 初，就不應該去考慮服務的調(diào)用者調(diào)用的方式。換言之，服務操作究竟是否采用異步方式，應該由客戶端的調(diào)用者決定。因此，所有與WCF異步調(diào)用相關的內(nèi)容應該只與 客戶端相關。WCF遵循了這一規(guī)則。
在我編寫的應用程序中，會暴露一個傳送文檔文件的服務操作。我并不知道也并不關心調(diào)用該操作的客戶端是否采用異步方式。因此，如上所述的服務操作定義是完全正確的。
那 么，客戶端究竟應該如何執(zhí)行異步調(diào)用呢？如果采用編程方式獲得服務代理對象，這一問題會變得比較糟糕。因為我將服務契約的定義單獨形成了一個程序集，并在 客戶端直接引用了它。然而，在這樣的服務契約程序集中，是沒有包含異步方法的定義的。因此，我需要修改在客戶端的服務定義，增加操作的異步方法。這無疑為 服務契約的重用帶來障礙。至少，我們需要在客戶端維持一份具有異步方法的服務契約。
所幸，在客戶端決定采用WCF異步調(diào)用我所設計的服務操作時，雖然需要修改客戶端的服務契約接口，但并不會影響服務端的契約定義。因此，服務端的契約定義可以保持不變，而在客戶端則修改接口定義如下：
- [ServiceContract]
- public interface IDocumentsExplorerService
- {
- [OperationContract]
- Stream TransferDocument(Document document);
- [OperationContract(AsyncPattern = true)]
- IAsyncResult BeginTransferDocument(Document document,
- AsyncCallback callback, object asyncState);
- Stream EndTransferDocument(IAsyncResult result);
- }
注意，在BeginTransferDocument()方法上，必須在OperationContractAttribute中將AsyncPattern屬性值設置為true，因為它的默認值為false。
調(diào)用方式如下：
- BasicHttpBinding binding =
new BasicHttpBinding();- binding.SendTimeout =
TimeSpan.FromMinutes(10);- binding.TransferMode =
TransferMode.Streamed;- binding.MaxReceivedMessageSize =
9223372036854775807;- EndpointAddress address =
new EndpointAddress- ("http://localhost:8008/Document
ExplorerService");- ChannelFactory<IDocuments
ExplorerService> factory =- new ChannelFactory<IDocuments
ExplorerService>(binding,address);- m_service = factory.CreateChannel();
- ……
- IAsyncResult result = m_service.
BeginTransferDocument(doc,null,null);- result.AsyncWaitHandle.WaitOne();
- Stream stream = m_service.
EndTransferDocument(result);
如果采用SvcUtil生成客戶端代理文件，可以有更好的方式實現(xiàn)異步，也就是使用SvcUtil的/async開關，例如：
svcutil /async http://localhost:8008/DocumentExplorerService
唯一不足的是，它會不分青紅皂白，為所有服務操作都生成對應的異步方法。這樣的做法未免過于武斷。
合理地利用服務的WCF異步調(diào)用，可以有效地提高系統(tǒng)性能，合理分配任務的執(zhí)行。特別對于UI應用程序而言，可以提高UI的響應速度，改善用戶體驗。在我編寫的應用程序中，下載的文件如果很大，就有必要采用異步方式。
對于異步調(diào)用的完成，雖然WCF提供了諸如阻塞、等待和輪詢等機制，但***的方式還是使用回調(diào)。也就是利用Begin方法參數(shù)中的AsyncCallback對象。這是一個委托對象，它的定義如下所示：
public delegate void AsyncCallback(IAsyncResult ar);
利用異步方式執(zhí)行服務操作，使得服務在執(zhí)行過程中不會阻塞主線程，當方法執(zhí)行完成后，通過AsyncCallback回調(diào)對應的方法，可以通知客戶端服務執(zhí)行完畢。例如：
- //Invoke it Asynchronously
- m_service.BeginTransferDocument
(m_doc,OnTransferCompleted,null);- //Do some work;
- //callback method
- void OnTransferCompleted
(IAsyncResult result)- {
- Stream stream = m_service.
EndTransferDocument(result);- result.AsyncWaitHandle.Close();
- lbMessage.Text = string.Format
("The file {0} had been
transfered sucessfully.",- m_doc.FileName);
- }
在調(diào)用BeginTransferDocument()方法之后，主線程不會被阻塞，仍然可以繼續(xù)執(zhí)行其它工作。而當服務方法執(zhí)行完畢之后，會自動調(diào)用回調(diào)方法，執(zhí)行方法中的內(nèi)容。
上 述實現(xiàn)存在一個問題，就是對于lbMessage控件的操作。由于回調(diào)方法并非運行在主線程中，如果回調(diào)方法需要更新與WCF異步調(diào)用結果相關的界面，例如本例 中的lbMessage控件，則需要將回調(diào)的調(diào)用封送(Marshal)到當前主程序界面的同步上下文中。我們可以使用 SynchronizationContext以及它的SendOrPostCallback委托，對調(diào)用進行封送：
- public ExplorerClientForm()
- {
- InitializeComponent();
- m_synchronizationContext =
SynchronizationContext.Current;- }
- private SynchronizationContext
m_synchronizationContext;
則回調(diào)方法修改為：
- //callback method
- void OnTransferCompleted
(IAsyncResult result)- {
- Stream stream = m_service.
EndTransferDocument(result);- result.AsyncWaitHandle.Close();
- SendOrPostCallback callback = delegate
- {
- lbMessage.Text = string.Format
("The file {0} had been transfered
sucessfully.",- m_doc.FileName);
- };
- m_synchronizationContext.
Send(callback,null);- }
在WCF異步調(diào)用方法時，由于對BeginTransferDocument()和EndTransferDocument()方法的調(diào)用可能會在不同的方法體中，因而我將服務代理對象定義為private字段。如果希望將服務對象定義為一個局部變量，可以在調(diào)用BeginTransferDocument()方法時，將代理對象傳遞到方法的asyncState參數(shù)中，然后在調(diào)用EndTransferDocument()方法之前，通過IAsyncResult獲得準確的服務代理對象：
m_service.BeginTransferDocument(m_doc,OnTransferCompleted,m_service);
將m_service作為asyncState對象傳入之后，在調(diào)用EndTransferDocument()方法之前，就可以根據(jù)它先獲得服務代理對象
- IDocumentsExplorerService m_service =
result.AsyncState as IDocuments
ExplorerService;- Stream stream = m_service.
EndTransferDocument(result);- //rest codes
以上就是WCF異步調(diào)用的相關實現(xiàn)方法。
