WF中的跟踪服务(2):使用SqlTrackingService

WF提供了可插拔的跟踪服务，运行时引擎可以在其生存期过程中添加多个运行时服务，因此可以同时启用多个不同类型的跟踪服务。WF框架提供了一个现成的SqlTrackingService跟踪服务，该服务将可配置的跟踪信息写到Sql Server数据库中，下面我们来看看如何使用SqlTrackingService跟踪服务。

跟踪事件类型

工作流运行时在执行工作流时会引发某些事件。 跟踪服务通过捕获这些事件来记录跟踪信息，工作流可以引发以下三种事件：
1.工作流事件（workflow Events）：工作流事件（workflow events）表示工作流状态改变的事件，每次工作流状态的改变都会引发跟踪服务中的跟踪事件，工作流事件定义在TrackingWorkflowEvent枚举中，包括以下值：Created ，Completed，Idle，Suspended，Resumed，Persisted，Unloaded，Loaded，Exception，Terminated，Aborted，Changed，Started。

2.活动事件（Activity Events）：活动事件表示活动状态的改变，活动的状态被定义在ActivityExecutionStatus枚举中，如下：Initialized，Executing，Canceling，Closed，Compensating，Faulting

3.用户事件（User Events）： 在工作流事件（workflow events）和活动事件（Activity Events）中我们只能跟踪已经定义好的事件，有的时候我们需要工作流中特定位置的信息，此时，我们就可以使用自定义跟踪点，用户跟踪事件可以在整个工作流生命周期的任何位置。我们使用Activity的TrackData()方法来创建用户跟踪点。

SqlTrackingService跟踪服务应用举例

1.首先我们要建立跟踪数据，建立数据库的脚本在C:\WINDOWS\Microsoft.NET\Framework\v3.0\Windows Workflow Foundation\SQL\ZH-CHS目录中，Tracking_Logic.sql和Tracking_Schema.sql两个文件。建立完成的跟踪数据库包含表，视图和一些存储过程，详细信息，请查看WF中的跟踪服务(1):Sql跟踪数据库表，视图，存储过程等相关说明这文。

2.跟踪数据库建立完成后我们新建一个顺序工作流控制台程序，在工作流设计器中我们只要拖入一个CodeActivity活动即可，工作流的代码如下：

namespace CarySqlTrackingService
{
    public sealed partial class CarySqlTrackingServiceWorkflow: SequentialWorkflowActivity
    {
        public CarySqlTrackingServiceWorkflow()
        {
            InitializeComponent();
        }

        private void codeActivity1_ExecuteCode(object sender, EventArgs e)
        {
            Console.WriteLine("CodeActivity执行了哦！");
         }
    }
}

3.在宿主程序中，我们给workflow runtime添加SqlTrackingService跟踪服务，代码如下：

