WorkflowServiceHost 中的并行版本控制

项目
05/10/2023

.NET Framework 4.5 中引入的 WorkflowServiceHost 并行版本控制功能提供了在单个终结点上托管工作流服务的多个版本的能力。所提供的并行功能允许配置工作流服务，以便使用新的工作流定义来创建工作流服务的新实例，而对于正在运行的实例则使用现有的定义来完成。本主题概述了使用 WorkflowServiceHost 的工作流服务并行执行。

在工作流服务中承载多个版本

WorkflowServiceHost 包含两个属性，它们可配置为允许工作流的多个版本并行执行：SupportedVersions 和 DefinitionIdentity。 SupportedVersions 包含所支持的工作流服务版本，而 DefinitionIdentity 用于唯一地标识每个工作流服务。这一点通过将 WorkflowIdentity 与工作流服务关联来实现。 WorkflowIdentity 包含三条标识信息。 Name 和 Version 包含一个名称和一个 Version，并且是必需的；而 Package 则是可选的，可用于指定包含如程序集名称或其他所需信息的附加字符串。 SupportedVersions 集合中包含的每个工作流服务都必须具有唯一的 WorkflowIdentity。如果 WorkflowIdentity 的三个属性中有任一属性不同于其他 WorkflowIdentity，则它是唯一的。 nullWorkflowIdentity 是 DefinitionIdentity 的允许值，但只有一个早期版本的工作流服务可能有 nullWorkflowIdentity。

重要

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

承载工作流服务的多个版本的规则

当用户向 WorkflowServiceHost 添加其他版本时，必须满足几个条件，以便以相同的一组终结点和说明来承载工作流服务。如果任何其他版本未能满足这些条件，则 WorkflowServiceHost 在调用 Open 时会引发异常。作为附加版本向主机提供的每个工作流定义必须满足以下要求（其中，主版本是提供给主机构造函数的工作流服务定义）。附加的工作流版本必须：

具有与工作流服务的主版本相同的 Name。
在其 Receive 中不得有主版本中不存在的任何 SendReply 或 Body 活动，并且这些活动必须与操作协定相匹配。
具有唯一的 DefinitionIdentity。有且仅有一个工作流定义可以具有 nullDefinitionIdentity。

允许进行一些更改。以下各项在各版本间可能有所不同：

DefinitionIdentity 可能有与主版本不同的名称和包。
AllowBufferedReceive 值可能不同于主版本。
ConfigurationName 可能不同于主版本。
ImplementedContracts 可能不同于主版本。

配置 DefinitionIdentity

使用工作流设计器创建工作流服务时，使用“属性”窗口设置 DefinitionIdentity。在设计器中，在服务的根活动外单击以选择工作流服务，并从“查看”菜单选择“属性窗口”。从 DefinitionIdentity 属性旁显示的下拉菜单中选择 WorkflowIdentity，然后展开，并指定所需的 WorkflowIdentity 属性。在下面的示例中，使用 NameMortgageWorkflow 和 Version1.0.0.0 对 DefinitionIdentity 进行配置。 Package 是可选的，在此示例中是 null。

Screenshot that shows the DefinitionIdentity property.

如果工作流服务是自承载的，则 DefinitionIdentity 在构造工作流服务时配置。在以下示例中，使用与前面示例相同的值，以及 NameMortgageWorkflow 和 Name1.0.0.0 对 DefinitionIdentity 进行配置。

WorkflowService service = new WorkflowService  
{  
    Name = "MortgageWorkflowService",  
    Body = new MortgageWorkflow(),  
    DefinitionIdentity = new WorkflowIdentity  
    {  
        Name = "MortgageWorkflow",  
        Version = new Version(1, 0, 0, 0)  
    }  
};

Dim service As New WorkflowService  
With service  
    .Name = "MortgageWorkflowService"  
    .Body = New MortgageWorkflow  
    .DefinitionIdentity = New WorkflowIdentity With _  
    { _  
        .Name = "MortgageWorkflow", _  
        .Version = New Version(1, 0, 0, 0) _  
    }  
End With

DefinitionIdentity 不是必需的，尽管只有一个版本的工作流服务可能有 nullDefinitionIdentity。

注意

如果最初部署服务时未配置 DefinitionIdentity，则这一点非常有用，然后会创建一个更新的版本。

