Устранение неполадок корреляции

Статья
04/07/2023

Корреляция позволяет сопоставлять сообщения службы рабочего процесса друг с другом и с нужным экземпляром рабочего процесса. Если же корреляция настроена неправильно, то сообщения не будут приниматься и приложения будут работать неправильно. В этом разделе даны общие сведения о нескольких методах устранения неполадок корреляции, а также перечислен ряд распространенных проблем, которые возникают при использовании корреляции.

Обработка события UnknownMessageReceived

Событие UnknownMessageReceived происходит, когда служба получает неизвестное сообщение, в том числе сообщение, для которого не удается выполнить корреляцию с существующим экземпляром. Для резидентных служб это событие можно обрабатывать в ведущем приложении.

host.UnknownMessageReceived += delegate(object sender, UnknownMessageReceivedEventArgs e)
{
    Console.WriteLine("Unknown Message Received:");
    Console.WriteLine(e.Message);
};

Для служб, размещенных на веб-сервере, это событие можно обработать, создав класс, производный от WorkflowServiceHostFactory, и переопределив метод CreateWorkflowServiceHost.

class CustomFactory : WorkflowServiceHostFactory
{
    protected override WorkflowServiceHost CreateWorkflowServiceHost(Activity activity, Uri[] baseAddresses)
    {
        // Create the WorkflowServiceHost.
        WorkflowServiceHost host = new WorkflowServiceHost(activity, baseAddresses);

        // Handle the UnknownMessageReceived event.
        host.UnknownMessageReceived += delegate(object sender, UnknownMessageReceivedEventArgs e)
        {
            Console.WriteLine("Unknown Message Received:");
            Console.WriteLine(e.Message);
        };

        return host;
    }
}

Затем этот настраиваемый объект WorkflowServiceHostFactory можно указать в файле svc для службы.

<% @ServiceHost Language="C#" Service="OrderServiceWorkflow" Factory="CustomFactory" %>

Когда вызывается этот обработчик, сообщение можно получить через свойство Message объекта UnknownMessageReceivedEventArgs. Оно будет выглядеть следующим образом.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <To s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://localhost:8080/OrderService</To>
    <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://tempuri.org/IService/AddItem</Action>
  </s:Header>
  <s:Body>
    <AddItem xmlns="http://tempuri.org/">
      <Item>Books</Item>
    </AddItem>
  </s:Body>
</s:Envelope>

Проверка сообщений, передаваемых в обработчик события UnknownMessageReceived, может помочь понять, почему не выполнена корреляция сообщения с экземпляром службы рабочего процесса.

Использование отслеживания для наблюдения за ходом рабочего процесса

Отслеживание позволяет наблюдать за ходом рабочего процесса. По умолчанию записи отслеживания создаются для событий жизненного цикла рабочего процесса, событий жизненного цикла действия, распространения ошибок и возобновления закладок. Кроме того, настраиваемые действия могут создавать настраиваемые записи отслеживания. При устранении неполадок корреляции наиболее полезны записи отслеживания действий, записи возобновления закладок и записи распространения ошибок. Записи отслеживания действий позволяют определить текущий ход выполнения рабочего процесса и выявить действие обмена сообщения, которое в данный момент ожидает сообщений. Записи возобновления закладок полезны, поскольку в них указывается, что сообщение получено рабочим процессом, а в записях распространения ошибок регистрируются все ошибки в рабочем процессе. Чтобы включить отслеживание, укажите нужный объект TrackingParticipant в свойстве WorkflowExtensions объекта WorkflowServiceHost. В следующем примере ConsoleTrackingParticipant (из примера пользовательского отслеживания ) настраивается с помощью профиля отслеживания по умолчанию.

host.WorkflowExtensions.Add(new ConsoleTrackingParticipant());

Участник отслеживания, такой как ConsoleTrackingParticipant, удобен для резидентных служб рабочего процесса с окном консоли. Для веб-службы следует использовать участника отслеживания, который регистрирует данные отслеживания в устойчивом хранилище, например встроенный или настраиваемый участник отслеживания, который записывает информацию в EtwTrackingParticipantфайл.

