WCF

WCF 异步操作

Posted by Kerwen Blog on March 9, 2022

疑问

  1. WCF Service接收到的每次请求是开启一个新线程还是在主线程里执行？需不需要自己开一个线程？
  2. WCF如果一个请求需要较长时间，该怎么设计？异步？跨线程怎么处理？
  3. 异步 vs 双工callback？

Cretae Demo Project

WCF Service

  1. 以Admin权限打开Visual Studio 2022, 创建新的project
  2. In “Visual C#” -> “WCF”, 选 “WCF Service”, solution名字WCF_Async, project名字WCFService
    img
  3. Visual Sutdio会自动创建两个cs：IService.cs 和 Server.cs,直接按F5，会弹出WCF TEST Client

  4. 修改接口 IService.cs

    1
2
3
4
5
6
7

     [ServiceContract]
 public interface IService
 {

     [OperationContract]
     string GetData(string value);
 }

  5. 修改服务实现 Service.cs

    1
2
3
4
5
6
7
8

     public class Service : IService
 {
     public string GetData(string value)
     {
         Thread.Sleep(5000);
         return string.Format("Server return: {0}", value);
     }
 }
  6. 按F5，弹出WCF TEST Client， 尝试调用GetData 方法
    img

Client

  1. 新建console app， 名称 Client
  2. 保持系统托盘里IIS Express -> WCF Service是否运行，右键Client Reference，添加Service Reference
    img

  3. 修改main函数

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

     internal class Program
 {
     static ServiceClient client = new ServiceClient();
     static void Main(string[] args)
     {
         CallSynMethod();
         Console.Read();
     }

     private static void CallSynMethod()
     {
         Console.WriteLine(client.GetData("Call Server Synchronize Method."));
         Console.WriteLine("Waiting for Synchronize operation...");
     }
 }

会话Sessions 、实例化Instancing和并发Concurrency

WCF的会话具有以下特性：

  1. 它们由调用它的客户端显式启动和终止。
  2. 在会话期间 Service是按照消息接收的顺序进行处理。

WCF Service的实例化行为由 ServiceBehaviorAttribute.InstanceContextMode 属性进行设置， 用来控制如何创建 InstanceContext 以响应传入的消息。
实例化模式有三种：

  1. PerCall：为每个客户端请求创建一个新的 InstanceContext （以及相应的服务对象）。
  2. PerSession：为每个新的客户端会话创建一个新的 InstanceContext （以及相应的服务对象），并在该会话的生存期内对其进行维护（这需要使用支持会话的绑定）。
  3. Single：单个 InstanceContext （以及相应的服务对象）处理服务器生存期内的所有客户端请求。

如果不设置，默认是PerSession

1
2
3
4
5

    [ServiceBehavior(InstanceContextMode=InstanceContextMode.PerSession)]
    public class CalculatorService : ICalculatorInstance
    {
        ...  
    }

并发是对 InstanceContext 中在任一时刻处于活动状态的线程数量的控制. 通过ServiceBehaviorAttribute.ConcurrencyMode来控制.
有以下三种可用的并发模式：

  1. Single：最多允许每个实例上下文同时拥有一个对该实例上下文中的消息进行处理的线程。 其他希望使用同一个实例上下文的线程必须一直阻塞，直到原始线程退出该实例上下文为止。
  2. Multiple：每个服务实例都可以拥有多个同时处理消息的线程。 若要使用此并发模式，服务实现必须是线程安全的。
  3. Reentrant：每个服务实例一次只能处理一个消息，但可以接受可重入的操作调用。 服务仅在通过 WCF 客户端对象调用 时接受这些调用。

异步

可以通过使用下列三种方法之一实现异步操作：

  1. 基于事件的异步模式
  2. IAsyncResult 异步模式
  3. 基于任务的异步模式

基于事件的异步模式

