C# .NET 6 使用WorkFlow Core 创建工作审批流

谢楷锋

1，背景

　　工作流思想在上世纪60年代就有人提出过；70年代就有人开始尝试，但是由于当时许多的限制，工作流一直没有成功的被实现；80年代才出现第一批成功的工作流系统；90年代工作流技术走向了第一个发展高峰期；90年代后至今工作流出现了很多版本，但是主旨还是不变的，为了使我们的工作变得更加高效。
　　通俗点，我们经常使用的OA系统上。关于一个材料的申报，又或者个人的请假。这些流程就属于工作流（工作审批流）。其中对于审批人和各个节点是可以动态操作的。
　　工作流可以通过数据库设计的形式实现，也可以使用第三方的框架Elsa,Workflow Core。本文使用第二种，并详细的介绍一下代码实现和json实现工作流程。
2，安装

　　使用Nuget包管理工具安装以下的包：　　
　　　　Workflow Core 3.10.0　　　　　　　　　　核心包不解释
　　　　WorkflowCore.DSL 3.10.0　　　　　　　　json或者yaml注入需要
　　　　WorkflowCore.Persistence.MySQL　　　　持久化
3，文档

　　JSON / YAML Definitions - Workflow Core (workflow-core.readthedocs.io)
 
　　WorkFlowCore 加载Json文件 - 编程代码 (cscoder.cn)
 
4，例子

1，创建项目

　　控制台或者WebApi项目均可，这里拿WebApi项目举例。（版本用的是.net 6）
2，添加工步

　　工步文件需要继承StepBody。现在添加一个Hello.cs和Goodbye的工步，代码如下:

1. using WorkflowCore.Interface;
2. using WorkflowCore.Models;
4. namespace WorkFlowCore_Test.WorkFlows.HelloWord.Steps
5. {
6.     public class Hello : StepBody
7.     {
8.         public override ExecutionResult Run(IStepExecutionContext context)
9.         {
10.             Console.WriteLine("Hello World!");
11.             return ExecutionResult.Next();
12.         }
13.     }
14. }

复制代码

 

1. using WorkflowCore.Interface;
2. using WorkflowCore.Models;
4. namespace WorkFlowCore_Test.WorkFlows.HelloWord.Steps
5. {
6.     public class Goodbye : StepBody
7.     {
8.         public override ExecutionResult Run(IStepExecutionContext context)
9.         {
10.             Console.WriteLine("Goodbye World!");
11.             return ExecutionResult.Next();
12.         }
13.     }
14. }

复制代码

3，添加工作流文件

　　工作流文件需要继承IWorkflow。现在开始添加：

1. using WorkflowCore.Interface;
2. using WorkFlowCore_Test.WorkFlows.HelloWord.Steps;
4. namespace WorkFlowCore_Test.WorkFlows.HelloWord
5. {
6.     public class HelloWorldWorkflow : IWorkflow
7.     {
8.         public string Id => "HelloWorld";
10.         public int Version => 1;
12.         public void Build(IWorkflowBuilder<object> builder)
13.         {
14.             builder
15.                 .StartWith<Hello>()
16.                 .Then<Goodbye>();
17.         }
18.     }
19. }

复制代码

4，配置和启动

　　基本数据都准备好了之后，在项目启动文件进行一下配置。代码如下：

1. using Microsoft.AspNetCore.Mvc;
2. using System.Xml.Linq;
3. using WorkflowCore.Interface;
4. using WorkflowCore.Services;
5. using WorkflowCore.Services.DefinitionStorage;
6. using WorkFlowCore_Test.Utils;
7. using WorkFlowCore_Test.WorkFlows.AskForLeave.Model;
8. using WorkFlowCore_Test.WorkFlows.AskForLeave;
9. using WorkFlowCore_Test.WorkFlows.HelloWord;
10. using WorkFlowCore_Test.WorkFlows.IfStatement;
11. using WorkFlowCore_Test.WorkFlows.IfStatement.Model;
12. using WorkFlowCore_Test.WorkFlows.Json.Steps;
13. using WorkFlowCore_Test.WorkFlows.SimpleDecision;
15. namespace WorkFlowCore_Test
16. {
17.     public class Program
18.     {
19.         public static void Main(string[] args)
20.         {
21.             var builder = WebApplication.CreateBuilder(args);
22.             // Add services to the container.
23.             builder.Services.AddAuthorization();
24.             builder.Services.AddControllers();
25.             builder.Services.AddLogging(); // WorkflowCore需要用到logging service
26.             //持久化
27.             builder.Services.AddWorkflow(cfg =>
28.             {
29.                 cfg.UseMySQL("server=127.0.0.1;Database=Workflow;Uid=root;Pwd=xunpai123.", true, true);
30.             });
31.             builder.Services.AddWorkflowDSL();//用来注入json和yaml
33.             var app = builder.Build();
35.             //核心注入方法
36.             UseWorkflow(app);
38.             app.UseAuthorization();
39.             app.MapControllers();
40.             app.Run();
41.         }
44.         public static void UseWorkflow(WebApplication app)
45.         {
46.             var host = app.Services.GetService<IWorkflowHost>();
48.             #region 工步注册
49.             //c#代码注册
50.             host?.RegisterWorkflow<HelloWorldWorkflow>();
51.             //json注册
52.             #endregion
54.             host?.Start();
55.             // 通过DI获取IHostApplicationLifetime实例
56.             var applicationLifetime = app.Services.GetService(typeof(IHostApplicationLifetime)) as IHostApplicationLifetime;
57.             applicationLifetime?.ApplicationStopping.Register(() =>
58.             {
59.                 host?.Stop();
60.             });
61.         }
64.     }
65. }

