前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >WCF技术剖析之三十:一个很有用的WCF调用编程技巧[上篇]

WCF技术剖析之三十:一个很有用的WCF调用编程技巧[上篇]

作者头像
蒋金楠
发布2018-01-16 17:10:32
2.1K0
发布2018-01-16 17:10:32
举报
文章被收录于专栏:大内老A大内老A

在进行基于会话信道的WCF服务调用中,由于受到并发信道数量的限制,我们需要及时的关闭信道;当遇到某些异常,我们需要强行中止(Abort)信道,相关的原理,可以参考我的文章《服务代理不能得到及时关闭会有什么后果?》。在真正的企业级开发中,正如我们一般不会让开发人员手工控制数据库连接的开启和关闭一样,我们一般也不会让开发人员手工去创建、开启、中止和关闭信道,这些工作是框架应该完成的操作。这篇文章,我们就来介绍如果通过一些编程技巧,让开发者能够无视“信道”的存在,像调用一个普通对象一样进行服务调用。

一、正常的服务调用方式

如果通过ChannelFactory<TChannel>创建用于服务调用的代理,下面的代码片段描述了客户端典型的服务调用形式:将服务调用在基于代理对象的using块中,并通过try/catch进一步对服务调用操作进行异常处理。当TimeoutException或者CommunicationException被捕获后,调用Abort方法将信道中止。当程序执行到using的末尾,Dispose方法会进一步调用Close方法对信道进行关闭。

代码语言:javascript
复制
class Program
代码语言:javascript
复制
{
代码语言:javascript
复制
    static void Main(string[] args)
代码语言:javascript
复制
    {
代码语言:javascript
复制
        using (ChannelFactory<ICalculator> channelFactory = new ChannelFactory<ICalculator>("calculatorservice"))
代码语言:javascript
复制
        {
代码语言:javascript
复制
            ICalculator calculator = channelFactory.CreateChannel();
代码语言:javascript
复制
            using (calculator as IDisposable)
代码语言:javascript
复制
            {
代码语言:javascript
复制
                try
代码语言:javascript
复制
                {
代码语言:javascript
复制
                    Console.WriteLine("x + y = {2} when x = {0} and y = {1}", 1, 2, calculator.Add(1, 2));
代码语言:javascript
复制
                }
代码语言:javascript
复制
                catch (TimeoutException)
代码语言:javascript
复制
                {
代码语言:javascript
复制
                    (calculator as ICommunicationObject).Abort();
代码语言:javascript
复制
                    throw;
代码语言:javascript
复制
                }
代码语言:javascript
复制
                catch (CommunicationException)
代码语言:javascript
复制
                {
代码语言:javascript
复制
                    (calculator as ICommunicationObject).Abort();
代码语言:javascript
复制
                    throw;
代码语言:javascript
复制
                }
代码语言:javascript
复制
            }
代码语言:javascript
复制
        }
代码语言:javascript
复制
代码语言:javascript
复制
        Console.Read();
代码语言:javascript
复制
    }
代码语言:javascript
复制
}

二、借助通过Delegate实现异常处理和服务代理的关闭

虽然上面的编程方式是正确的服务调用方式,但是在真正的应用中,如果在每处进行服务调用的地方都采用上面的方式,在我看来是不能容忍的。这不但会让你的程序显得臃肿不堪,而且带来非常多重复的代码,此外频繁创建ChannelFactory<TChannel>对性能也会有影响。我们可以通过一些公共个方法实现对重复代码(ChannelFactory<TChannel>的创建,服务调用的创建、中止和关闭,以及异常处理)。为此我创建了如下一个ServiceInvoker类型,通过两个重载的Invoke方法实现对目标服务的调用。

代码语言:javascript
复制
   1: using System;
代码语言:javascript
复制
   2: using System.Collections.Generic;
代码语言:javascript
复制
   3: using System.ServiceModel;
代码语言:javascript
复制
   4: namespace Artech.Lib
