WCF 学习总结4 -- 用Duplex实现消息广播

最新推荐文章于 2019-07-17 16:20:26 发布

Boris508

最新推荐文章于 2019-07-17 16:20:26 发布

阅读量576

点赞数

分类专栏： WCF 文章标签： wcf http协议通信

WCF 专栏收录该内容

21 篇文章 0 订阅

订阅专栏

WCF中定义3种消息交换模式： 1. Request/Reply; 2. One-Way; 3. Duplex。
Request/Reply 是缺省模式，即同步调用。在调用服务方法后需要等待服务的消息返回，即便该方法返回 void 类型。
One-Way 这种方式在调用方法后会立即返回。需要注意的是 One-Way 不能用在非void，或者包含 out/ref 参数的方法上，会导致抛出 InvalidOperationException 异常。
Duplex 又称为双工通信，实现起来比前两种来说要稍微复杂些。(1) ServiceContract 中指定 Callback类型； (2) 对于回调操作，指定[OperationContract(IsOneWay=true)] ； (3) 服务契约中通过 OperationContext.Current.GetCallbackChannel 来获得客户端 Callback 实例。

另外，在WCF预定义绑定类型中，WSDualHttpBinding和NetTcpBinding均提供了对双工通信的支持，但是两者在对双工通信的实现机制上却有本质的区别。WSDualHttpBinding是基于HTTP传输协议的；而HTTP协议本身是基于请求-回复的传输协议，基于HTTP的通道本质上都是单向的。WSDualHttpBinding实际上创建了两个通道，一个用于客户端向服务端的通信，而另一个则用于服务端到客户端的通信，从而间接地提供了双工通信的实现。而NetTcpBinding完全基于支持双工通信的TCP协议。

接下来，介绍如何用WCF的Duplex消息交换实现服务端对客户端的广播。

1. 定义服务契约（创建WCF Service Library工程：WcfDuplexMessageService）

[c-sharp]view plaincopy 
   
 using System.ServiceModel;  
 namespace WcfDuplexMessageService  
 {  
     [ServiceContract(CallbackContract=typeof(IClient))]  
     public interface IMessageService  
     {  
         [OperationContract]  
         void RegisterClient();  
     }  
     public interface IClient  
     {  
         [OperationContract(IsOneWay = true)]  
         void SendMessage(string message);  
     }  
 }  

(1) 定义的IClient用于客户端回调。
(2) 定义的RegisterClient()用于将客户端回调实例注册到服务端

2. 实现服务（工程WcfDuplexMessageService）
(1) 为了所有客户端都注册到一个服务对象上，所以定义服务端为Singleton实例模式：
InstanceContextMode=InstanceContextMode.Single (Singleton的实例在服务Host启动即实例化)
(2) 定义了一个static的List<IClient>统一保存客户端回调实例，并公开为Property，便于ServerUI能访问。
(3) 为了防止广播时不会因为客户端关闭而导致服务端异常，监听了Channel.Closing事件
客户端关闭(Channel被关闭)时就会触发这个事件，在此事件处理中移除该客户端回调实例。

[c-sharp]view plaincopy 
   
 using System;  
 using System.Collections.Generic;  
 using System.ServiceModel;  
 namespace WcfDuplexMessageService  
 {  
     [ServiceBehavior(InstanceContextMode = InstanceContextMode.Single)]    
     public class MessageService : IMessageService, IDisposable   
     {  
         public static List<IClient> ClientCallbackList { get; set; }  
         public MessageService()  
         {  
             ClientCallbackList = new List<IClient>();  
         }  
         public void RegisterClient()  
         {  
             var client = OperationContext.Current.GetCallbackChannel<IClient>();  
             var id = OperationContext.Current.SessionId;  
             Console.WriteLine("{0} registered.", id);  
             OperationContext.Current.Channel.Closing += new EventHandler(Channel_Closing);  
             ClientCallbackList.Add(client);  
         }  
         void Channel_Closing(object sender, EventArgs e)  
         {  
             lock (ClientCallbackList)  
             {  
                 ClientCallbackList.Remove((IClient)sender);  
             }  
         }  
         public void Dispose()  
         {  
             ClientCallbackList.Clear();  
         }  
     }  
 }  

3. 服务端Host兼UI实现

Broadcast 按钮按下时，遍历 WcfDuplexMessageService.MessageService. ClientCallbackList 回调。

