WCF ChannelFactory и каналы - кэширование, повторное использование, закрытие и восстановление

У меня есть следующая планируемая архитектура для моей клиентской библиотеки WCF:

  • с использованием ChannelFactory вместо svcutil сгенерированных прокси, потому что Мне нужен больше контроля, а также я хочу, чтобы клиент был отдельным сборки и избежать регенерации при изменении моей службы WCF.
  • необходимо применить поведение с инспектором сообщений к моему WCF конечной точки, поэтому каждый канал может отправлять свои собственный токен аутентификации
  • моя клиентская библиотека будет использоваться с интерфейсом MVC, поэтому мне придется подумать о возможных проблемах с потоками.
  • Я использую .NET 4.5 (возможно, у него есть некоторые помощники или новые подходы к реализации WCF-клиентов каким-то лучшим способом?)

Я прочитал много статей о различных отдельных битах, но я все еще запутался в том, как правильно собрать все это вместе. У меня есть следующие вопросы:

  • Насколько я понимаю, рекомендуется кэшировать ChannelFactory в статической переменной, а затем извлекать из него каналы, не так ли?
  • - это поведение конечной точки, характерное для всего ChannelFactory, или я могу применить мое поведение по умолчанию для каждого канала отдельно? Если поведение специфично для всего factory, это означает, что я не могу хранить информацию о состоянии в объектах поведения конечных точек, потому что один и тот же токен аутентификации будет использоваться повторно для каждого канала, но, очевидно, я хочу, чтобы каждый канал имел свой собственный токен аутентификации для текущего пользователя. Это означает, что мне придется вычислять токен внутри моего поведения в конечной точке (я могу сохранить его в HttpContext, а поведение моего инспектора сообщений просто добавит его в исходящие сообщения).
  • мой класс клиента является одноразовым (реализует IDispose). Как я правильно распоряжаюсь каналом, зная, что он может быть в любом возможном состоянии (не открыт, открыт, не удалось...)? Я просто распоряжаюсь им? Я отменяю его, а потом распоряжаюсь? Закройте ли я его (но он вообще не может быть открыт), а затем утилита?
  • Что мне делать, если я получаю ошибку при работе с каналом? Является ли только сломанный канал или полностью поврежден ChannelFactory?

Я думаю, строка кода говорит более тысячи слов, так вот моя идея в кодовой форме. Я отметил все мои вопросы выше с помощью "???" в коде.

public class MyServiceClient : IDisposable
{
    // channel factory cache
    private static ChannelFactory<IMyService> _factory;
    private static object _lock = new object();

    private IMyService _client = null;
    private bool _isDisposed = false;

     /// <summary>
    /// Creates a channel for the service
    /// </summary>
    public MyServiceClient()
    {
        lock (_lock)
        {
            if (_factory == null)
            {
                // ... set up custom bindings here and get some config values

                var endpoint = new EndpointAddress(myServiceUrl);
                _factory = new ChannelFactory<IMyService>(binding, endpoint);

                // ???? do I add my auth behavior for entire ChannelFactory 
                // or I can apply it for individual channels when I create them?
            }
        }

        _client = _factory.CreateChannel();
    }

    public string MyMethod()
    {
        RequireClientInWorkingState();
        try
        {
            return _client.MyMethod();
        }
        catch
        {
            RecoverFromChannelFailure();
            throw;
        }
    }

    private void RequireClientInWorkingState()
    {
        if (_isDisposed)
            throw new InvalidOperationException("This client was disposed. Create a new one.");

        // ??? is it enough to check for CommunicationState.Opened && Created?
        if (state != CommunicationState.Created && state != CommunicationState.Opened)
            throw new InvalidOperationException("The client channel is not ready to work. Create a new one.");
    }

    private void RecoverFromChannelFailure()
    {
        // ??? is it the best way to check if there was a problem with the channel?
        if (((IChannel)_client).State != CommunicationState.Opened)
        {
            // ??? is it safe to call Abort? won't it throw?
            ((IChannel)_client).Abort();
        }

        // ??? and what about ChannelFactory? 
        // will it still be able to create channels or it also might be broken and must be thrown away? 
        // In that case, how do I clean up ChannelFactory correctly before creating a new one?
    }

    #region IDisposable