代码语言:javascript
复制
   5: {
代码语言:javascript
复制
   6:     public class ServiceInvoker
代码语言:javascript
复制
   7:     {
代码语言:javascript
复制
   8:         private static Dictionary<string, ChannelFactory> channelFactories = new Dictionary<string, ChannelFactory>();
代码语言:javascript
复制
   9:         private static object syncHelper = new object();
代码语言:javascript
复制
  10:  
代码语言:javascript
复制
  11:         private static ChannelFactory<TChannel> GetChannelFactory<TChannel>(string endpointConfigurationName)
代码语言:javascript
复制
  12:         {
代码语言:javascript
复制
  13:             ChannelFactory<TChannel> channelFactory = null;
代码语言:javascript
复制
  14:             if (channelFactories.ContainsKey(endpointConfigurationName))
代码语言:javascript
复制
  15:             {
代码语言:javascript
复制
  16:                 channelFactory = channelFactories[endpointConfigurationName] as ChannelFactory<TChannel>;
代码语言:javascript
复制
  17:             }
代码语言:javascript
复制
  18:  
代码语言:javascript
复制
  19:             if (null == channelFactory)
代码语言:javascript
复制
  20:             {
代码语言:javascript
复制
  21:                 channelFactory = new ChannelFactory<TChannel>(endpointConfigurationName);
代码语言:javascript
复制
  22:                 lock (syncHelper)
代码语言:javascript
复制
  23:                 {
代码语言:javascript
复制
  24:                     channelFactories[endpointConfigurationName] = channelFactory;
代码语言:javascript
复制
  25:                 }
代码语言:javascript
复制
  26:             }
代码语言:javascript
复制
  27:             return channelFactory;
代码语言:javascript
复制
  28:         }
代码语言:javascript
复制
  29:  
代码语言:javascript
复制
  30:         public static void Invoke<TChannel>(Action<TChannel> action, TChannel proxy)
代码语言:javascript
复制
  31:         {
代码语言:javascript
复制
  32:             ICommunicationObject channel = proxy as ICommunicationObject;
代码语言:javascript
复制
  33:             if (null == channel)
代码语言:javascript
复制
  34:             {
代码语言:javascript
复制
  35:                 throw new ArgumentException("The proxy is not a valid channel implementing the ICommunicationObject interface", "proxy");
代码语言:javascript
复制
  36:             }
代码语言:javascript
复制
  37:             try
代码语言:javascript
复制
  38:             {
代码语言:javascript
复制
  39:                 action(proxy);
代码语言:javascript
复制
  40:             }
代码语言:javascript
复制
  41:             catch (TimeoutException)
代码语言:javascript
复制
  42:             {
代码语言:javascript
复制
  43:                 channel.Abort();
代码语言:javascript
复制
  44:                 throw;
代码语言:javascript
复制
  45:             }
代码语言:javascript
复制
  46:             catch (CommunicationException)
代码语言:javascript
复制
  47:             {
代码语言:javascript
复制
  48:                 channel.Abort();
代码语言:javascript
复制
  49:                 throw;
代码语言:javascript
复制
  50:             }
代码语言:javascript
复制
  51:             finally
代码语言:javascript
复制
  52:             {
代码语言:javascript
复制
  53:                 channel.Close();
代码语言:javascript
复制
  54:             }
代码语言:javascript
复制
  55:         }
代码语言:javascript
复制
  56:  
代码语言:javascript
复制
  57:         public static TResult Invoke<TChannel, TResult>(Func<TChannel, TResult> function, TChannel proxy)
代码语言:javascript
复制
  58:         {
代码语言:javascript
复制
  59:             ICommunicationObject channel = proxy as ICommunicationObject;
代码语言:javascript
复制
  60:             if (null == channel)
代码语言:javascript
复制
  61:             {
代码语言:javascript
复制
  62:                 throw new ArgumentException("The proxy is not a valid channel implementing the ICommunicationObject interface", "proxy");
代码语言:javascript
复制
  63:             }
代码语言:javascript
复制
  64:             try
代码语言:javascript
复制
  65:             {
代码语言:javascript
复制
  66:               return  function(proxy);
代码语言:javascript
复制
  67:             }
代码语言:javascript
复制
  68:             catch (TimeoutException)
代码语言:javascript
复制
  69:             {
代码语言:javascript
复制
  70:                 channel.Abort();
代码语言:javascript
复制
  71:                 throw;
代码语言:javascript
复制
  72:             }
代码语言:javascript
复制
  73:             catch (CommunicationException)
代码语言:javascript
复制
  74:             {
代码语言:javascript
复制
  75:                 channel.Abort();
代码语言:javascript
复制
  76:                 throw;
代码语言:javascript
复制
  77:             }
代码语言:javascript
复制
  78:             finally
代码语言:javascript
复制
  79:             {
代码语言:javascript
复制
  80:                 channel.Close();
代码语言:javascript
复制
  81:             }
代码语言:javascript
复制
  82:         }
代码语言:javascript
复制
  83:  
代码语言:javascript
复制
  84:         public static void Invoke<TChannel>(Action<TChannel> action, string endpointConfigurationName)
代码语言:javascript
复制
  85:         {
代码语言:javascript
复制
  86:             Guard.ArgumentNotNullOrEmpty(endpointConfigurationName, "endpointConfigurationName");
代码语言:javascript
复制
  87:             Invoke<TChannel>(action, GetChannelFactory<TChannel>(endpointConfigurationName).CreateChannel());
代码语言:javascript
复制
  88:         }
代码语言:javascript
复制
  89:  
代码语言:javascript
复制
  90:         public static TResult Invoke<TChannel, TResult>(Func<TChannel, TResult> function, string endpointConfigurationName)
代码语言:javascript
复制
  91:         {
代码语言:javascript
复制
  92:             Guard.ArgumentNotNullOrEmpty(endpointConfigurationName, "endpointConfigurationName");           
代码语言:javascript
复制
  93:             return Invoke<TChannel, TResult>(function, GetChannelFactory<TChannel>(endpointConfigurationName).CreateChannel());
代码语言:javascript
复制
  94:         }        
代码语言:javascript
复制
  95:     }
代码语言:javascript
复制
  96: }

