Workflow Core项目中使用SQL持久化时的工作流执行问题解析

问题背景

在使用Workflow Core框架开发工作流应用时，开发者可能会遇到从内存持久化切换到SQL Server持久化后工作流步骤不执行的问题。本文将以一个实际案例为基础，深入分析这类问题的成因和解决方案。

典型场景描述

开发者创建了一个包含三个步骤的工作流：

public class FinishedProductWorkflow : IWorkflow<FinishedProductWorkflowData>
{
    public string Id => "FinishedProductWorkflow";
    public int Version => 1;

    public void Build(IWorkflowBuilder<FinishedProductWorkflowData> builder)
    {
        builder.StartWith<CreateFinishedProduct>()
            .Then<UpdateFinishedProductTraceability>()
            .Then<PublishFinishedProduct>()
            .EndWorkflow();
    }
}

每个步骤都实现了IStepBody接口，例如：

public class PublishFinishedProduct : IStepBody
{
    public async Task<ExecutionResult> RunAsync(IStepExecutionContext context)
    {
        var data = context.Workflow.Data as FinishedProductWorkflowData;
        // 业务逻辑
        return ExecutionResult.Next();
    }
}

问题现象

当从默认的内存持久化切换到SQL Server持久化时：

services.AddWorkflow(cfg =>
{
    cfg.UseSqlServer(connectionString, true, true);
});

虽然数据库表被正确创建，工作流实例也能在数据库中看到记录，但工作流步骤却无法执行。具体表现为：

1. Workflow表中有数据记录
2. ExecutionPointer表中有指向第一个步骤的记录
3. ExecutionError表为空
4. 无法通过调试进入步骤代码

根本原因分析

经过深入排查，发现问题出在工作流数据模型的序列化上。当使用SQL持久化时，Workflow Core需要将工作流数据序列化存储到数据库中。案例中的工作流数据类包含了一个复杂对象：

public class FinishedProductWorkflowData
{
    public FinishedProduct FinishedProduct { get; set; }
    public Guid FinishedProductId { get; set; }
    public Guid TraceabilityBlockId { get; set; }
}

而其中的FinishedProduct类缺少默认构造函数，导致在反序列化时无法正确重建对象实例。

解决方案

为复杂对象添加默认构造函数即可解决问题：

public class FinishedProduct
{
    // 添加默认构造函数
    private FinishedProduct() {}
    
    // 原有构造函数和其他成员
}

技术要点总结

1. 持久化机制差异：内存持久化直接保存对象引用，而SQL持久化需要序列化/反序列化过程

2. 序列化要求：被序列化的类及其所有嵌套属性都必须满足序列化要求，包括：

   • 具有可访问的默认构造函数
   • 属性具有可读可写的访问器
   • 避免循环引用

3. 调试技巧：当工作流步骤不执行时，可以检查：

   • 数据库中的工作流状态
   • 数据字段是否完整保存
   • 反序列化时是否有异常抛出

最佳实践建议

1. 为工作流数据模型及其所有嵌套类提供默认构造函数
2. 考虑使用简单的DTO作为工作流数据，避免复杂的对象图
3. 在切换到SQL持久化前，先验证所有数据模型的可序列化性
4. 实现自定义的序列化器（如JSON.NET）来处理特殊场景

通过理解Workflow Core的持久化机制和数据序列化要求，开发者可以避免这类问题，确保工作流在各种持久化方式下都能可靠执行。