使用 WorkflowIdentity 和版本控制

项目
05/09/2023

WorkflowIdentity 为工作流应用程序开发人员提供了一种将名称和 Version 与工作流定义关联的方法，这种方法还可用于将此信息与持久化工作流实例相关联。工作流应用程序开发人员可以使用这些标识信息，为一些情景（如并行执行一个工作流定义的多个版本）提供支持，并为其他功能（如动态更新）提供基础。此主题概述了如何将 WorkflowIdentity 与 WorkflowApplication 承载一起使用。若要了解工作流服务中工作流定义的并行执行，请参阅 WorkflowServiceHost 中的并行版本控制。有关动态更新的信息，请参阅动态更新。

本主题内容

使用 WorkflowIdentity

若要使用 WorkflowIdentity，请创建并配置一个实例，并将它与一个 WorkflowApplication 实例关联。一个 WorkflowIdentity 实例包含三条标识信息。 Name 和 Version 包含一个名称和一个 Version，并且是必需的；而 Package 则是可选的，可用于指定包含如程序集名称或其他所需信息的附加字符串。如果 WorkflowIdentity 的三个属性中有任一属性不同于其他 WorkflowIdentity，则它是唯一的。

重要

WorkflowIdentity 不应包含任何个人身份信息 (PII)。在几个不同活动生命周期点，运行时将向任何已配置的跟踪服务发出有关用于创建实例的 WorkflowIdentity 的信息。 WF 跟踪没有任何隐藏 PII（敏感用户信息）的机制。因此，WorkflowIdentity 实例不应该包含任何 PII 数据，因为运行时将在跟踪记录中发出这些数据，任何有权查看跟踪记录的人都能够看到这些数据。

在以下示例中，创建了 WorkflowIdentity 并将它与使用 MortgageWorkflow 工作流定义创建的工作流实例相关联。

WorkflowIdentity identityV1 = new WorkflowIdentity
{
    Name = "MortgageWorkflow v1",
    Version = new Version(1, 0, 0, 0)
};

WorkflowApplication wfApp = new WorkflowApplication(new MortgageWorkflow(), identity);

// Configure the WorkflowApplication with persistence and desired workflow event handlers.
ConfigureWorkflowApplication(wfApp);

// Run the workflow.
wfApp.Run();

重新加载和恢复工作流时，必须使用一个配置为与持久化工作流实例的 WorkflowIdentity 匹配的 WorkflowIdentity。

WorkflowApplication wfApp = new WorkflowApplication(new MortgageWorkflow(), identityV1);

// Configure the WorkflowApplication with persistence and desired workflow event handlers.
ConfigureWorkflowApplication(wfApp);

// Load the workflow.
wfApp.Load(instanceId);

// Resume the workflow...

如果重新加载工作流实例时使用的 WorkflowIdentity 与持久化 WorkflowIdentity 不匹配，则将引发 VersionMismatchException。在以下示例中，尝试加载在前一个示例中持久化的 MortgageWorkflow 实例。执行此加载尝试时，使用了一个为更新版本抵押工作流配置的 WorkflowIdentity，该工作流与持久保存实例不匹配。

WorkflowApplication wfApp = new WorkflowApplication(new MortgageWorkflow_v2(), identityV2);

// Configure the WorkflowApplication with persistence and desired workflow event handlers.
ConfigureWorkflowApplication(wfApp);

// Attempt to load the workflow instance.
wfApp.Load(instanceId);

// Resume the workflow...

执行前一段代码时，引发了以下 VersionMismatchException。

The WorkflowIdentity ('MortgageWorkflow v1; Version=1.0.0.0') of the loaded instance does not match the WorkflowIdentity ('MortgageWorkflow v2; Version=2.0.0.0') of the provided workflow definition. The instance can be loaded using a different definition, or updated using Dynamic Update.

使用 WorkflowIdentity 并行执行

可使用 WorkflowIdentity 帮助并行执行一个工作流的多个版本。一种常见的情形是更改长期运行的工作流的业务需求。部署更新版本时，可能正在运行一个工作流的多个实例。可对主机应用程序进行配置，使之在启动新实例时使用更新过的工作流定义，并且该主机应用程序应负责在恢复实例时提供正确的工作流定义。 WorkflowIdentity 可用于在恢复工作流实例时确定和提供匹配的工作流定义。

为检索持久化工作流实例的 WorkflowIdentity，将使用 GetInstance 方法。 GetInstance 方法使用持久化工作流实例的 Id 和包含该持久化实例的 SqlWorkflowInstanceStore，并返回一个 WorkflowApplicationInstance。 WorkflowApplicationInstance 包含有关持久化工作流实例的信息，包括其关联的 WorkflowIdentity。主机可使用此关联 WorkflowIdentity 在加载和恢复工作流实例时提供正确的工作流定义。

注意