处于对性能的考虑,避免对ChannelFactory<TChannel>的频繁创建,通过一个字典对象将创建出来的ChannelFactory<TChannel>缓存起来;两个Invoke方法中,服务的调用通过两个Delegate对象(Action<TChannel>和Func<TChannel, TResult>)表示,另一个参数表示终结点的配置名称。那么这时的服务调用就会变得相当简单:

代码语言:javascript
复制
   1: using System;
代码语言:javascript
复制
   2: using Artech.Lib;
代码语言:javascript
复制
   3: using Artech.WcfServices.Contracts;
代码语言:javascript
复制
   4: namespace Artech.WcfServices.Clients
代码语言:javascript
复制
   5: {
代码语言:javascript
复制
   6:     class Program
代码语言:javascript
复制
   7:     {
代码语言:javascript
复制
   8:         static void Main(string[] args)
代码语言:javascript
复制
   9:         {
代码语言:javascript
复制
  10:             int result = ServiceInvoker.Invoke<ICalculator, int>(calculator => calculator.Add(1, 2), "calculatorservice");
代码语言:javascript
复制
  11:             Console.WriteLine("x + y = {2} when x = {0} and y = {1}", 1, 2, result);
代码语言:javascript
复制
  12:             Console.Read();
代码语言:javascript
复制
  13:         }
代码语言:javascript
复制
  14:     }
代码语言:javascript
复制
  15: }

三、对ServiceInvoker的改进

实际上,为了对服务调用实现细节进行进一步的封装,一般地我们可以将其定义在一个独立的层中,比如服务代理层(这里的层不一定像数据访问层、业务逻辑层一样需要一个明显的界限,这里可能就是一个单独的类型而已)。在这种情况下,我们可以上面的ServiceInvoker方法进行一定的改造,使之更加符合这种分层的场景。上面我们调用静态方法的形式进行服务的调用,现在我们需要的是:实例化服务代理对象,并调用相应的方法。为此,我创建了一个泛型的ServiceInvoker<TChannel>类型,该类型继承自上述的ServiceInvoker,泛型类型表示服务契约类型。ServiceInvoker<TChannel>定义如下:

代码语言:javascript
复制
   1: using System;
代码语言:javascript
复制
   2: namespace Artech.Lib
代码语言:javascript
复制
   3: {
代码语言:javascript
复制
   4:     public class ServiceInvoker<TChannel>:ServiceInvoker
代码语言:javascript
复制
   5:     {
代码语言:javascript
复制
   6:         public string EndpointConfigurationName
代码语言:javascript
复制
   7:         {get; private set;}
代码语言:javascript
复制
   8:  
代码语言:javascript
复制
   9:         public ServiceInvoker(string endpointConfigurationName)
代码语言:javascript
复制
  10:         {
代码语言:javascript
复制
  11:             Guard.ArgumentNotNullOrEmpty(endpointConfigurationName, "endpointConfigurationName");
代码语言:javascript
复制
  12:             this.EndpointConfigurationName = endpointConfigurationName;
代码语言:javascript
复制
  13:         }
代码语言:javascript
复制
  14:  
代码语言:javascript
复制
  15:         public void Invoke(Action<TChannel> action)
代码语言:javascript
复制
  16:         {
代码语言:javascript
复制
  17:             Invoke<TChannel>(action, this.EndpointConfigurationName);
代码语言:javascript
复制
  18:         }
代码语言:javascript
复制
  19:  
代码语言:javascript
复制
  20:         public TResult Invoke<TResult>(Func<TChannel, TResult> function)
代码语言:javascript
复制
  21:         {
代码语言:javascript
复制
  22:             return Invoke<TChannel, TResult>(function, this.EndpointConfigurationName);
代码语言:javascript
复制
  23:         }
代码语言:javascript
复制
  24:     }
代码语言:javascript
复制
  25: }

通过传入终结点配置名称创建ServiceInvoker<TChannel>对象,直接通过调用基类的静态方法实现了两个Invoke方法。

