WCF回调操作简单的说就是由服务端来调用客户端的方法,回调时原先的服务端和客户端将发生对调,服务端成为客户端,客户端成为服务端。
WCF回调的必要条件:
1、并不是所有的绑定都支持回调操作,只有具有双向通信能力的绑定才可以使用回调。比如HTTP是与连接无关的因此不能用于回调。这就说明我们不能使用BasicHttpBinding或WSHttpBinding进行回调。WCF中NetTcpBinding和NetNamedPipeBinding支持回调,因为从本质上讲TCP和IPC协议支持双向通信。WCF中wsDualHttpBinding也是支持回调的因为它实际上是设置了两个HTTP通道
定义回调契约
一个服务契约若要定义回调,必须专门定义一个用于回调的契约。一个服务契约最多包含一个回调契约,一个服务契约一旦定义了回调契约那客户端必须支持这个回调。那如何为一个服务契约定义回调呢?使用ServiceContract特性的CallBackContract特性,代码如下:
2 public interface IService1
3 {
4 [OperationContract(IsOneWay = true )]
5 void DoSomething();
6 }
7
8 // 用于回调的契约
9 interface ISomeCallbackContract
10 {
11 [OperationContract(IsOneWay = true )]
12 void SomeCallbackMethod();
13
14 [OperationContract(IsOneWay = true )]
15 void SomeCallbackMethod2();
16 }
客户端回调设置
客户端需要实现服务端定义的那个用于回调的契约ISomeCallbackContract,然后实例化回调对象再通过它创建一个上下文对象InstanceContext。然后用代理把这个回调的引用传回服务端
下面通过代码实例说明:
服务端代码:
2 public interface IService1
3 {
4 [OperationContract(IsOneWay = true )]
5 void DoSomething();
6 }
7
8 // 用于回调的契约
9 interface ISomeCallbackContract
10 {
11 [OperationContract(IsOneWay = true )]
12 void SomeCallbackMethod();
13
14 [OperationContract(IsOneWay = true )]
15 void SomeCallbackMethod2();
16 }
实现服务的类:
2 public class Service1 : IService1
3 {
4 static List < ISomeCallbackContract > m_Callbacks = new List < ISomeCallbackContract > ();
5
6 public void DoSomething()
7 {
8
9 // 获得由客户端传入的回调终结点的引用,使用这个引用可以调用客户端方法
10 ISomeCallbackContract callback = OperationContext.Current.GetCallbackChannel < ISomeCallbackContract > ();
11 if (m_Callbacks.Contains(callback) == false )
12 {
13 m_Callbacks.Add(callback);
14
15 }
16 Trace.WriteLine( " DoSomething " );
17
18 // 调用客户端实现的SomeCallbackMethod2方法,
19 callback.SomeCallbackMethod2();
20 CallClients();
21 }
22
23 static public void CallClients()
24 {
25 Action < ISomeCallbackContract > invoke = delegate (ISomeCallbackContract callback)
26 {
27 callback.SomeCallbackMethod();
28 };
29 m_Callbacks.ForEach(invoke);
30 }
31
32 }
客户端代码:
2
3 public class CallBack : ServiceReferenceCallBack.IService1Callback
4 {
5 public void SomeCallbackMethod()
6 {
7 MessageBox.Show( " SomeCallbackMethod() " , " MyClient " );
8 }
9
10
11 public void SomeCallbackMethod2()
12 {
13 MessageBox.Show( " SomeCallbackMethod2() " , " MyClient " );
14 }
15
16 }
客户端调用
首先生成回调接口实现的对象,然后用这个对象去实例化一个上下文对象context ,在创建客户端代理对象的时候在构造方法中使用这个上下文对象context 就可以把客户端回调对象的引用作为消息的一部分传送到服务端,在服务端就可以通过OperationContext.Current.GetCallbackChannel<ISomeCallbackContract>()来获得这个回调对象的引用,服务端有了这个回调对象的引用就可以去调用客户端实现的回调方法。
2 InstanceContext context = new InstanceContext(callback);
3 ServiceReferenceCallBack.Service1Client sc = new WCFPrograme.ServiceReferenceCallBack.Service1Client(context);
4 sc.DoSomething();
总结:
1、必须使用支持双向通信的绑定如NetTcpBinding、NetNamedPipeBinding、WSDualHttpBinding
2、用 CallbackContract 为服务定义回调,回调的接口在服务端定义。
例:
[ServiceContract(CallbackContract = typeof(ISomeCallbackContract))]
3、服务端用 OperationContext.Current.GetCallbackChannel<T>()获取调用当前操作的客户端实例通道
例:
ISomeCallbackContract callback = OperationContext.Current.GetCallbackChannel<ISomeCallbackContract>()
4、服务端获得客户端实例通道的对象以后就可以调用客户端方法
例:
callback.SomeCallbackMethod2();
5、客户端生成代理以后,由客户端去实现回调接口
例:
public class CallBack : ServiceReferenceCallBack.IService1Callback
{
//实现接口
}
6、客户端创建回调的对象并生成操作调用的上下文并由客户端代理对象传回服务端
例:
2 InstanceContext context = new InstanceContext(callback);
3 ServiceReferenceCallBack.Service1Client sc = new WCFPrograme.ServiceReferenceCallBack.Service1Client(context);
4 sc.DoSomething();
7、配置文件:使用wsDualHttpBinding的时候,需要在客户端配置文件中需要指定客户端基址clientBaseAddress,服务可以通过这个地址与客户端取得联系,这是因为wsDualHttpBinding需要两条http通道,而是使用netTcpBinding时不需要
例:
2 binding = " wsDualHttpBinding " bindingConfiguration = " WSDualHttpBinding_IService1 "
3 contract = " ServiceReferenceCallBack.IService1 " name = " WSDualHttpBinding_IService1 " >
4 < identity >
5 < dns value = " localhost " />
6 </ identity >
7 </ endpoint >
8
9 < wsDualHttpBinding >
10 < binding name = " WSDualHttpBinding_IService1 " closeTimeout = " 00:01:00 "
11 openTimeout = " 00:01:00 " receiveTimeout = " 00:10:00 " sendTimeout = " 00:01:00 "
12 bypassProxyOnLocal = " false " transactionFlow = " false " hostNameComparisonMode = " StrongWildcard "
13 maxBufferPoolSize = " 524288 " maxReceivedMessageSize = " 65536 "
14 messageEncoding = " Text " textEncoding = " utf-8 " useDefaultWebProxy = " true "
15 clientBaseAddress = " http://localhost:8008 " >
16 < readerQuotas maxDepth = " 32 " maxStringContentLength = " 8192 " maxArrayLength = " 16384 "
17 maxBytesPerRead = " 4096 " maxNameTableCharCount = " 16384 " />
18 < reliableSession ordered = " true " inactivityTimeout = " 00:10:00 " />
19 < security mode = " Message " >
20 < message clientCredentialType = " Windows " negotiateServiceCredential = " true "
21 algorithmSuite = " Default " />
22 </ security >
23 </ binding >
24 </ wsDualHttpBinding >