支持基于事件的异步模式的服务将有一个或多个名为 MethodNameAsync 的操作。 这些方法可能会创建同步版本的镜像，这些同步版本会在当前线程上执行相同的操作。 该类还可能具有 MethodNameCompleted 事件，并且可能会具有 MethodNameAsyncCancel（或只是 CancelAsync）方法。 希望调用操作的客户端将定义操作完成时要调用的事件处理程序.
基于事件的异步模型仅在 .NET Framework 3.5 中提供。 此外，如果使用创建 WCF 客户端通道，则不支持此方法，即使在 .NET Framework 3.5 中也是如此 System.ServiceModel.ChannelFactory 。 使用 WCF 客户端通道对象时，必须使用 System.IAsyncResult 对象异步调用操作。

  1. 新建一个WCF service Service1.svc

  2. 修改IService1.cs

    1
2
3
4
5
6

     [ServiceContract]
 public interface IService1
 {
     [OperationContract]
     string GetData(string message);
 }

  3. 修改Service1.cs

    1
2
3
4
5
6
7
8

     public class Service1 : IService1
 {
     public string GetData(string message)
     {
         Thread.Sleep(5000);
         return string.Format("Server return: {0}", message);
     }
 }

服务端代码和同步调用的代码一模一样。

  1. Client端添加新的service引用, 勾选异步操作， img

这样会自动生成 基于事件的函数和IAsyncResult 异步函数 img

  1. 修改Client端代码

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

     internal class Program
 {
     static Service1Client client1 = new Service1Client();
     static void Main(string[] args)
     {
         CallEventBasedAsync();
         Console.Read();
     }

     private static void CallEventBasedAsync()
     {
         client1.GetDataCompleted += client_GetDataCompleted;
         client1.GetDataAsync("event-based asynchronous pattern");
         Console.WriteLine("Waiting for async operation...");
     }
     static void client_GetDataCompleted(object sender, ServiceReference1.GetDataCompletedEventArgs e)
     {
         Console.WriteLine(e.Result.ToString());
     }
 }

IAsyncResult 异步模式

服务操作可以使用 .NET Framework 异步编程模式，并标记 <Begin> 属性设置为的方法，以异步方式实现 AsyncPattern true 。
定义一个异步执行（而不考虑它在客户端应用程序中的调用方式）的协定操作 X：
使用 BeginOperation 和 EndOperation 模式定义两个方法。
BeginOperation 方法包括该操作的 in 和 ref 参数，并返回一个 IAsyncResult 类型。
EndOperation 方法包括一个 IAsyncResult 参数以及 out 和 ref 参数，并返回操作的返回类型。
可以将IAsyncResult异步模式分为两种：

客户端异步模式

客户端异步模式可以直接使用事件异步模式的例子。修改Client端代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

    internal class Program
    {
        static Service1Client client1 = new Service1Client();
        static void Main(string[] args)
        {
            CallIAsyncResultClientSide();
            Console.Read();
        }

        private static void CallIAsyncResultClientSide()
        {
            client1.BeginGetData("IAsyncResult asynchronous pattern (Client-Side)", new AsyncCallback(GetDataCallBackClient), null);
            Console.WriteLine("Waiting for async operation...");
        }
        static void GetDataCallBackClient(IAsyncResult result)
        {
            Console.WriteLine(client1.EndGetData(result).ToString());
        }
    }

服务 & 客户端异步模式

  1. 新建服务Service2.svc

  2. 修改接口,添加属性AsyncPattern

    1
2
3
4
5
6
7
8

     [ServiceContract]
 public interface IService2
 {
     [OperationContractAttribute(AsyncPattern = true)]
     IAsyncResult BeginGetData(string message, AsyncCallback callback, object asyncState);

     string EndGetData(IAsyncResult result);
 }

  3. 实现接口

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

     public class Service2 : IService2
 {
     public IAsyncResult BeginGetData(string message, AsyncCallback callback, object asyncState)
     {
         var task = Task<string>.Factory.StartNew((res) => GetData(asyncState, message), asyncState);
         return task.ContinueWith(res => callback(task));
     }

     public string EndGetData(IAsyncResult result)
     {
         return ((Task<string>)result).Result;
     }

     private string GetData(object asyncState, string message)
     {
         Thread.Sleep(5000);
         return string.Format("Server return: {0}", message);
     }
 }

  4. 客户端引用新的服务 img

  5. 修改client端实现

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

     internal class Program
 {
     static Service2Client client2 = new Service2Client();
     static void Main(string[] args)
     {
         CallIAsyncResultServerSide();
         Console.Read();
     }

     private static void CallIAsyncResultServerSide()
     {
         client2.BeginGetData("IAsyncResult asynchronous pattern (Server-Side)", new AsyncCallback(GetDataCallBackServer), null);
         Console.WriteLine("Waiting for async operation...");
     }
     static void GetDataCallBackServer(IAsyncResult result)
     {
         Console.WriteLine(client2.EndGetData(result).ToString());
     }
 }