在分层设计中,为每一个层定义的组件创建基类是一个很常见的设计方式。在这里,假设所有的服务代理类型均继承自基类:ServiceProxyBase<TChannel>,泛型类型为服务契约类型。同样通过传入终结点配置名称创建服务代理,并借助于通过Invoker属性表示的ServiceInvoker<TChannel>对象进行服务的调用。ServiceProxyBase<TChannel>定义如下:

代码语言:javascript
复制
   1: namespace Artech.Lib
代码语言:javascript
复制
   2: {
代码语言:javascript
复制
   3:     public class ServiceProxyBase<TChannel>
代码语言:javascript
复制
   4:     {
代码语言:javascript
复制
   5:         public virtual ServiceInvoker<TChannel> Invoker
代码语言:javascript
复制
   6:         { get; private set; }
代码语言:javascript
复制
   7:  
代码语言:javascript
复制
   8:         public ServiceProxyBase(string endpointConfigurationName)
代码语言:javascript
复制
   9:         {
代码语言:javascript
复制
  10:             Guard.ArgumentNotNullOrEmpty(endpointConfigurationName, "endpointConfigurationName");
代码语言:javascript
复制
  11:             this.Invoker = new ServiceInvoker<TChannel>(endpointConfigurationName);
代码语言:javascript
复制
  12:         }
代码语言:javascript
复制
  13:     }
代码语言:javascript
复制
  14: }

那么,具体的服务代理类型就可以通过如下的方式定义了:

代码语言:javascript
复制
   1: using Artech.Lib;
代码语言:javascript
复制
   2: using Artech.WcfServices.Contracts;
代码语言:javascript
复制
   3: namespace Artech.WcfServices.Clients
代码语言:javascript
复制
   4: {
代码语言:javascript
复制
   5:     public class CalculatorProxy : ServiceProxyBase<ICalculator>, ICalculator
代码语言:javascript
复制
   6:     {
代码语言:javascript
复制
   7:         public CalculatorProxy():base(Constants.EndpointConfigurationNames.CalculatorService)
代码语言:javascript
复制
   8:         { }
代码语言:javascript
复制
   9:  
代码语言:javascript
复制
  10:         public int Add(int x, int y)
代码语言:javascript
复制
  11:         {
代码语言:javascript
复制
  12:             return this.Invoker.Invoke<int>(calculator => calculator.Add(x, y));
代码语言:javascript
复制
  13:         }
代码语言:javascript
复制
  14:     }
代码语言:javascript
复制
  15:  
代码语言:javascript
复制
  16:     public class Constants
代码语言:javascript
复制
  17:     {
代码语言:javascript
复制
  18:         public class EndpointConfigurationNames
代码语言:javascript
复制
  19:         {
代码语言:javascript
复制
  20:             public const string CalculatorService = "calculatorservice";
代码语言:javascript
复制
  21:         }
代码语言:javascript
复制
  22:     }
代码语言:javascript
复制
  23: }

那么现在服务代理的消费者(一般是Presenter层对象),就可以直接实例化服务代理对象,并调用相应的方法(这里的方法与服务契约方法一致)即可,所有关于服务调用的细节均被封装在服务代理中。

代码语言:javascript
复制
   1: using System;
代码语言:javascript
复制
   2: using Artech.Lib;
代码语言:javascript
复制
   3: using Artech.WcfServices.Contracts;
代码语言:javascript
复制
   4: namespace Artech.WcfServices.Clients
代码语言:javascript
复制
   5: {
代码语言:javascript
复制
   6:     class Program
代码语言:javascript
复制
   7:     {
代码语言:javascript
复制
   8:         static void Main(string[] args)
代码语言:javascript
复制
   9:         {
代码语言:javascript
复制
  10:             CalculatorProxy calculatorProxy = new CalculatorProxy();
代码语言:javascript
复制
  11:             int result = calculatorProxy.Add(1, 2);
代码语言:javascript
复制
  12:             Console.WriteLine("x + y = {2} when x = {0} and y = {1}", 1, 2, result);
代码语言:javascript
复制
  13:             Console.Read();
代码语言:javascript
复制
  14:         }
代码语言:javascript
复制
  15:     }
代码语言:javascript
复制
  16: }

四、局限

这个解决方案有一个很大的局限:服务方式不能包含ref和out参数,因为这两种类型的参数不能作为匿名方法的参数。

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2010-01-04 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 一、正常的服务调用方式
  • 二、借助通过Delegate实现异常处理和服务代理的关闭
  • 三、对ServiceInvoker的改进
相关产品与服务
数据库
云数据库为企业提供了完善的关系型数据库、非关系型数据库、分析型数据库和数据库生态工具。您可以通过产品选择和组合搭建,轻松实现高可靠、高可用性、高性能等数据库需求。云数据库服务也可大幅减少您的运维工作量,更专注于业务发展,让企业一站式享受数据上云及分布式架构的技术红利!
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档