microwf 开源项目教程

1. 项目介绍

microwf 是一个简单的有限状态机（FSM）项目，具有工作流特性，允许用户在代码中定义工作流。该项目旨在帮助开发者轻松创建和管理复杂的工作流，适用于各种应用场景，如审批流程、状态管理等。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保您的开发环境已安装以下工具：

• .NET Core SDK
• Node.js
• Visual Studio Code（推荐）

2.2 下载项目

首先，克隆 microwf 项目到本地：

git clone https://github.com/thomasduft/microwf.git
cd microwf

2.3 构建项目

在项目根目录下，打开终端并运行以下命令来构建项目：

dotnet build

2.4 运行 WebApi 后端

在 Visual Studio Code 中，按 F5 或转到调试选项卡（Ctrl+Shift+D）并运行 WebApi 项目。项目启动后，打开浏览器并访问 https://localhost:5001，您将看到登录界面。

2.5 开发模式

为了方便开发，项目提供了一个名为 dev:be-fe 的复合任务，可以同时启动 WebApi 和 Angular 前端项目：

npm run dev:be-fe

3. 应用案例和最佳实践

3.1 假期审批工作流

microwf 提供了一个假期审批的示例工作流。以下是该工作流的代码示例：

public class HolidayApprovalWorkflow : WorkflowDefinitionBase
{
    public override string Type => nameof(HolidayApprovalWorkflow);

    public override List<Transition> Transitions
    {
        get
        {
            return new List<Transition>
            {
                new Transition
                {
                    State = "New",
                    Trigger = "Apply",
                    TargetState = "Applied",
                    CanMakeTransition = MeApplyingForHolidays
                },
                new Transition
                {
                    State = "Applied",
                    Trigger = "Approve",
                    TargetState = "Approved",
                    CanMakeTransition = BossIsApproving,
                    AfterTransition = ThankBossForApproving
                },
                new Transition
                {
                    State = "Applied",
                    Trigger = "Reject",
                    TargetState = "Rejected"
                }
            };
        }
    }

    private bool MeApplyingForHolidays(TransitionContext context)
    {
        var holiday = context.GetInstance<Holiday>();
        return holiday.Me == "Me";
    }

    private bool BossIsApproving(TransitionContext context)
    {
        var holiday = context.GetInstance<Holiday>();
        return holiday.Boss == "NiceBoss";
    }

    private void ThankBossForApproving(TransitionContext context)
    {
        // SendMail("Thank you");
    }
}

3.2 最佳实践

• 状态和触发器命名：使用有意义的名称来定义状态和触发器，以便于理解和维护。
• 条件和动作：在定义转换时，确保 CanMakeTransition 和 AfterTransition 方法清晰且易于测试。

4. 典型生态项目

4.1 ASP.NET Core

microwf 与 ASP.NET Core 紧密集成，适用于构建基于 Web 的工作流管理系统。

4.2 Angular

项目的前端部分使用 Angular 框架，提供了丰富的用户界面来管理工作流实例。

4.3 .NET Core

作为 .NET Core 项目，microwf 可以轻松集成到现有的 .NET Core 应用中，提供强大的工作流管理功能。

通过以上步骤，您可以快速上手并使用 microwf 项目，构建和管理复杂的工作流系统。