Дополнительные сведения об отслеживании и настройке отслеживания для веб-службы рабочих процессов см. в разделах Отслеживание и трассировка рабочих процессов, Настройка отслеживания для рабочего процесса и Примеры отслеживания [примеры WF] .

Использование трассировки WCF

Трассировка WCF отслеживает поток входящих и исходящих сообщений для службы рабочего процесса. Данные такой трассировки удобны при устранении неполадок корреляции, особенно для корреляции по содержимому. Чтобы включить трассировку, укажите нужные прослушиватели трассировки в разделе system.diagnostics файла web.config для службы рабочего процесса, размещенной на веб-сервере, или файла app.config для резидентной службы рабочего процесса. Чтобы включить содержимое сообщений в файл трассировки, укажите значение true для атрибута logEntireMessage в элементе messageLogging в разделе diagnostics объекта system.serviceModel. В следующем примере для данных трассировки, включая содержимое сообщений, задается запись в файл с именем service.svclog.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <system.diagnostics>
    <sources>
      <source name="System.ServiceModel" switchValue="Information" propagateActivity="true">
        <listeners>
          <add name="corr"/>
        </listeners>
      </source>
      <source name="System.ServiceModel.MessageLogging">
        <listeners>
          <add name="corr"/>
        </listeners>
      </source>
    </sources>

    <sharedListeners>
      <add name="corr" type="System.Diagnostics.XmlWriterTraceListener" initializeData="c:\logs\service.svclog">
      </add>
    </sharedListeners>
  </system.diagnostics>

  <system.serviceModel>
    <diagnostics>
      <messageLogging logEntireMessage="true" logMalformedMessages="false"
         logMessagesAtServiceLevel="false" logMessagesAtTransportLevel="true" maxSizeOfMessageToLog="2147483647">
      </messageLogging>
    </diagnostics>
  </system.serviceModel>
</configuration>

Для просмотра сведений трассировки, содержащихся в service.svclog, используется средство просмотра трассировки служб (SvcTraceViewer.exe). Оно особенно полезно при устранении неполадок корреляции по содержимому, поскольку можно просматривать содержимое сообщений, точно определять переданные данные и проверять соответствие CorrelationQuery для корреляции по содержимому. Дополнительные сведения о трассировке WCF см. в разделах Средство просмотра трассировки служб (SvcTraceViewer.exe),Настройка трассировки и Использование трассировки для устранения неполадок в приложении.

Распространенные проблемы корреляции обмена контекстом

Для правильной работы некоторых типов корреляции необходимо использовать определенный тип привязки. Примерами служат корреляция по схеме «запрос-ответ», где требуется двусторонняя привязка, такая как BasicHttpBinding, и корреляция обмена контекстом, для которой требуется привязка на основе контекста, такая как BasicHttpContextBinding. Большинство привязок поддерживают двусторонние операции, поэтому проблема совместимости редко возникает для корреляции по схеме «запрос-ответ», однако существует лишь небольшое число привязок на основе контекста, включая BasicHttpContextBinding, WSHttpContextBinding и NetTcpContextBinding. Если не используется одна из этих привязок, то первый вызов службы рабочего процесса завершится успешно, однако последующие вызовы завершатся ошибкой со следующим исключением FaultException.

There is no context attached to the incoming message for the service
and the current operation is not marked with "CanCreateInstance = true".
In order to communicate with this service check whether the incoming binding
supports the context protocol and has a valid context initialized.

Данные контекста, используемые для корреляции контекста, можно вернуть из SendReply в действие Receive, которое инициализирует корреляцию контекста, если используется двусторонняя операция, или указать в вызывающем объекте в случае односторонней операции. Если контекст не отправляется вызывающим объектом и не возвращается службой рабочего процесса, то при вызове последующей операции будет возвращаться исключение FaultException, описанное ранее.

Распространенные проблемы корреляции по схеме «запрос-ответ»

Корреляция "запрос-ответ" используется с парой Receive/SendReply для реализации двусторонней операции в службе рабочего процесса и с парой Send/ReceiveReply , которая вызывает двунаправляемую операцию в другой веб-службе. При вызове двусторонней операции в службе WCF служба может быть либо традиционной службой WCF на основе императивного кода, либо службой рабочего процесса. Для корреляции «запрос-ответ» необходимо использовать двустороннюю привязку, такую как BasicHttpBinding, и операции должны быть двусторонними.

