Elsa Workflows 3.x 中使用C后端启动工作流的方法

在Elsa Workflows 3.x版本中，开发者经常需要从后端代码启动工作流实例。与2.x版本不同，3.x版本提供了更加简洁和直观的API来实现这一功能。

核心接口 IWorkflowRuntime

Elsa 3.x引入了IWorkflowRuntime接口，这是启动工作流的主要入口点。该接口提供了多种方法来启动工作流实例，比2.x版本中的WorkflowLaunchpad服务更加直观易用。

基本使用方法

要启动一个工作流实例，首先需要注入IWorkflowRuntime服务：

private readonly IWorkflowRuntime _workflowRuntime;

public MyService(IWorkflowRuntime workflowRuntime)
{
    _workflowRuntime = workflowRuntime;
}

然后可以使用以下方法启动工作流：

// 通过定义ID启动工作流
var result = await _workflowRuntime.StartWorkflowAsync(
    workflowDefinitionId: "your-workflow-definition-id",
    correlationId: "optional-correlation-id",
    input: new { Property1 = "Value1", Property2 = 123 });

方法参数说明

StartWorkflowAsync方法有几个重要参数：

1. workflowDefinitionId: 必需参数，指定要启动的工作流定义ID
2. correlationId: 可选参数，用于关联多个工作流实例
3. input: 可选参数，可以传递任意对象作为工作流的输入数据

返回值处理

方法返回一个StartWorkflowResult对象，包含以下有用属性：

• WorkflowInstanceId: 新创建的工作流实例ID
• Status: 工作流实例的当前状态
• SubStatus: 工作流实例的子状态
• Bookmarks: 如果工作流暂停，会包含书签信息

高级用法

除了基本启动方法外，IWorkflowRuntime还提供了其他有用的方法：

// 通过定义版本ID启动特定版本的工作流
await _workflowRuntime.StartWorkflowByDefinitionVersionIdAsync(...);

// 启动并等待工作流完成
await _workflowRuntime.RunWorkflowUntilEndAsync(...);

最佳实践

1. 总是检查返回结果的状态，确保工作流按预期启动
2. 对于长时间运行的工作流，考虑使用correlationId来跟踪相关实例
3. 合理设计输入对象的结构，便于在工作流活动中使用
4. 在生产环境中添加适当的错误处理和日志记录

通过使用IWorkflowRuntime接口，Elsa 3.x使得从后端代码启动工作流变得更加简单和直观，大大提高了开发效率。