Workflow Core：轻量级.NET工作流引擎完全指南

Workflow Core是一个轻量级、可嵌入的工作流引擎，专为.NET Standard设计，适用于需要跟踪状态的长期运行过程。它提供了灵活的工作流定义方式，支持多种持久化方案，是构建复杂业务流程的理想选择。

核心概念解析

步骤（Steps）

工作流由一系列连接的步骤组成。每个步骤可以有输入并产生输出，这些输出可以在其所在的工作流内传递回工作流。

步骤通过创建继承自StepBody或StepBodyAsync抽象类的类来定义，并实现Run/RunAsync方法。也可以在定义工作流结构时内联创建。

工作流定义

工作流结构通过实现IWorkflow接口来定义，该接口包含只读的Id属性和Version属性。工作流主机使用这些属性来识别工作流定义。

快速入门指南

定义基本步骤

首先创建一个简单的步骤类：

public class HelloWorld : StepBody
{
    public override ExecutionResult Run(IStepExecutionContext context)
    {
        Console.WriteLine("Hello world");
        return ExecutionResult.Next();
    }
}

构建工作流

然后通过组合步骤链来定义工作流结构：

public class HelloWorldWorkflow : IWorkflow
{
    public string Id => "HelloWorld";
    public int Version => 1;

    public void Build(IWorkflowBuilder<object> builder)
    {
        builder
            .StartWith<HelloWorld>()
            .Then<GoodbyeWorld>();
    }  
}

配置工作流主机

使用AddWorkflow扩展方法为IServiceCollection配置工作流主机：

services.AddWorkflow();

启动工作流

当应用程序启动时，从内置依赖注入框架获取工作流主机，调用RegisterWorkflow注册工作流，然后调用Start()启动执行工作流的线程池：

var host = serviceProvider.GetService<IWorkflowHost>();            
host.RegisterWorkflow<HelloWorldWorkflow>();
host.Start();

host.StartWorkflow("HelloWorld", 1, null);

Console.ReadLine();
host.Stop();

数据传递机制

每个步骤都设计为黑盒，因此它们支持输入和输出。这些输入和输出可以映射到定义每个工作流实例相关自定义数据的数据类。

带输入输出的步骤示例

// 带有输入和输出的工作流步骤
public class AddNumbers : StepBody
{
    public int Input1 { get; set; }
    public int Input2 { get; set; }
    public int Output { get; set; }

    public override ExecutionResult Run(IStepExecutionContext context)
    {
        Output = (Input1 + Input2);
        return ExecutionResult.Next();
    }
}

// 定义工作流内部数据的类
public class MyDataClass
{
    public int Value1 { get; set; }
    public int Value2 { get; set; }
    public int Answer { get; set; }
}

// 具有强类型内部数据和映射输入输出的工作流定义
public class PassingDataWorkflow : IWorkflow<MyDataClass>
{  
    public void Build(IWorkflowBuilder<MyDataClass> builder)
    {
        builder            
            .StartWith<AddNumbers>()
                .Input(step => step.Input1, data => data.Value1)
                .Input(step => step.Input2, data => data.Value2)
                .Output(data => data.Answer, step => step.Output)
            .Then<CustomMessage>()
                .Input(step => step.Message, data => "The answer is " + data.Answer.ToString());
    }
    ...
}

依赖注入支持

如果将步骤类注册到IoC容器，工作流主机将使用IoC容器来构造它们，从而注入任何所需的依赖项。

依赖注入示例

// 服务接口
public interface IMyService
{
    void DoTheThings();
}

// 服务实现
public class MyService : IMyService
{
    public void DoTheThings()
    {
        Console.WriteLine("Doing stuff...");
    }
}

// 使用依赖注入的工作流步骤
public class DoSomething : StepBody
{
    private IMyService _myService;

    public DoSomething(IMyService myService)
    {
        _myService = myService;
    }

    public override ExecutionResult Run(IStepExecutionContext context)
    {
        _myService.DoTheThings();
        return ExecutionResult.Next();
    }
}

持久化支持

由于工作流通常是长时间运行的进程，它们需要在步骤之间持久化到存储中。有多个持久化提供程序可用作单独的Nuget包。

支持的持久化提供程序

• MemoryPersistenceProvider（默认提供程序，用于演示和测试目的）
• MongoDB
• Cosmos DB
• Amazon DynamoDB
• SQL Server
• PostgreSQL
• Sqlite
• MySQL
• Redis
• Oracle

性能表现

Workflow Core经过优化，能够在大量并发场景下保持良好的性能。以下图表展示了其性能表现：

实际应用场景

新用户工作流

public class MyData
{
    public string Email { get; set; }
    public string Password { get; set; }
    public string UserId { get; set; }
}

public class MyWorkflow : IWorkflow
{
    public void Build(IWorkflowBuilder<MyData> builder)
    {    
        builder
            .StartWith<CreateUser>()
                .Input(step => step.Email, data => data.Email)
                .Input(step => step.Password, data => data.Password)
                .Output(data => data.UserId, step => step.UserId)
           .Then<SendConfirmationEmail>()
               .WaitFor("confirmation", data => data.UserId)
           .Then<UpdateUser>()
               .Input(step => step.UserId, data => data.UserId);
    }
}

Saga事务

public class MyWorkflow : IWorkflow
{
    public void Build(IWorkflowBuilder<MyData> builder)
    {    
        builder
            .StartWith<CreateCustomer>()
            .Then<PushToSalesforce>()
                .OnError(WorkflowErrorHandling.Retry, TimeSpan.FromMinutes(10))
            .Then<PushToERP>()
                .OnError(WorkflowErrorHandling.Retry, TimeSpan.FromMinutes(10));
    }
}

示例项目

项目提供了丰富的示例代码，包括：

• Hello World示例（src/samples/WorkflowCore.Sample01）
• 多结果示例（src/samples/WorkflowCore.Sample12）
• 数据传递示例（src/samples/WorkflowCore.Sample03）
• 并行ForEach示例（src/samples/WorkflowCore.Sample09）
• While循环示例（src/samples/WorkflowCore.Sample10）
• If语句示例（src/samples/WorkflowCore.Sample11）
• 事件示例（src/samples/WorkflowCore.Sample04）

总结

Workflow Core以其强大的功能和优秀的扩展性，为.NET开发者提供了一个灵活的工作流解决方案。无论你是新手还是经验丰富的开发者，都可以利用它来提升业务流程管理水平。其轻量级设计、丰富的持久化选项和活跃的社区支持，使其成为构建企业级工作流应用的理想选择。