[c-sharp]view plaincopy 
   
 using System;  
 using System.Collections.Generic;  
 using System.ComponentModel;  
 using System.Windows.Forms;  
 using System.ServiceModel;  
 namespace WcfDuplexMessageSvcHost  
 {  
     public partial class Form1 : Form  
     {  
         public Form1()  
         {  
             InitializeComponent();  
         }  
         private ServiceHost _host = null;  
         private void Form1_Load(object sender, EventArgs e)  
         {  
             _host = new ServiceHost(typeof(WcfDuplexMessageService.MessageService));  
             _host.Open();  
             this.label1.Text = "MessageService Opened.";  
         }  
         private void Form1_FormClosing(object sender, FormClosingEventArgs e)  
         {  
             if (_host != null)  
             {  
                 _host.Close();  
                 IDisposable host = _host as IDisposable;  
                 host.Dispose();  
             }  
         }  
         private void button1_Click(object sender, EventArgs e)  
         {  
             var list = WcfDuplexMessageService.MessageService.ClientCallbackList;  
             if (list == null || list.Count == 0)  
                 return;  
             lock (list)  
             {  
                 foreach (var client in list)  
                 {  
                     // Broadcast  
                     client.SendMessage(this.textBox1.Text);  
                 }  
             }  
         }  
     }  
 }  

配置：
为了客户端能直接通过公开的Metadata生成proxy，配置文件中加上：
<endpoint address="mex" binding=" mexHttpBinding" contract=" IMetadataExchange"/>
因为元数据公开的服务（IMetadataExchange）使用的是mexHttpBinding，而Duplex使用的是netTcpBinding，所以需要追加http协议对应的BaseAddress： http://localhost:9998/WcfDuplexMessageService
或者修改元数据公开服务的Binding方式：改为mexTcpBinding

[xhtml]view plaincopy 
   
 <?xml version="1.0"?>  
 <configuration>  
   <system.web>  
     <compilation debug="true"/>  
   </system.web>  
   <system.serviceModel>  
     <services>  
       <service name="WcfDuplexMessageService.MessageService">  
         <endpoint address="" binding="netTcpBinding" bindingConfiguration="" contract="WcfDuplexMessageService.IMessageService">  
           <identity>  
             <dns value="localhost"/>  
           </identity>  
         </endpoint>  
         <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange"/>  
         <host>  
           <baseAddresses>  
             <add baseAddress="net.tcp://localhost:9999/WcfDuplexMessageService/"/>  
             <add baseAddress="http://localhost:9998/WcfDuplexMessageService"/>  
           </baseAddresses>  
         </host>  
       </service>  
     </services>  
     <behaviors>  
       <serviceBehaviors>  
         <behavior>  
           <serviceMetadata httpGetEnabled="True"/>  
           <serviceDebug includeExceptionDetailInFaults="False"/>  
         </behavior>  
       </serviceBehaviors>  
     </behaviors>  
   </system.serviceModel>  
 <startup><supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/></startup></configuration>  

4. 客户端实现
(1) 通过Add Service Reference生成客户端Proxy

(2) 实现 WcfSvc.IMessageServiceCallback (Client.cs)

[c-sharp]view plaincopy 
   
 using System;  
 namespace WcfDuplexMessageClient  
 {  
     public class Client : WcfSvc.IMessageServiceCallback   
     {  
         public void SendMessage(string message)  
         {  
             Console.WriteLine("[ClientTime{0:HHmmss}]Service Broadcast:{1}", DateTime.Now, message);  
         }  
     }  
 }  

(3) 启动客户端，调用服务端的注册方法：WcfSvc.MessageServiceClient，将客户端的Client实例注册到服务。

[c-sharp]view plaincopy 
   
 using System;  
 using System.ServiceModel;  
 namespace WcfDuplexMessageClient  
 {  
     class Program  
     {  
         static void Main(string[] args)  
         {  
             var client = new Client();  
             var ctx = new InstanceContext(client);  
             var svc = new WcfSvc.MessageServiceClient(ctx);  
             svc.RegisterClient();  
             Console.Read();  
         }  
     }  
 }  

OK，运行一下：

补充：
1. 如果去掉回调契约的IsOneWay属性，将会导致服务端引发InvalidOperationException异常。关于Duplex的消息交换定制还可以看看这篇blog:http://www.cnblogs.com/xinhaijulan/archive/2011/01/09/1931272.html
2. XP的IIS 5.x 使用wsDuplexBinding时, 因为回调的服务监听地址默认采用是80,而80正是IIS独占的监听端口。此时会出现AddressAlreadyInUseException异常。为了解决这个问题，需要修改回调服务监听地址：wsDuplexBinding的clientBaseAddress

本系列链接：

WCF 学习总结1 -- 简单实例

WCF 学习总结2 -- 配置WCF

WCF 学习总结3 -- 实例模式

WCF 学习总结4 -- 用Duplex实现消息广播

WCF 学习总结5 -- 消息拦截实现用户名验证

WCF 学习总结6 -- WCF参数与返回值

WCF 学习总结7 -- 流模式实现文件上传

WCF 学习总结8 –- WCF 事务处理