Если служба рабочих процессов имеет двусторонние операции в параллельном режиме или перекрываются Receive/SendReply илиReceiveReply Send/парами, то неявного управления дескриптором WorkflowServiceHost корреляции, предоставляемого , может быть недостаточно, особенно в сценариях с высоким уровнем нагрузки, и сообщения могут быть неправильно перенаправлены. Чтобы предотвратить эту проблему, рекомендуется всегда явно указывать CorrelationHandle при использовании корреляции «запрос-ответ». При использовании шаблонов SendAndReceiveReply и ReceiveAndSendReply из раздела Messaging панели элементов в конструкторе CorrelationHandle рабочих процессов явно настраивается по умолчанию. Если рабочий процесс создается из программного кода, то дескриптор CorrelationHandle указывается в свойстве CorrelationInitializers первого действия из пары. В следующем примере действие Receive настраивается с явным дескриптором CorrelationHandle, указанным в RequestReplyCorrelationInitializer.

Variable<CorrelationHandle> RRHandle = new Variable<CorrelationHandle>();

Receive StartOrder = new Receive
{
    CanCreateInstance = true,
    ServiceContractName = OrderContractName,
    OperationName = "StartOrder",
    CorrelationInitializers =
    {
        new RequestReplyCorrelationInitializer
        {
            CorrelationHandle = RRHandle
        }
    }
};

SendReply ReplyToStartOrder = new SendReply
{
    Request = StartOrder,
    Content = ... // Contains the return value, if any.
};

// Construct a workflow using StartOrder and ReplyToStartOrder.

Сохраняемость между парой или парой Receive/SendReply не допускается Send/ReceiveReply . Создается зона несохраняемости, которая существует до завершения обоих действий. Если действие, например действие Delay, находится в этой зоне несохраняемости и вызывает переход рабочего процесса в состояние бездействия, рабочий поток не будет сохранен, даже если узел настроен на сохранение рабочих потоков после их перехода в состояние бездействия. Если действие, например действие Persist, пытается выполнить явное сохранение в зоне несохраняемости, формируется неустранимое исключение, выполнение рабочего процесса прерывается, а вызывающему возвращается исключение FaultException. Сообщение о неустранимом исключении: «System.InvalidOperationException: действия Persist не могут содержаться в блоках несохраняемости». Это исключение не возвращается вызывающему, его можно обнаружить, если включено отслеживание. Сообщение об исключении FaultException, возвращаемое вызывающему: «Операцию выполнить не удалось, потому что рабочий процесс '5836145b-7da2-49d0-a052-a49162adeab6' завершился».

Дополнительные сведения о корреляции запросов и ответов см. в разделе Запрос и ответ.

Распространенные проблемы корреляции по содержимому

Корреляция по содержимому применяется, если служба рабочего процесса получает несколько сообщений, а нужный экземпляр определяется по некоторому фрагменту данных в передаваемых сообщениях. При корреляции по содержимому такие данные в сообщении, например номер заказчика или идентификатор заказа, используются для маршрутизации сообщений в нужный экземпляр рабочего процесса. В этом разделе описан ряд распространенных проблем, которые возникают при использовании корреляции по содержимому.

Убедитесь, что определяющие данные уникальны

Данные, используемые для идентификации экземпляра, хэшируются в ключ корреляции. Необходимо обеспечить уникальность данных, используемых для корреляции. В противном случае в хэшированном ключе могут возникнуть конфликты, которые приведут к неправильной маршрутизации сообщений. Например, корреляция на основе только имени заказчика может вызвать конфликт, так как возможно наличие заказчиков с одинаковыми именами. Двоеточие (:) не должно встречаться в данных, используемых для корреляции сообщений, так как оно уже применяется в качестве разделителя ключа и значения в запросе сообщения, формирующих строку, которая затем хэшируется. Если используется сохраняемость, убедитесь, что текущие определяющие данные не используются в ранее сохраненном экземпляре. Эту проблему можно выявить, временно отключив сохраняемость. С помощью трассировки WCF можно просмотреть вычисленный ключ корреляции. Такая трассировка полезна в отладке проблем с ключом корреляции.

Конфликты

