创建 WCF ChannelFactory

Question

我正在尝试将现有的 .NET Remoting 应用程序转换为 WCF。服务器和客户端共享公共接口，所有对象都是服务器激活的对象。

在 WCF 世界中，这类似于创建每次调用服务并使用 ChannelFactory 创建代理。我在如何为 ASP.NET 客户端正确创建 ChannelFactory 方面遇到了一些困难。

出于性能原因，我想缓存 ChannelFactory 对象，并在每次调用服务时创建通道。在 .NET 远程处理时代，曾经有 RemotingConfiguration.GetRegisteredWellknownClientTypes() 方法来获取客户端对象的集合，然后我可以缓存这些对象。看起来，在 WCF 世界中没有这样的东西，尽管我能够从配置文件中获取端点的集合。

现在我认为这会起作用。我可以创建这样的东西：

public static ProxyHelper
{
    static Dictionary<Type, object> lookup = new Dictionary<string, object>();  

    static public T GetChannel<T>()
    {
        Type type = typeof(T);
        ChannelFactory<T> factory;

        if (!lookup.ContainsKey(type))
        {
            factory = new ChannelFactory<T>();
            lookup.Add(type, factory);
        }
        else
        {
            factory = (ChannelFactory<T>)lookup[type];
        }

        T proxy = factory.CreateChannel();   
        ((IClientChannel)proxy).Open();

        return proxy;
    }    
}

我认为上面的代码可以工作，但我有点担心多个线程尝试添加新的 ChannelFactory 对象（如果它不在查找中）。由于我使用的是.NET 4.0，我正在考虑使用 ConcurrentDictionary 并使用 GetOrAdd() 方法或首先使用 TryGetValue() 方法检查 ChannelFactory 是否存在，如果不存在，则使用 GetOrAdd() 方法。但不确定 ConcurrentDictionary.TryGetValue() 和 ConcurrentDictionary.GetOrAdd() 方法的性能。

另一个小问题是我是否需要在 ASP.NET 应用程序结束后对通道工厂对象调用 ChannelFactory.Close() 方法，或者我可以让 .NET 框架自行处理通道工厂对象。使用 ((IChannel)proxy).Close() 方法调用服务方法后，代理通道将始终关闭。

Answer 1

这是我用来处理通道工厂的帮助程序类：

public class ChannelFactoryManager : IDisposable
{
    private static Dictionary<Type, ChannelFactory> _factories = new Dictionary<Type,ChannelFactory>();
    private static readonly object _syncRoot = new object();

    public virtual T CreateChannel<T>() where T : class
    {
        return CreateChannel<T>("*", null);
    }

    public virtual T CreateChannel<T>(string endpointConfigurationName) where T : class
    {
        return CreateChannel<T>(endpointConfigurationName, null);
    }

    public virtual T CreateChannel<T>(string endpointConfigurationName, string endpointAddress) where T : class
    {
        T local = GetFactory<T>(endpointConfigurationName, endpointAddress).CreateChannel();
        ((IClientChannel)local).Faulted += ChannelFaulted;
        return local;
    }

    protected virtual ChannelFactory<T> GetFactory<T>(string endpointConfigurationName, string endpointAddress) where T : class
    {
        lock (_syncRoot)
        {
            ChannelFactory factory;
            if (!_factories.TryGetValue(typeof(T), out factory))
            {
                factory = CreateFactoryInstance<T>(endpointConfigurationName, endpointAddress);
                _factories.Add(typeof(T), factory);
            }
            return (factory as ChannelFactory<T>);
        }
    }

    private ChannelFactory CreateFactoryInstance<T>(string endpointConfigurationName, string endpointAddress)
    {
        ChannelFactory factory = null;
        if (!string.IsNullOrEmpty(endpointAddress))
        {
            factory = new ChannelFactory<T>(endpointConfigurationName, new EndpointAddress(endpointAddress));
        }
        else
        {
            factory = new ChannelFactory<T>(endpointConfigurationName);
        }
        factory.Faulted += FactoryFaulted;
        factory.Open();
        return factory;
    }

    private void ChannelFaulted(object sender, EventArgs e)
    {
        IClientChannel channel = (IClientChannel)sender;
        try
        {
            channel.Close();
        }
        catch
        {
            channel.Abort();
        }
        throw new ApplicationException("Exc_ChannelFailure");
    }

    private void FactoryFaulted(object sender, EventArgs args)
    {
        ChannelFactory factory = (ChannelFactory)sender;
        try
        {
            factory.Close();
        }
        catch
        {
            factory.Abort();
        }
        Type[] genericArguments = factory.GetType().GetGenericArguments();
        if ((genericArguments != null) && (genericArguments.Length == 1))
        {
            Type key = genericArguments[0];
            if (_factories.ContainsKey(key))
            {
                _factories.Remove(key);
            }
        }
        throw new ApplicationException("Exc_ChannelFactoryFailure");
    }

    public void Dispose()
    {
        Dispose(true);
    }

    protected virtual void Dispose(bool disposing)
    {
        if (disposing)
        {
            lock (_syncRoot)
            {
                foreach (Type type in _factories.Keys)
                {
                    ChannelFactory factory = _factories[type];
                    try
                    {
                        factory.Close();
                        continue;
                    }
                    catch
                    {
                        factory.Abort();
                        continue;
                    }
                }
                _factories.Clear();
            }
        }
    }
}

