WCF异步调用技巧掌握

WCF是一款功能强大的开发框架,可以帮助我们实现跨平台的互联网解决方案。在这里我们可以学习到有关WCF异步调用的一些实现方法。#t#

WCF与Web Service不同的是,当我们定义了服务契约的操作时,不管是通过ChannelFactory创建服务代理对象,还是通过SvcUtil的默认方式生 成服务代理对象,客户端在调用这些代理对象时,都无法直接实现WCF异步调用。例如,对于如下的服务操作定义:

  1. [OperationContract]
  2. Stream TransferDocument(Document document);

在调用代理对象的方法时,我们无法找到对应于TransferDocument()操作的BeginTransferDocument()和EndTransferDocument()异步方法。

这 样的设计使得我们无法通过编程方式WCF异步调用服务的操作,除非我们在定义服务接口时,直接加入相关操作的异步方法。然而,这又直接导致了服务的设计与方法 调用方式之间的耦合

。一个好的框架设计要素在于,不管客户端的调用方式(同步或者异步),服务的设计与实现应该是一致的。对于服务的设计者而言,在设计之 初,就不应该去考虑服务的调用者调用的方式。换言之,服务操作究竟是否采用异步方式,应该由客户端的调用者决定。因此,所有与WCF异步调用相关的内容应该只与 客户端相关。WCF遵循了这一规则。

在我编写的应用程序中,会暴露一个传送文档文件的服务操作。我并不知道也并不关心调用该操作的客户端是否采用异步方式。因此,如上所述的服务操作定义是完全正确的。

那 么,客户端究竟应该如何执行异步调用呢?如果采用编程方式获得服务代理对象,这一问题会变得比较糟糕。因为我将服务契约的定义单独形成了一个程序集,并在 客户端直接引用了它。然而,在这样的服务契约程序集中,是没有包含异步方法的定义的。因此,我需要修改在客户端的服务定义,增加操作的异步方法。这无疑为 服务契约的重用带来障碍。至少,我们需要在客户端维持一份具有异步方法的服务契约。

所幸,在客户端决定采用WCF异步调用我所设计的服务操作时,虽然需要修改客户端的服务契约接口,但并不会影响服务端的契约定义。因此,服务端的契约定义可以保持不变,而在客户端则修改接口定义如下:

 
 
 
  1. [ServiceContract]
  2. public interface IDocumentsExplorerService
  3. {
  4. [OperationContract]
  5. Stream TransferDocument(Document document);
  6. [OperationContract(AsyncPattern = true)]
  7. IAsyncResult BeginTransferDocument(Document document,
  8. AsyncCallback callback, object asyncState);
  9. Stream EndTransferDocument(IAsyncResult result);

注意,在BeginTransferDocument()方法上,必须在OperationContractAttribute中将AsyncPattern属性值设置为true,因为它的默认值为false。

调用方式如下:

 
 
 
  1. BasicHttpBinding binding = 
    new BasicHttpBinding();
  2. binding.SendTimeout =
     TimeSpan.FromMinutes(10);
  3. binding.TransferMode =
     TransferMode.Streamed;
  4. binding.MaxReceivedMessageSize = 
    9223372036854775807;
  5. EndpointAddress address = 
    new EndpointAddress
  6. ("http://localhost:8008/Document
    ExplorerService");
  7. ChannelFactoryExplorerService> factory = 
  8. new ChannelFactoryExplorerService>(binding,address);
  9. m_service = factory.CreateChannel();
  10. ……
  11. IAsyncResult result = m_service.
    BeginTransferDocument(doc,null,null);
  12. result.AsyncWaitHandle.WaitOne();
  13. Stream stream = m_service.
    EndTransferDocument(result);

如果采用SvcUtil生成客户端代理文件,可以有更好的方式实现异步,也就是使用SvcUtil的/async开关,例如:
svcutil /async http://localhost:8008/DocumentExplorerService
唯一不足的是,它会不分青红皂白,为所有服务操作都生成对应的异步方法。这样的做法未免过于武断。

合理地利用服务的WCF异步调用,可以有效地提高系统性能,合理分配任务的执行。特别对于UI应用程序而言,可以提高UI的响应速度,改善用户体验。在我编写的应用程序中,下载的文件如果很大,就有必要采用异步方式。

对于异步调用的完成,虽然WCF提供了诸如阻塞、等待和轮询等机制,但***的方式还是使用回调。也就是利用Begin方法参数中的AsyncCallback对象。这是一个委托对象,它的定义如下所示:
public delegate void AsyncCallback(IAsyncResult ar);
利用异步方式执行服务操作,使得服务在执行过程中不会阻塞主线程,当方法执行完成后,通过AsyncCallback回调对应的方法,可以通知客户端服务执行完毕。例如:

 
 
 
  1. //Invoke it Asynchronously
  2. m_service.BeginTransferDocument
    (m_doc,OnTransferCompleted,null);
  3. //Do some work;
  4. //callback method
  5. void OnTransferCompleted
    (IAsyncResult result)
  6. {
  7. Stream stream = m_service.
    EndTransferDocument(result);
  8. result.AsyncWaitHandle.Close();
  9. lbMessage.Text = string.Format
    ("The file {0} had been 
    transfered sucessfully.", 
  10. m_doc.FileName);
  11. }

在调用BeginTransferDocument()方法之后,主线程不会被阻塞,仍然可以继续执行其它工作。而当服务方法执行完毕之后,会自动调用回调方法,执行方法中的内容。

上 述实现存在一个问题,就是对于lbMessage控件的操作。由于回调方法并非运行在主线程中,如果回调方法需要更新与WCF异步调用结果相关的界面,例如本例 中的lbMessage控件,则需要将回调的调用封送(Marshal)到当前主程序界面的同步上下文中。我们可以使用 SynchronizationContext以及它的SendOrPostCallback委托,对调用进行封送:

 
 
 
  1. public ExplorerClientForm()
  2. {
  3. InitializeComponent();
  4. m_synchronizationContext = 
    SynchronizationContext.Current;
  5. }
  6. private SynchronizationContext
     m_synchronizationContext;

则回调方法修改为:

 
 
 
  1. //callback method
  2. void OnTransferCompleted
    (IAsyncResult result)
  3. {
  4. Stream stream = m_service.
    EndTransferDocument(result);
  5. result.AsyncWaitHandle.Close();
  6. SendOrPostCallback callback = delegate
  7. {
  8. lbMessage.Text = string.Format
    ("The file {0} had been transfered 
    sucessfully.", 
  9. m_doc.FileName);
  10. };
  11. m_synchronizationContext.
    Send(callback,null);
  12. }

在WCF异步调用方法时,由于对BeginTransferDocument()和EndTransferDocument()方法的调用可能会在不同的方法体中,因而我将服务代理对象定义为private字段。如果希望将服务对象定义为一个局部变量,可以在调用BeginTransferDocument()方法时,将代理对象传递到方法的asyncState参数中,然后在调用EndTransferDocument()方法之前,通过IAsyncResult获得准确的服务代理对象:
m_service.BeginTransferDocument(m_doc,OnTransferCompleted,m_service);
将m_service作为asyncState对象传入之后,在调用EndTransferDocument()方法之前,就可以根据它先获得服务代理对象

 
 
 
  1. IDocumentsExplorerService m_service = 
    result.AsyncState as IDocuments
    ExplorerService;
  2. Stream stream = m_service.
    EndTransferDocument(result);
  3. //rest codes

以上就是WCF异步调用的相关实现方法。

分享题目:WCF异步调用技巧掌握
转载来源:http://www.hantingmc.com/qtweb/news7/380407.html

网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

广告

声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联