Между получением сообщения службой и инициализацией корреляции проходит некоторое время, в течение которого последующие сообщения будут пропускаться. Если служба рабочего процесса инициализирует корреляцию по содержимому с использованием данных, переданных от клиента через одностороннюю операцию, а вызывающий объект немедленно отправляет последующие сообщения, то такие сообщения будут пропускаться в течение этого интервала. Чтобы избежать этого, используйте для инициализации корреляции двустороннюю операцию или используйте действие TransactedReceiveScope.

Проблемы с запросами корреляции

Запросы корреляции указывают, какие данные в сообщении используются для корреляции сообщения. Эти данные указываются с помощью запроса XPath. Если сообщения в службу не доставляются, хотя ошибки не обнаруживаются, то одним из приемов диагностики является указание вместо запроса XPath литерального значения, совпадающего со значением данных сообщения. Чтобы указать литеральное значение, используйте функцию string. В следующем примере MessageQuerySet настраивается для использования литерального значения 11445 для OrderId, а запрос XPath помещается в комментарий.

MessageQuerySet = new MessageQuerySet
{
    {
        "OrderId",
        //new XPathMessageQuery("sm:body()/tempuri:StartOrderResponse/tempuri:OrderId")
        new XPathMessageQuery("string('11445')")
    }
}

Если запрос XPath настроен неправильно, в результате чего данные о корреляции не возвращаются, возвращается ошибка со следующим сообщением: «Запрос корреляции возвратил пустой результирующий набор. Убедитесь, что запросы корреляции для конечной точки настроены правильно. Одним из быстрых способов устранения этой проблемы является замена запроса XPath литеральным значением, как описано в предыдущем разделе. Эта проблема может возникнуть, если вы используете построитель запросов XPath в диалоговых окнах Добавление инициализаторов корреляции или КорреляцииВ определении, а служба рабочих процессов использует контракты сообщений. В следующем примере определяется класс контракта сообщения.

[MessageContract]
public class AddItemMessage
{
    [MessageHeader]
    public string CartId;

    [MessageBodyMember]
    public string Item;
}

В рабочем процессе этот контракт сообщения используется действием Receive. Идентификатор CartId в заголовке сообщения используется для корреляции сообщения с правильным экземпляром. Если запрос XPath, возвращающий идентификатор CartId, создается с помощью диалоговых окон корреляции в конструкторе рабочих процессов, формируется следующий неверный запрос XPath.

sm:body()/xg0:AddItemMessage/xg0:CartId

Этот запрос XPath был бы правильным, если бы действие Receive использовало параметры для данных, но, поскольку оно использует контракт сообщения, запрос является неверным. Следующий запрос XPath является правильным для получения идентификатора CartId из заголовка.

sm:header()/tempuri:CartId

Это можно проверить, изучив текст сообщения.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://tempuri.org/IService/AddItem</Action>
    <h:CartId xmlns:h="http://tempuri.org/">80c95b41-c98d-4660-a6c1-99412206e54c</h:CartId>
  </s:Header>
  <s:Body>
    <AddItemMessage xmlns="http://tempuri.org/">
      <Item>Books</Item>
    </AddItemMessage>
  </s:Body>
</s:Envelope>

В следующем примере показано действие Receive, настроенное для операции AddItem, использующей предыдущий контракт сообщения для получения данных. Запрос XPath настроен правильно.

<Receive CorrelatesWith="[CCHandle] OperationName="AddItem" ServiceContractName="p:IService">
  <Receive.CorrelatesOn>
    <XPathMessageQuery x:Key="key1">
      <XPathMessageQuery.Namespaces>
        <ssx:XPathMessageContextMarkup>
          <x:String x:Key="xg0">http://schemas.datacontract.org/2004/07/MessageContractWFService</x:String>
        </ssx:XPathMessageContextMarkup>
      </XPathMessageQuery.Namespaces>sm:header()/tempuri:CartId</XPathMessageQuery>
  </Receive.CorrelatesOn>
  <ReceiveMessageContent DeclaredMessageType="m:AddItemMessage">
    <p1:OutArgument x:TypeArguments="m:AddItemMessage">[AddItemMessage]</p1:OutArgument>
  </ReceiveMessageContent>
</Receive>

Поделиться через