如何：创建自定义跟踪参与者

项目
04/07/2023

工作流跟踪用于查看工作流执行的状态。工作流运行时发出跟踪记录，这些跟踪记录描述工作流生命周期事件、活动生命周期事件、书签摘要和故障。这些跟踪记录供跟踪参与者使用。 Windows Workflow Foundation (WF) 包括一个标准跟踪参与者，可将跟踪记录作为 Windows 事件跟踪 (ETW) 事件写入。如果这不能满足您的需求，您还可以编写自定义跟踪参与者。本教程步骤说明如何创建自定义跟踪参与者和跟踪配置文件，该配置文件捕获 WriteLine 活动的输出，以便将这些活动显示给用户。

创建自定义跟踪参与者

在解决方案资源管理器中右键单击“NumberGuessWorkflowHost”，然后选择“添加”和“类”。在“名称”框中键入 StatusTrackingParticipant，然后单击“添加”。

在包含其他 using（或 Imports）语句的文件的顶部添加以下 using（或 Imports）语句。

Imports System.Activities.Tracking  
Imports System.IO

using System.Activities.Tracking;  
using System.IO;

修改 StatusTrackingParticipant 类，使它从 TrackingParticipant 继承。

Public Class StatusTrackingParticipant  
    Inherits TrackingParticipant  

End Class

class StatusTrackingParticipant : TrackingParticipant  
{  
}

添加以下 Track 方法重写。有多种不同类型的跟踪记录。我们对 WriteLine 活动的输出十分感兴趣，这些活动包含在活动跟踪记录中。如果 TrackingRecord 为 ActivityTrackingRecord 活动的 WriteLine，则 Text 的 WriteLine 将附加到工作流 InstanceId 后面的指定文件。在本教程中，该文件将保存到宿主应用程序的当前文件夹中。

Protected Overrides Sub Track(record As TrackingRecord, timeout As TimeSpan)  
    Dim asr As ActivityStateRecord = TryCast(record, ActivityStateRecord)  

    If Not asr Is Nothing Then  
        If asr.State = ActivityStates.Executing And _  
        asr.Activity.TypeName = "System.Activities.Statements.WriteLine" Then  

            'Append the WriteLine output to the tracking  
            'file for this instance.  
            Using writer As StreamWriter = File.AppendText(record.InstanceId.ToString())  
                writer.WriteLine(asr.Arguments("Text"))  
                writer.Close()  
            End Using  
        End If  
    End If  
End Sub

protected override void Track(TrackingRecord record, TimeSpan timeout)  
{  
    ActivityStateRecord asr = record as ActivityStateRecord;  

    if (asr != null)  
    {  
        if (asr.State == ActivityStates.Executing &&  
            asr.Activity.TypeName == "System.Activities.Statements.WriteLine")  
        {  
            // Append the WriteLine output to the tracking  
            // file for this instance  
            using (StreamWriter writer = File.AppendText(record.InstanceId.ToString()))  
            {  
                writer.WriteLine(asr.Arguments["Text"]);  
                writer.Close();  
            }  
        }  
    }  
}

未指定跟踪配置文件时，使用默认跟踪配置文件。使用默认跟踪配置文件时，将为所有 ActivityStates 发出跟踪记录。因为我们只需在 WriteLine 活动的生命周期内捕获一次文本，所以我们仅从 ActivityStates.Executing 状态捕获文本。在创建跟踪配置文件并注册跟踪参与者中，将创建一个跟踪配置文件，该文件指定仅发出 WriteLine ActivityStates.Executing 跟踪记录。

创建跟踪配置文件并注册跟踪参与者

在解决方案资源管理器中右键单击“WorkflowHostForm”，然后选择“查看代码”。
在包含其他 using（或 Imports）语句的文件的顶部添加以下 using（或 Imports）语句。
```
Imports System.Activities.Tracking  
```
```
using System.Activities.Tracking;  
```

将以下代码添加到 ConfigureWorkflowApplication，紧接在将 StringWriter 添加到工作流扩展的代码之后和工作流生命周期处理程序之前。

'Add the custom tracking participant with a tracking profile  
'that only emits tracking records for WriteLine activities.  
Dim query As New ActivityStateQuery()  
query.ActivityName = "WriteLine"  
query.States.Add(ActivityStates.Executing)  
query.Arguments.Add("Text")  