复制代码

 
　　这个时候我们添加api控制器进行调用这个helloworld的流程。代码如下：

1. using Microsoft.AspNetCore.Http;
2. using Microsoft.AspNetCore.Mvc;
3. using Microsoft.Extensions.Configuration;
4. using Microsoft.Extensions.DependencyInjection;
5. using Microsoft.Extensions.Hosting;
6. using Microsoft.Extensions.Logging;
7. using Newtonsoft.Json;
8. using Newtonsoft.Json.Linq;
9. using System;
10. using System.Diagnostics;
11. using System.Net.Http.Json;
12. using System.Text.Json.Nodes;
13. using WorkflowCore.Interface;
14. using WorkflowCore.Models;
15. using WorkflowCore.Services;
16. using WorkflowCore.Services.DefinitionStorage;
17. using WorkFlowCore_Test.Utils;
18. using WorkFlowCore_Test.WorkFlows.AskForLeave.Model;
19. using WorkFlowCore_Test.WorkFlows.SimpleDecision;
21. namespace WorkFlowCore_Test.Controllers
22. {
23.     [Route("api/[controller]")]
24.     [ApiController]
25.     public class TestApiController : ControllerBase
26.     {
27.         private IWorkflowController WorkflowService;
28.         private IWorkflowHost WorkflowHost;
29.         public TestApiController(IWorkflowController workflowService, IWorkflowHost workflowHost)
30.         {
31.             WorkflowService = workflowService;
32.             WorkflowHost = workflowHost;
33.         }
35.         [Route("WorkFlowCoreTestDemo")]
36.         [HttpGet]
37.         public string WorkFlowCoreTestDemo()
38.         {
39.             //var initialData = new LeaveRequestData
40.             //{
41.             //    RequestId = "11111",
42.             //    RequestMsg = "开始请假"
43.             //};
45.             //WorkflowHost.StartWorkflow("LeaveRequestWorkflow", 1, initialData);
47.             WorkflowService.StartWorkflow("HelloWorld");
48.             return "true";
49.         }
51.         
53.     }
54. }

复制代码

5，效果展示

　　启动后调用我们的控制器方法，然后观看console 的变化，如图：

 
6，请假单流程

　　请假单的流程创建的话需要用到等待的函数，等待管理员进行审核后进行下一步的操作。请假单的流程代码如下：

1.     public class LeaveRequestData
2.     {
3.         public string RequestId { get; set; }
4.         public bool ManagerApproved { get; set; }
5.         public bool HRApproved { get; set; }
6.         public string RequestMsg { get; set; }
7.     }

复制代码

1. using WorkflowCore.Interface;
2. using WorkFlowCore_Test.WorkFlows.AskForLeave.Model;
3. using WorkFlowCore_Test.WorkFlows.AskForLeave.Steps;
4. using WorkFlowCore_Test.WorkFlows.SimpleDecision.Steps;
6. namespace WorkFlowCore_Test.WorkFlows.AskForLeave
7. {
8.     public class AskForLeaveWorkflow : IWorkflow<LeaveRequestData>
9.     {
10.         public string Id => "LeaveRequestWorkflow";
11.         public int Version => 1;
13.         public void Build(IWorkflowBuilder<LeaveRequestData> builder)
14.         {
15.             builder.StartWith(context => Console.WriteLine("提交请假申请"))
16.                 .Activity("manage-audit", (data) => data.RequestMsg)
17.                     .Output(data => data.ManagerApproved, step => step.Result)
18.                 .Then<ManagerApprovalStep>().Input(step => step.AuditDataInfo, data => data)
19.                 .If(data => data.ManagerApproved)
20.                     .Do(then => then.StartWith(context => Console.WriteLine("经理审核")));
22.             
23.         }
24.     }
25. }