空 WorkflowIdentity 是有效的，主机可以用它将没有关联 WorkflowIdentity 的持久化实例映射到正确的工作流定义。如果最初编写工作流应用程序时没有采用工作流版本控制，或者应用程序从 .NET Framework 4 升级而来，就可能发生这种情况。有关详细信息，请参阅将升级 .NET Framework 4 持久性数据库以支持工作流版本控制。

在以下示例中，使用了一个 Dictionary<WorkflowIdentity, Activity> 将 WorkflowIdentity 实例与其匹配的工作流定义相关联，并使用了与 identityV1WorkflowIdentity 相关联的 MortgageWorkflow 工作流定义来启动一个工作流。

WorkflowIdentity identityV1 = new WorkflowIdentity
{
    Name = "MortgageWorkflow v1",
    Version = new Version(1, 0, 0, 0)
};

WorkflowIdentity identityV2 = new WorkflowIdentity
{
    Name = "MortgageWorkflow v2",
    Version = new Version(2, 0, 0, 0)
};

Dictionary<WorkflowIdentity, Activity> WorkflowVersionMap = new Dictionary<WorkflowIdentity, Activity>();
WorkflowVersionMap.Add(identityV1, new MortgageWorkflow());
WorkflowVersionMap.Add(identityV2, new MortgageWorkflow_v2());

WorkflowApplication wfApp = new WorkflowApplication(new MortgageWorkflow(), identityV1);

// Configure the WorkflowApplication with persistence and desired workflow event handlers.
ConfigureWorkflowApplication(wfApp);

// Run the workflow.
wfApp.Run();

在以下示例中，通过调用 GetInstance 来检索有关前一个示例中持久化工作流实例的信息，并使用了持久化 WorkflowIdentity 信息来检索匹配的工作流定义。将使用这些信息来配置 WorkflowApplication，然后将加载工作流。请注意，因为使用了 Load 重载（它使用 WorkflowApplicationInstance），SqlWorkflowInstanceStore 将使用在 WorkflowApplicationInstance 上配置的 WorkflowApplication，因此无需配置其 InstanceStore 属性。

注意

如果设置 InstanceStore 属性，则必须用 SqlWorkflowInstanceStore 所使用的那一个 WorkflowApplicationInstance 实例来设置，否则将引发 ArgumentException 异常，并显示以下消息：The instance is configured with a different InstanceStore than this WorkflowApplication.。

// Get the WorkflowApplicationInstance of the desired workflow from the specified
// SqlWorkflowInstanceStore.
WorkflowApplicationInstance instance = WorkflowApplication.GetInstance(instanceId, store);

// Use the persisted WorkflowIdentity to retrieve the correct workflow
// definition from the dictionary.
Activity definition = WorkflowVersionMap[instance.DefinitionIdentity];

WorkflowApplication wfApp = new WorkflowApplication(definition, instance.DefinitionIdentity);

// Configure the WorkflowApplication with persistence and desired workflow event handlers.
ConfigureWorkflowApplication(wfApp);

// Load the persisted workflow instance.
wfApp.Load(instance);

// Resume the workflow...

升级 .NET Framework 4 持久性数据库以支持工作流版本控制

SqlWorkflowInstanceStoreSchemaUpgrade.sql 数据库脚本旨在用于升级使用 .NET Framework 4 数据库脚本创建的持久性数据库。此脚本会更新这些数据库，使之支持 .NET Framework 4.5 中引入的全新版本控制功能。数据库中任何持久化工作流实例都将获得默认的版本控制值，然后就可以参与并行执行和动态更新。

如果某个 .NET Framework 4.5 工作流应用程序尝试执行任何持久性操作，而此类操作对尚未使用提供的脚本升级的持久性数据库使用新的版本控制功能，则将引发 InstancePersistenceCommandException，并显示与以下消息内容类似的消息。

The SqlWorkflowInstanceStore has a database version of '4.0.0.0'. InstancePersistenceCommand 'System.Activities.DurableInstancing.CreateWorkflowOwnerWithIdentityCommand' cannot be run against this database version.  Please upgrade the database to '4.5.0.0'.

升级数据库架构

打开 SQL Server Management Studio 并连接到持久性数据库服务器，例如 .\SQLEXPRESS。
从“文件”菜单中依次选择“打开”和“文件”。浏览到以下文件夹：C:\Windows\Microsoft.NET\Framework\v4.0.30319\sql\en
选择“SqlWorkflowInstanceStoreSchemaUpgrade.sql”，然后单击“打开”。
在“可用数据库”下拉列表中选择持久性数据库的名称。
从“查询”菜单中选择“执行”。

查询完成时，数据库架构将升级，您可以根据需要查看分配给持久化工作流实例的默认工作流标识。在对象资源管理器中的“数据库”节点中展开你的持久性数据库，然后展开“视图”节点。右键单击“System.Activities.DurableInstancing.Instances”，然后选择“选择前 1000 行”。滚动到列的末尾，可以看到视图中另外添加了六列，它们是：“IdentityName”、“IdentityPackage”、“Build”、“Major”、“Minor”以及“Revision”。对于任何持久化工作流，这些字段的值都将为 NULL，表示空工作流标识。