Dim profile As New TrackingProfile()  
profile.Queries.Add(query)  

Dim stp As New StatusTrackingParticipant()  
stp.TrackingProfile = profile  

wfApp.Extensions.Add(stp)

// Add the custom tracking participant with a tracking profile  
// that only emits tracking records for WriteLine activities.  
StatusTrackingParticipant stp = new StatusTrackingParticipant  
{  
    TrackingProfile = new TrackingProfile  
    {  
        Queries =
        {  
            new ActivityStateQuery  
            {  
                ActivityName = "WriteLine",  
                States = { ActivityStates.Executing },  
                Arguments = { "Text" }  
            }  
        }  
    }  
};  

wfApp.Extensions.Add(stp);

此跟踪配置文件指定仅向自定义跟踪参与者发出处于 WriteLine 状态的 Executing 活动的活动状态记录。

在添加代码后，ConfigureWorkflowApplication 的开头将类似于以下示例。

Private Sub ConfigureWorkflowApplication(wfApp As WorkflowApplication)  
    'Configure the persistence store.  
    wfApp.InstanceStore = store  

    'Add a StringWriter to the extensions. This captures the output  
    'from the WriteLine activities so we can display it in the form.  
    Dim sw As New StringWriter()  
    wfApp.Extensions.Add(sw)  

    'Add the custom tracking participant with a tracking profile  
    'that only emits tracking records for WriteLine activities.  
    Dim query As New ActivityStateQuery()  
    query.ActivityName = "WriteLine"  
    query.States.Add(ActivityStates.Executing)  
    query.Arguments.Add("Text")  

    Dim profile As New TrackingProfile()  
    profile.Queries.Add(query)  

    Dim stp As New StatusTrackingParticipant()  
    stp.TrackingProfile = profile  

    wfApp.Extensions.Add(stp)  

    'Workflow lifecycle handlers...

