Elsa Core 3.1.1版本中变更计划(Alteration Plans)的更新与使用指南

在Elsa Core 3.1.1版本中，变更计划(Alteration Plans)的API接口发生了一些重要变化。本文将为开发者详细介绍这些变更以及如何在新版本中正确使用变更计划功能。

变更计划接口的演进

在早期版本中，开发者使用NewAlterationPlan类来创建变更计划。但在3.1.1版本中，这个类已被移除，取而代之的是全新的AlterationPlanParams类。这一变化反映了Elsa Core对API设计的优化和改进。

新版变更计划的结构

新版变更计划采用JSON格式定义，主要包含两个关键部分：

1. 变更操作(alterations): 定义要执行的具体变更操作
2. 过滤器(filter): 指定这些变更将应用于哪些工作流实例

一个典型的变更计划JSON示例如下：

{
    "alterations": [
        {
            "type": "Migrate",
            "targetVersion": 9
        },
        {
            "type": "ScheduleActivity",
            "activityId": "ccf52939c64d66d"
        }
    ],
    "filter": {
        "workflowInstanceIds": [
            "9e10ae74f99fe60a"
        ]
    }
}

变更操作类型详解

目前支持的变更操作类型包括：

1. 迁移操作(Migrate):

   • 用于将工作流迁移到指定版本
   • 必须指定targetVersion参数

2. 调度活动(ScheduleActivity):

   • 用于调度特定活动的执行
   • 需要指定activityId参数

过滤器配置

过滤器用于精确控制变更计划的应用范围，当前支持通过工作流实例ID进行筛选：

"filter": {
    "workflowInstanceIds": [
        "实例ID1",
        "实例ID2"
    ]
}

最佳实践建议

1. 版本兼容性: 在使用Migrate操作时，确保目标版本与当前系统兼容
2. 操作顺序: 合理安排alterations数组中的操作顺序，确保依赖关系正确
3. 测试验证: 在生产环境应用前，先在测试环境验证变更计划的效果
4. 权限控制: 确保只有授权用户才能提交变更计划

总结

Elsa Core 3.1.1对变更计划接口进行了重构，提供了更加清晰和灵活的设计。开发者现在可以通过AlterationPlanParams类来定义变更计划，使用JSON格式来配置具体的变更操作和应用范围。这一改进使得工作流的管理和维护变得更加便捷和高效。

对于从旧版本升级的用户，建议仔细检查并更新所有使用变更计划的代码，确保与新API兼容。随着Elsa Core的持续发展，我们可以期待未来版本会引入更多类型的变更操作和更强大的过滤条件。