然后我定义一个服务调用程序：

public interface IServiceInvoker
{
    R InvokeService<T, R>(Func<T, R> invokeHandler) where T: class;
}

和一个实现：

public class WCFServiceInvoker : IServiceInvoker
{
    private static ChannelFactoryManager _factoryManager = new ChannelFactoryManager();
    private static ClientSection _clientSection = ConfigurationManager.GetSection("system.serviceModel/client") as ClientSection;

    public R InvokeService<T, R>(Func<T, R> invokeHandler) where T : class
    {
        var endpointNameAddressPair = GetEndpointNameAddressPair(typeof(T));
        T arg = _factoryManager.CreateChannel<T>(endpointNameAddressPair.Key, endpointNameAddressPair.Value);
        ICommunicationObject obj2 = (ICommunicationObject)arg;
        try
        {
            return invokeHandler(arg);
        }
        finally
        {
            try
            {
                if (obj2.State != CommunicationState.Faulted)
                {
                    obj2.Close();
                }
            }
            catch
            {
                obj2.Abort();
            }
        }
    }

    private KeyValuePair<string, string> GetEndpointNameAddressPair(Type serviceContractType)
    {
        var configException = new ConfigurationErrorsException(string.Format("No client endpoint found for type {0}. Please add the section <client><endpoint name=\"myservice\" address=\"http://address/\" binding=\"basicHttpBinding\" contract=\"{0}\"/></client> in the config file.", serviceContractType));
        if (((_clientSection == null) || (_clientSection.Endpoints == null)) || (_clientSection.Endpoints.Count < 1))
        {
            throw configException;
        }
        foreach (ChannelEndpointElement element in _clientSection.Endpoints)
        {
            if (element.Contract == serviceContractType.ToString())
            {
                return new KeyValuePair<string, string>(element.Name, element.Address.AbsoluteUri);
            }
        }
        throw configException;
    }

}

现在每次需要调用 WCF 服务时，您都可以使用它：

WCFServiceInvoker invoker = new WCFServiceInvoker();
SomeReturnType result = invoker.InvokeService<IMyServiceContract, SomeReturnType>(
    proxy => proxy.SomeMethod()
);

这假设您已经为该服务定义了一个客户端端点配置文件中的 IMyServiceContract 服务契约：

<client>
    <endpoint 
        name="myservice" 
        address="http://example.com/" 
        binding="basicHttpBinding" 
        contract="IMyServiceContract" />
</client>

Answer 2

是的，如果你想创建这样的东西 - 一个静态类来保存所有这些 ChannelFactory 实例 - 你绝对必须确保这个类是 100% 线程安全的，并且在访问时不会出错同时。我还没有太多使用 .NET 4 的功能，因此我无法具体评论这些功能 - 但我绝对建议使其尽可能安全。

至于你的第二个（小）问题： ChannelFactory 本身是一个静态类 - 所以你不能真正调用它的 .Close() 方法。如果您想询问是否在实际的 IChannel 上调用 .Close() 方法，那么再次强调：是的，尽力成为一个好公民并关闭如果可以的话，请使用这些渠道。如果您错过了一个，.NET 会处理它 - 但不要只是将未使用的频道扔到地板上然后继续 - 自己清理！ :-)

Answer 3

我不喜欢这种调用结构：

WCFServiceInvoker invoker = new WCFServiceInvoker();
var result = invoker.InvokeService<IClaimsService, ICollection<string>>(proxy => proxy.GetStringClaims());

而且你不能两次使用同一个通道。

我创建了这个解决方案：

using(var i = Connection<IClaimsService>.Instance)
{           
   var result = i.Channel.GetStringClaims();
}

现在您可以重复使用相同的通道，直到 using 语句调用 dispose。

GetChannel 方法基本上是一个 ChannelFactory.CreateChannel() 以及我正在使用的一些额外配置。

您可以像其他解决方案一样为 ChannelFactory 构建一些缓存。

连接类的代码：

public static class Connection<T>
   {
      public static ChannelHolder Instance
      {
         get
         {
            return new ChannelHolder();
         }
      }

      public class ChannelHolder : IDisposable
      {
         public T Channel { get; set; }

         public ChannelHolder()
         {
            this.Channel = GetChannel();
         }

         public void Dispose()
         {
            IChannel connection = null;
            try
            {
               connection = (IChannel)Channel;
               connection.Close();
            }
            catch (Exception)
            {
               if (connection != null)
               {
                  connection.Abort();
               }
            }
         }
      }
}

Answer 4

@NelsonRothermel，是的，我走了这条路
不在 ChannelFactoryManager ChannelFaulted 事件处理程序中使用 try catch。
所以 ChannelFaulted 会变成

 private void ChannelFaulted(object sender, EventArgs e)
    {
        IClientChannel channel = (IClientChannel)sender;            
        channel.Abort();
    }

似乎允许原来的异常冒泡。
还选择不使用channel.close，因为它似乎会引发异常
因为通道已经处于故障状态。
FactoryFaulted 事件处理程序可能有类似的问题。
顺便说一句@Darin，很好的代码......