基于任务的异步模式

基于任务的异步模式是实现异步操作的首选方法，因为它最简单且最直接。
客户端只需使用 await 关键字调用操作。

服务器端：

  1. 新建服务Service3.svc

  2. 修改接口

    1
2
3
4
5
6
7

     [ServiceContract]
 public interface IService3
 {
     //task-based asynchronous pattern
     [OperationContract]
     Task<string> GetDataAsync(string message);
 }

  3. 实现接口

    1
2
3
4
5
6
7
8
9
10
11
12
13

     public class Service3 : IService3
 {
     public async Task<string> GetDataAsync(string message)
     {
         return await Task.Factory.StartNew(() => GetData(message));
     }

     private string GetData(string message)
     {
         Thread.Sleep(5000);
         return string.Format("Server return: {0}", message);
     }
 }

客户端：

  1. 添加服务引用 img

  2. 修改代码

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

     internal class Program
 {
     static Service3Client client3 = new Service3Client();
     static void Main(string[] args)
     {
         CallTaskBasedAsync();
         Console.Read();
     }

     private static void CallTaskBasedAsync()
     {
         InvokeAsyncMethod("task-based asynchronous pattern");
         Console.WriteLine("Waiting for async operation...");
     }
     static async void InvokeAsyncMethod(string message)
     {
         Console.WriteLine(await client3.GetDataAsync(message));
     }
 }

最后的输出：
img

Client Create channel

上述例子中我们Client端是直接添加了WCF的服务引用，通过调用ServiceClient的方式实现的。ServiceClient是svcutil.exe根据WCF服务生成的客户端。 如果我们不想用这个客户端，而是想自己创建channel连接wcf服务该怎么做呢？
Service端保持不动，新创建一个console，命名Client2。
同样添加service，service1-3的引用，这里我们只是为了引入service接口。

同步调用

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

    using Client2.ServiceReference;
    internal class Program
    {
        static void Main(string[] args)
        {
            CallSynMethod();
            Console.Read();
        }

        private static void CallSynMethod()
        {
            ChannelFactory<IService> factory = null;
            try
            {
                factory = new ChannelFactory<IService>(new BasicHttpBinding(), new EndpointAddress("http://localhost:62355/Service.svc"));
                var channel = factory.CreateChannel();
                var s = channel.GetData("Call Server Synchronize Method.");
                Console.WriteLine(s);
                Console.WriteLine("Waiting for Synchronize operation...");
                factory.Close();
                throw new Exception();
            }
            catch (Exception e)
            {
                if (factory != null)
                {
                    factory.Abort();
                }
            }
        }
    }

基于事件的异步模式

基于事件的异步模型仅在 .NET Framework 3.5 中提供。不适用ServiceClient，我们没法实现事件异步模式。
img

GetDataComplete事件是放在ServiceClient里的，如果我们不使用ServiceClient，那就没法实现事件异步了。
img

IAsyncResult