    public void Dispose()
    {    
        // ??? is it how to free the channel correctly?
        // I've heard, broken channels might throw when closing 
        // ??? what if it is not opened yet?
        // ??? what if it is in fault state?
        try
        {
            ((IChannel)_client).Close();
        }
        catch
        {
           ((IChannel)_client).Abort();              
        }

        ((IDisposable)_client).Dispose();

        _client = null;
        _isDisposed = true;
    }

    #endregion
}

Ответы

Ответ 1

Я думаю, лучше поздно, а потом никогда... и похоже, что автор работает, это может помочь будущим пользователям WCF.

1) ChannelFactory упорядочивает канал, который включает в себя все виды поведения для канала. Создание канала с помощью метода CreateChannel "активирует" канал. Канальные заводы могут кэшироваться.

2) Вы формируете канал factory с привязками и поведением. Эта форма делится со всеми, кто создает этот канал. Как вы отметили в своем комментарии, вы можете прикреплять инспекторов сообщений, но более распространенным случаем является использование заголовка для отправки пользовательской информации о состоянии в службу. Вы можете прикреплять заголовки через OperationContext.Current

using (var op = new OperationContextScope((IContextChannel)proxy))
{
    var header = new MessageHeader<string>("Some State");
    var hout = header.GetUntypedHeader("message", "urn:someNamespace");
    OperationContext.Current.OutgoingMessageHeaders.Add(hout);
}

3) Это мой общий способ утилизации клиентского канала и factory (этот метод является частью моего класса ProxyBase)

public virtual void Dispose()
{
    CloseChannel();
    CloseFactory();
}

protected void CloseChannel()
{
    if (((IChannel)_client).State == CommunicationState.Opened)
    {
        try
        {
            ((IChannel)_client).Close();
        }
        catch (TimeoutException /* timeout */)
        {
            // Handle the timeout exception
            ((IChannel)innerChannel).Abort();
        }
        catch (CommunicationException /* communicationException */)
        {
            // Handle the communication exception
            ((IChannel)_client).Abort();
        }
    }
}

protected void CloseFactory()
{
    if (Factory.State == CommunicationState.Opened)
    {
        try
        {
            Factory.Close();
        }
        catch (TimeoutException /* timeout */)
        {
            // Handle the timeout exception
            Factory.Abort();
        }
        catch (CommunicationException /* communicationException */)
        {
            // Handle the communication exception
            Factory.Abort();
        }
    }
}

4) WCF будет повреждать канал, а не factory. Вы можете реализовать логику повторного подключения, но это потребует, чтобы вы создавали и выводили своих клиентов из некоторых пользовательских ProxyBase, например.

protected I Channel
{
    get
    {
        lock (_channelLock)
        {
            if (! object.Equals(innerChannel, default(I)))
            {
                ICommunicationObject channelObject = innerChannel as ICommunicationObject;
                if ((channelObject.State == CommunicationState.Faulted) || (channelObject.State == CommunicationState.Closed))
                {
                    // Channel is faulted or closing for some reason, attempt to recreate channel
                    innerChannel = default(I);
                }
            }

            if (object.Equals(innerChannel, default(I)))
            {
                Debug.Assert(Factory != null);
                innerChannel = Factory.CreateChannel();
                ((ICommunicationObject)innerChannel).Faulted += new EventHandler(Channel_Faulted);
            }
        }

        return innerChannel;
    }
}

5) Не используйте повторно каналы. Открыть, сделать что-нибудь, закрыть нормальный шаблон использования.

6) Создайте общий базовый класс прокси и выведите из него всех своих клиентов. Это может быть полезно, например, повторное подключение, используя логику pre-invoke/post invoke, потребляющую события от factory (например, Faulted, Opening)

7) Создайте свой собственный CustomChannelFactory, это даст вам дополнительный контроль над тем, как factory ведет себя, например. Установите тайм-ауты по умолчанию, выполните различные настройки привязки (MaxMessageSizes) и т.д.

public static void SetTimeouts(Binding binding, TimeSpan? timeout = null, TimeSpan? debugTimeout = null)
        {
            if (timeout == null)
            {
                timeout = new TimeSpan(0, 0, 1, 0);
            }
            if (debugTimeout == null)
            {
                debugTimeout = new TimeSpan(0, 0, 10, 0);
            }
            if (Debugger.IsAttached)
            {
                binding.ReceiveTimeout = debugTimeout.Value;
                binding.SendTimeout = debugTimeout.Value;
            }
            else
            {
                binding.ReceiveTimeout = timeout.Value;
                binding.SendTimeout = timeout.Value;
            }
        }