private void ConfigureWorkflowApplication(WorkflowApplication wfApp)  
{  
    // Configure the persistence store.  
    wfApp.InstanceStore = store;  

    // Add a StringWriter to the extensions. This captures the output  
    // from the WriteLine activities so we can display it in the form.  
    StringWriter sw = new StringWriter();  
    wfApp.Extensions.Add(sw);  

    // Add the custom tracking participant with a tracking profile  
    // that only emits tracking records for WriteLine activities.  
    StatusTrackingParticipant stp = new StatusTrackingParticipant  
    {  
        TrackingProfile = new TrackingProfile  
        {  
            Queries =
            {  
                new ActivityStateQuery  
                {  
                    ActivityName = "WriteLine",  
                    States = { ActivityStates.Executing },  
                    Arguments = { "Text" }  
                }  
            }  
        }  
    };  

    wfApp.Extensions.Add(stp);  

    // Workflow lifecycle handlers...

显示跟踪信息

在解决方案资源管理器中右键单击“WorkflowHostForm”，然后选择“查看代码”。

在 InstanceId_SelectedIndexChanged 处理程序中，添加以下代码，紧接在清除状态窗口的代码之后。

'If there is tracking data for this workflow, display it  
'in the status window.  
If File.Exists(WorkflowInstanceId.ToString()) Then  
    Dim status As String = File.ReadAllText(WorkflowInstanceId.ToString())  
    UpdateStatus(status)  
End If

// If there is tracking data for this workflow, display it  
// in the status window.  
if (File.Exists(WorkflowInstanceId.ToString()))  
{  
    string status = File.ReadAllText(WorkflowInstanceId.ToString());  
    UpdateStatus(status);  
}

在工作流列表中选择新工作流后，将加载该工作流的跟踪记录并将其显示在状态窗口中。以下示例是完成的 InstanceId_SelectedIndexChanged 处理程序。

Private Sub InstanceId_SelectedIndexChanged(sender As Object, e As EventArgs) Handles InstanceId.SelectedIndexChanged  
    If InstanceId.SelectedIndex = -1 Then  
        Return  
    End If  

    'Clear the status window.  
    WorkflowStatus.Clear()  

    'If there is tracking data for this workflow, display it  
    'in the status window.  
    If File.Exists(WorkflowInstanceId.ToString()) Then  
        Dim status As String = File.ReadAllText(WorkflowInstanceId.ToString())  
        UpdateStatus(status)  
    End If  

    'Get the workflow version and display it.  
    'If the workflow is just starting then this info will not  
    'be available in the persistence store so do not try and retrieve it.  
    If Not WorkflowStarting Then  
        Dim instance As WorkflowApplicationInstance = _  
            WorkflowApplication.GetInstance(WorkflowInstanceId, store)  

        WorkflowVersion.Text = _  
            WorkflowVersionMap.GetIdentityDescription(instance.DefinitionIdentity)  

        'Unload the instance.  
        instance.Abandon()  
    End If  
End Sub

private void InstanceId_SelectedIndexChanged(object sender, EventArgs e)  
{  
    if (InstanceId.SelectedIndex == -1)  
    {  
        return;  
    }  

    // Clear the status window.  
    WorkflowStatus.Clear();  

    // If there is tracking data for this workflow, display it  
    // in the status window.  
    if (File.Exists(WorkflowInstanceId.ToString()))  
    {  
        string status = File.ReadAllText(WorkflowInstanceId.ToString());  
        UpdateStatus(status);  
    }  

    // Get the workflow version and display it.  
    // If the workflow is just starting then this info will not  
    // be available in the persistence store so do not try and retrieve it.  
    if (!WorkflowStarting)  
    {  
        WorkflowApplicationInstance instance =  
            WorkflowApplication.GetInstance(this.WorkflowInstanceId, store);  

        WorkflowVersion.Text =  
            WorkflowVersionMap.GetIdentityDescription(instance.DefinitionIdentity);  

        // Unload the instance.  
        instance.Abandon();  
    }  
}

生成并运行应用程序

按 Ctrl+Shift+B 生成应用程序。
按 Ctrl+F5 启动应用程序。
为猜数游戏选择一个范围，并选择要启动的工作流类型，然后单击“新游戏”。在“推测”框中输入猜测值，然后单击“继续”提交该值。可以看到，工作流的状态显示在状态窗口中。此输出是从 WriteLine 活动捕获的。切换到其他工作流，方法是：从“工作流实例 ID”组合框中选择一个工作流，此时可以看到当前工作流的状态已删除。切换回上一个工作流，可以看到其状态已恢复，与以下示例类似。

注意

如果切换到启用跟踪之前启动的工作流，则不会显示状态。但是，如果如果进行了其他猜数，则将保存其状态，因为现在启用了跟踪。
```
Please enter a number between 1 and 10
Your guess is too high.
Please enter a number between 1 and 10
```
注意

此信息对于确定随机数的范围十分有用，但它并不包含有关先前进行的猜数的任何信息。此信息在下一步如何：并行承载多个版本的工作流中。

记下工作流实例 ID，然后播放游戏，直到播完。
打开 Windows 资源管理器，然后导航到“NumberGuessWorkflowHost\bin\debug”文件夹（或“bin\release”，具体取决于项目设置）。可以看到，除了项目可执行文件之外，还有包含 guid 文件名的文件。确定与上一步中已完成工作流的工作流实例 ID 对应的工作流，然后用记事本打开它。跟踪信息所包含的内容类似于以下内容。
```
Please enter a number between 1 and 10
Your guess is too high.
Please enter a number between 1 and 10
Your guess is too high.
Please enter a number between 1 and 10
```
除了缺少用户的猜数之外，此跟踪数据不包含有关工作流的最终猜数的信息。这是因为，跟踪信息仅包含工作流的 WriteLine 输出，而在工作流完成后从 Completed 显示的最终消息也是这样的。在本教程的下一步如何：并行承载多个版本的工作流中，将修改现有的 WriteLine 活动以显示用户的猜数，并添加另一个显示最终结果的 WriteLine 活动。集成这些更改后，如何：并行承载多个版本的工作流演示了如何同时承载多个版本的工作流。

通过

如何：创建自定义跟踪参与者

创建自定义跟踪参与者

创建跟踪配置文件并注册跟踪参与者

显示跟踪信息

生成并运行应用程序

其他资源