IAsyncResult 客户端和服务器模式都可以实现，但是我们需要自己处理channel的开启和关闭。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

    using Client2.ServiceReference1;
    using Client2.ServiceReference2;
    internal class Program
    {
        static void Main(string[] args)
        {
            CallIAsyncResultClientSide();
            CallIAsyncResultServerSide();
            Console.Read();
        }

        private static void CallIAsyncResultClientSide()
        {
            CreateChannel();
            channel1.BeginGetData("IAsyncResult asynchronous pattern (Client-Side)", new AsyncCallback(GetDataCallBackClient), null);
            Console.WriteLine("Waiting for async operation...");                
        }

        static ChannelFactory<IService1> factory1 = null;
        static IService1 channel1 = null;
        private static void CreateChannel()
        {
            try
            {
                factory1 = new ChannelFactory<IService1>(new BasicHttpBinding(), new EndpointAddress("http://localhost:62355/Service1.svc"));
                channel1 = factory1.CreateChannel();
            }
            catch (Exception e)
            {
                if (factory1 != null)
                {
                    factory1.Abort();
                }
            }
        }

        static void GetDataCallBackClient(IAsyncResult result)
        {
            
            try
            {
                Console.WriteLine(channel1.EndGetData(result).ToString());
                factory1.Close();
                throw new Exception();
            }
            catch (Exception e)
            {
                if (factory1 != null)
                {
                    factory1.Abort();
                }
            }
        }

        private static void CallIAsyncResultServerSide()
        {
            CreateChannel2();
            channel2.BeginGetData("IAsyncResult asynchronous pattern (Server-Side)", new AsyncCallback(GetDataCallBackServer), null);
            Console.WriteLine("Waiting for async operation...");
        }

        static ChannelFactory<IService2> factory2 = null;
        static IService2 channel2 = null;
        private static void CreateChannel2()
        {
            try
            {
                factory2 = new ChannelFactory<IService2>(new BasicHttpBinding(), new EndpointAddress("http://localhost:62355/Service2.svc"));
                channel2 = factory2.CreateChannel();
            }
            catch (Exception e)
            {
                if (factory2 != null)
                {
                    factory2.Abort();
                }
            }
        }

        static void GetDataCallBackServer(IAsyncResult result)
        {
            try
            {
                Console.WriteLine(channel2.EndGetData(result).ToString());
                factory2.Close();
                throw new Exception();
            }
            catch (Exception e)
            {
                if (factory2 != null)
                {
                    factory2.Abort();
                }
            }
        }
    }

基于任务的异步模式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

using Client2.ServiceReference3;
internal class Program
{
    static void Main(string[] args)
    {
        CallTaskBasedAsync();
        Console.Read();
    }

    private static void CallTaskBasedAsync()
    {
        InvokeAsyncMethod("task-based asynchronous pattern");
        Console.WriteLine("Waiting for async operation...");
    }
    static async void InvokeAsyncMethod(string message)
    {
        Console.WriteLine(await CallMethod(message));
    }

    static async Task<string> CallMethod(string message)
    {
        string s = null;
        ChannelFactory<IService3> factory = null;
        try
        {
            factory = new ChannelFactory<IService3>(new BasicHttpBinding(), new EndpointAddress("http://localhost:62355/Service3.svc"));
            var channel = factory.CreateChannel();
            s = await channel.GetDataAsync("task-based asynchronous pattern");
           
            factory.Close();
            throw new Exception();
        }
        catch (Exception e)
        {
            if (factory != null)
            {
                factory.Abort();
            }
        }
        return s;
    }
}

我们在Client端甚至可以不添加WCF service的引用。我们在Client2里实际上只是在初始化ChannelFactory的时候引用了下接口的定义，可以将IService都抽到一个单独的library里，让Service和Client都可以reference，这样就可以在Client端直接写代码去连接服务。

Reference

同步和异步操作
c#中为什么async方法里必须还要有await？
WCF技术剖析之十一：异步操作在WCF中的应用（上篇）
WCF技术剖析之十一：异步操作在WCF中的应用（下篇）
我的WCF之旅（1）：创建一个简单的WCF程序
如何：控制服务实例化
WCF Service which creates a new thread for every new request
Task-based Asynchronous Operation in WCF
Asynchronous Operations in WCF

CATALOG
    FEATURED TAGS
    C++ C# Web Others Python 理财 .Net Core FTBatch MFC WCF Git WPF VS Electron AE Book Other Wix MSI
    FRIENDS