namespace CarySqlTrackingService
{
   class Program
   {
      private static String strConn = String.Format("Initial Catalog={0};Data Source={1};
           Integrated Security={2};","WorkflowTracking", @"localhost\SQLEXPRESS", "SSPI");
      static void Main(string[] args)
      {
         using(WorkflowRuntime workflowRuntime = new WorkflowRuntime())
         {
            SqlTrackingService sts = new SqlTrackingService(strConn);
            AutoResetEvent waitHandle = new AutoResetEvent(false);
            workflowRuntime.WorkflowCompleted += delegate(object sender, 
WorkflowCompletedEventArgs e) {waitHandle.Set();};
            workflowRuntime.WorkflowTerminated += delegate(object sender, 
WorkflowTerminatedEventArgs e)
            {
                Console.WriteLine(e.Exception.Message);
                waitHandle.Set();
            };
            workflowRuntime.AddService(sts);
            WorkflowInstance instance = workflowRuntime.CreateWorkflow(typeof
(CarySqlTrackingService.CarySqlTrackingServiceWorkflow));
            Console.WriteLine("---工作流执行开始---");
            instance.Start();
            waitHandle.WaitOne();
            Console.WriteLine("---工作流执行结束---");
         }
     }
  }
}

4.我们还可以使用配置文件的方式来使用SqlTrackingService，app.config代码如下：

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="WorkflowRuntime" 
      type="System.Workflow.Runtime.Configuration.WorkflowRuntimeSection,
        System.Workflow.Runtime, Version=3.0.00000.0, Culture=neutral,
        PublicKeyToken=31bf3856ad364e35" />
  </configSections>
  <WorkflowRuntime>
    <CommonParameters>
      <!--Add parameters common to all services-->
      <add name="ConnectionString" 
           value="Initial Catalog=WorkflowTracking;
             Data Source=localhost\SQLEXPRESS;
             Integrated Security=SSPI;" />
    </CommonParameters>
    <Services>
      <!--Add core services here-->
      <add type="System.Workflow.Runtime.Tracking.SqlTrackingService, 
        System.Workflow.Runtime, Version=3.0.00000.0, Culture=neutral, 
        PublicKeyToken=31bf3856ad364e35"/>
    </Services>
  </WorkflowRuntime>
</configuration>

5.在宿主程序中我们需要使用重载的WorkflowRuntime构造函数来传递配置节名就可以了。
using(WorkflowRuntimeworkflowRuntime = newWorkflowRuntime("WorkflowRuntime")

6.现在我们就使用了SqlTrackingService跟踪服务，运行工作流我们会发现执行的结果只显示CodeActivity被执行了，并没有看到我们的跟踪信息，实际上现在跟踪数据已经存到的Sql Server的跟踪数据库了，不信你可以打开Sql Server数据库中去查看相应的表内容。

使用 SqlTrackingQuery 查询跟踪数据

1.上面我们看到了使用SqlTrackingService跟踪服务后，跟踪的信息已经保存到了数据库中，但是我们直接去数据库中查看很不方便，SqlTrackingQuery 类提供了一些方法和属性，可用于访问存储在 SqlTrackingService 跟踪数据库中的跟踪数据。 对此数据的访问是通过 SqlTrackingWorkflowInstance 对象提供的。 可以调用 TryGetWorkflow 方法来获取特定工作流实例的 SqlTrackingWorkflowInstance。 还可以选择调用 GetWorkflows 方法来获取 SqlTrackingWorkflowInstance 对象的集合，这些对象对应于具有跟踪数据的工作流实例，其中的跟踪数据与一组包含在作为参数传递到方法的SqlTrackingQueryOptions 对象中的查询参数相匹配。

通过传递跟踪数据库的连接字符串，创建 SqlTrackingQuery 类的实例。 然后，可以调用TryGetWorkflow 或GetWorkflows 方法来得到SqlTrackingWorkflowInstance 对象或 SqlTrackingWorkflowInstance 对象的集合。 ActivityEvents 属性包含 ActivityTrackingRecord 对象的集合，这些对象包含工作流中的活动的跟踪信息。 此外，还可以通过检查包含在WorkflowEvents 集合中的 WorkflowTrackingRecord 对象，使用相同的过程来跟踪工作流实例事件。 对于通过调用 TrackData 方法插入的用户事件，UserTrackingRecord 对象将包含在 UserEvents 集合中，该集合也是在SqlTrackingWorkflowInstance 类中定义的。

2.下面我们对SqlTrackingQuery 自己封装了一个类来将跟踪数据查询出来写到控制台上，TrackingConsoleWriter.cs，该类我们会在以后的文章也会使用，现在虽然用不了该类的全部功能，但是先给出类的全部代码：代码如下：

namespace CarySqlTrackingService
{
    public class TrackingConsoleWriter
    {
        private String connectionString = String.Empty;
        public TrackingConsoleWriter(String connString)
        {
            connectionString = connString;
        }
public void DisplayTrackingData(Guid instanceId)
        {
            SortedList<Int32, TrackingRecord> records = QueryTrackingData(instanceId);
            WriteSingleInstanceToConsole(instanceId, records);
        }
private SortedList<Int32, TrackingRecord> QueryTrackingData(Guid instanceId)
        {
            SortedList<Int32, TrackingRecord> records = new SortedList<int, TrackingRecord>();
            try
{
                SqlTrackingQuery query = new SqlTrackingQuery(connectionString);
                SqlTrackingWorkflowInstance instance = null;
                query.TryGetWorkflow(instanceId, out instance);
                BuildSortedList(records, instance);
            }
            catch (System.Data.SqlClient.SqlException e)
            {
                Console.WriteLine("SqlException in QueryTrackingData: {0}", e.Message);
            }
            return records;
        }
private static void BuildSortedList(SortedList<Int32, TrackingRecord> records, 
SqlTrackingWorkflowInstance instance)
        {
            if (instance != null)
            {
                foreach (TrackingRecord record in instance.WorkflowEvents)
                {
                    records.Add(record.EventOrder, record);
                }
                foreach (TrackingRecord record in instance.ActivityEvents)
                {
                    records.Add(record.EventOrder, record);
                }
                foreach (TrackingRecord record in instance.UserEvents)
                {
                    records.Add(record.EventOrder, record);
                }
            }
        }
private void WriteSingleInstanceToConsole(Guid instanceId, 
SortedList<Int32, TrackingRecord> records)
        {
            Console.WriteLine("工作流实例 {0}的跟踪数据", instanceId);
            foreach (TrackingRecord record in records.Values)
            {
                if (record is WorkflowTrackingRecord)
                {
                    WorkflowTrackingRecord wfRecord = record as WorkflowTrackingRecord;
                    Console.WriteLine("{0:HH:mm:ss.fff} Workflow {1}", wfRecord.EventDateTime,
                        wfRecord.TrackingWorkflowEvent);
                }
                else if (record is ActivityTrackingRecord)
                {
                    ActivityTrackingRecord actRecord = record as ActivityTrackingRecord;
                    Console.WriteLine("{0:HH:mm:ss.fff} {1} {2}, Type={3}", 
                        actRecord.EventDateTime,actRecord.ExecutionStatus,
                        actRecord.QualifiedName,actRecord.ActivityType.Name);
                    WriteBodyToConsole(actRecord);
                }
                else if (record is UserTrackingRecord)
                {
                    UserTrackingRecord userRecord = record as UserTrackingRecord;
                    if (userRecord.UserData is RuleActionTrackingEvent)
                    {
                        WriteRuleData(userRecord);
                    }
                    else
                    {
                        Console.WriteLine("{0:HH:mm:ss.fff} UserData from {1} {2}:{3}",
                            userRecord.EventDateTime,userRecord.QualifiedName,
                            userRecord.UserDataKey,userRecord.UserData);
                    }
                }
            }
            Console.WriteLine("工作流实例{0}跟踪数据完成\n\r", instanceId);
        }

        private void WriteBodyToConsole(ActivityTrackingRecord record)
        {
            if (record.Annotations.Count > 0)
            {
                foreach (String annotation in record.Annotations)
                {
                    Console.WriteLine("{0}", annotation);
                }
            }
            if (record.Body.Count > 0)
            {
                foreach (TrackingDataItem data in record.Body)
                {
                    Console.WriteLine("{0}={1}",data.FieldName, data.Data);
                }
            }
        }

        private static void WriteRuleData(UserTrackingRecord userRecord)
        {
            RuleActionTrackingEvent ruleAction
                = userRecord.UserData as RuleActionTrackingEvent;
            Console.WriteLine(
                "{0:HH:mm:ss.fff} RuleAction from {1} Rule:{2} Result:{3}",
                userRecord.EventDateTime,userRecord.QualifiedName,
                ruleAction.RuleName,ruleAction.ConditionResult);
        }

        public void DisplayAllTrackingData(SqlTrackingQueryOptions options)
        {
            IList<SqlTrackingWorkflowInstance> workflows = QueryWorkflowList(options);
            SortedList<Int32, TrackingRecord> records = new SortedList<int, TrackingRecord>();
            foreach (SqlTrackingWorkflowInstance wf in workflows)
            {
                records.Clear();
                BuildSortedList(records, wf);
                WriteSingleInstanceToConsole(wf.WorkflowInstanceId, records);
            }
        }

   private IList<SqlTrackingWorkflowInstance> QueryWorkflowList(SqlTrackingQueryOptions options)
   {
       IList<SqlTrackingWorkflowInstance> workflows = new List<SqlTrackingWorkflowInstance>();
       try
       {
           SqlTrackingQuery query = new SqlTrackingQuery(connectionString);
           workflows = query.GetWorkflows(options);
       }
       catch (System.Data.SqlClient.SqlException e)
       {
           Console.WriteLine("SqlException in QueryWorkflowList: {0}", e.Message);
       }
       return workflows;
    }
  }
}

3.然后我们使用我们封装好的类来查询跟踪数据，需要添加如下代码就可以了：

TrackingConsoleWriter trackingWriter= new TrackingConsoleWriter(strConn);
trackingWriter.DisplayTrackingData(instance.InstanceId);

4.下面是执行结果：

用户跟踪的事件

1.一个User Track Point（用户跟踪点）是我们在工作流或是自定义活动中加入的。你可以加在任意的位置。我们如何创建用户跟踪点呢，我只要调用Activity的TrackData方法就可以了。这样你设定的用户跟踪点就会被跟踪服务记录下来，同样是一条UserTrackingRecord。我们在CodeActivity中添加TrackData方法，代码如下：

private void codeActivity1_ExecuteCode(object sender, EventArgs e)
{
   Console.WriteLine("CodeActivity执行了哦！");
   TrackData("CaryUserPoint", "CaryUserData");
}

2.再次运行工作流，结果如下：

3.从结果中我们可以看到红色线部分就是我们自己加入的跟踪点。