复制代码

　　然后创建好之后，在启动文件进行注册一下：

1.             host?.RegisterWorkflow<AskForLeaveWorkflow, LeaveRequestData>();

复制代码

　　好了，接下来我们就可以用接口的形式进行模拟了。首先我们新增一个接口用来模拟申请请求代码如下：

1.         [Route("WorkFlowCoreTestDemo")]
2.         [HttpGet]
3.         public string WorkFlowCoreTestDemo()
4.         {
5.             var initialData = new LeaveRequestData
6.             {
7.                 RequestId = "11111",
8.                 RequestMsg = "开始请假"
9.             };
11.             WorkflowHost.StartWorkflow("LeaveRequestWorkflow", 1, initialData);
13.             //WorkflowService.StartWorkflow("HelloWorld");
14.             return "true";
15.         }

复制代码

　　然后创建一个管理员的审批方法，用来审核通过或者拒绝。代码如下：

1.         [Route("WorkFlowCoreTestDemo4")]
2.         [HttpGet]
3.         public async Task<string> WorkFlowCoreTestDemo4()
4.         {
5.             //获取待决活动
6.             var approval = await WorkflowHost.GetPendingActivity("manage-audit", "worker1");
7.            
9.             if (approval != null)
10.             {
11.                 Console.WriteLine("需要批准的" + approval.Parameters);
12.                 //提交活动成功
13.                 await WorkflowHost.SubmitActivitySuccess(approval.Token, true);//true，代表审批通过。逻辑验证在步骤里面
14.             }
15.             return "请假工作流";
16.         }

复制代码

　　好了，这样就形成闭环了。大家可以在postman上请求测试一下，观察console的变化了。
7，json注入

　　最后就是json注入的方式了，这种方式也是目前我比较倾向的方式，和前端对接就很方便的。前端按照固定的格式给后端传入json数据，后端根据json数据解析工步进行开启工作流。
　　首先需要创建一个json文件，json文件代码如下：

1. {
2.   "Id": "HelloWorldJson",
3.   "Version": 1,
4.   "Steps": [
5.     {
6.       "Id": "Hello",
7.       "StepType": "",
8.       "NextStepId": "Bye"
9.     },
10.     {
11.       "Id": "Bye",
12.       "StepType": ""
14.     }
15.   ]
16. }

复制代码

　　然后在启动文件配置，注入一下json工作流：

1. //json注册
2. var loader = app.Services.GetService<IDefinitionLoader>();     
3. var json = System.IO.File.ReadAllText("WorkFlows/Json/JsonYaml.json");// 假设文件位于程序运行目录
4. // 【json注入时候，stepType写这个程序集的类名】获取并打印全限定名，包括程序集名称
5. //Type myClassType = typeof(HelloWorldStep);
6. //string fullAssemblyClassName = myClassType.AssemblyQualifiedName;
7. loader?.LoadDefinition(json, Deserializers.Json);

复制代码

　　到这里就可以了，创建一个api方法来调用看看：

1.         [Route("WorkFlowCoreTestDemo6")]
2.         [HttpGet]
3.         public string WorkFlowCoreTestDemo6()
4.         {
5.             WorkflowHost.StartWorkflow("HelloWorldJson", 1, null);
6.             return "";
7.         }

复制代码

　　到这里就可以实现json注入工作流了。不过细心的朋友就发现了，我给的json文件中的step的type为什么是空的呢？是因为StepType取的是项目程序集工步的类名称，因为我的电脑项目和你们的项目不一样，所以这里没有写。大家可以自行百度搜搜看，我这里还是放一下我的json例子吧。

1. {
2.   "Id": "HelloWorldJson",
3.   "Version": 1,
4.   "Steps": [
5.     {
6.       "Id": "Hello",
7.       "StepType": "WorkFlowCore_Test.WorkFlows.Json.Steps.HelloWorldStep, WorkFlowCore-Test, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
8.       "NextStepId": "Bye"
9.     },
10.     {
11.       "Id": "Bye",
12.       "StepType": "WorkFlowCore_Test.WorkFlows.Json.Steps.HelloWorldStep, WorkFlowCore-Test, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
14.     }
15.   ]
16. }

复制代码

 
5，结语

　　例子备注写的比较多，就不多赘述了。有问题的话就留言吧，感谢观看~

来源:https://www.cnblogs.com/BFMC/p/18233359
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！