将新版本添加到 Web 承载的工作流服务

在 Web 承载的服务中配置新版本工作流服务的第一步是：在与服务文件同名的 App_Code 文件夹中创建一个新的文件夹。如果服务的 xamlx 文件命名为 MortgageWorkflow.xamlx，则必须将该文件夹命名为 MortgageWorkflow。将原始服务的 xamlx 文件的副本放到此文件夹中，并将其重命名为新名称，如 MortgageWorkflowV1.xamlx。对主服务进行所需的更改，更新其 DefinitionIdentity，然后部署服务。在下面的示例中，使用 DefinitionIdentity Name 和 MortgageWorkflowVersion 更新了 2.0.0.0。

Screenshot that shows DefinitionIdentity of WorkflowIdentity.

当该服务重新启动时，以前的版本会自动添加到 SupportedVersions 集合，因为它位于指定的 App_Code 子文件夹中。请注意，如果工作流服务的主版本具有 nullDefinitionIdentity，则将不会添加以前的版本。一个版本可能有 nullDefinitionIdentity，但如果有多个版本，则主版本不得是具有 nullDefinitionIdentity 的版本，否则以前的版本不会添加到 SupportedVersions 集合。

将新版本添加到自承载的工作流服务

将新版本添加到自承载的工作流服务时，使用主版本的工作流服务对 WorkflowServiceHost 进行配置，以前的版本必须显式添加到 SupportedVersions 集合。在以下示例中，使用主工作流服务对 WorkflowServiceHost 进行配置（工作流服务使用 MortgageWorkflowV2 工作流定义），并且将使用 MortgageWorkflowV1 工作流定义配置的工作流服务添加到 SupportedVersions 集合。每个工作流服务均配置一个反映工作流定义版本的唯一 DefinitionIdentity。

// Create the primary version of the workflow service.  
WorkflowService serviceV2 = new WorkflowService  
{  
    Name = "MortgageWorkflowService",  
    Body = new MortgageWorkflowV2(),  
    DefinitionIdentity = new WorkflowIdentity  
    {  
        Name = "MortgageWorkflow",  
        Version = new Version(2, 0, 0, 0)  
    }  
};  
  
// Configure the WorkflowServiceHost with the current version  
// of the workflow service. This code requires Administrator  
// privileges to function correctly. If running from Visual  
// Studio, Visual Studio must be run with Administrator privileges.  
WorkflowServiceHost host = new WorkflowServiceHost(serviceV2,
    new Uri("http://localhost:8080/MortgageWorkflowService"));  
  
// Create the previous version of the workflow service.  
WorkflowService serviceV1 = new WorkflowService  
{  
    Name = "MortgageWorkflowService",  
    Body = new MortgageWorkflowV1(),  
    DefinitionIdentity = new WorkflowIdentity  
    {  
        Name = "MortgageWorkflow",  
        Version = new Version(1, 0, 0, 0)  
    }  
};  
  
// Add the previous version of the service to the SupportedVersions collection.  
host.SupportedVersions.Add(serviceV1);

'Create the primary version of the workflow service  
Dim serviceV2 As New WorkflowService  
With serviceV2  
    .Name = "MortgageWorkflowService"  
    .Body = New MortgageWorkflowV2  
    .DefinitionIdentity = New WorkflowIdentity With _  
    { _  
        .Name = "MortgageWorkflow", _  
        .Version = New Version(2, 0, 0, 0) _  
    }  
End With  
  
'Configure the WorkflowServiceHost with the current version  
'of the workflow service. This code requires Administrator  
'privileges to function correctly. If running from Visual  
'Studio, Visual Studio must be run with Administrator privileges.  
  
Dim host As New WorkflowServiceHost(serviceV2, _  
    New Uri("http://localhost:8080/MortgageWorkflowService"))  
  
'Create the previous version of the workflow service.  
Dim serviceV1 As New WorkflowService  
With serviceV1  
    .Name = "MortgageWorkflowService"  
    .Body = New MortgageWorkflowV1  
    .DefinitionIdentity = New WorkflowIdentity With _  
    { _  
        .Name = "MortgageWorkflow", _  
        .Version = New Version(1, 0, 0, 0) _  
    }  
End With  
  
'Add the previous version of the service to the SupportedVersions collection.  
host.SupportedVersions.Add(serviceV1)