Easy Work-简单、易用、傻瓜式的 Java 流程引擎Easy Work 是一个用于 Java 的工作流引擎。它提

Easy Work 是什么?

Easy Work 是一个用于 Java 的工作流引擎。它提供了简洁的 API 和构建模块，便于创建和运行可组合的工作流。

在Easy Work中，工作单元由Work接口表示，工作流则由WorkFlow接口表示。Easy Work 提供了 WorkFlow 接口的6种实现方式：

这些是使用Easy Work创建工作流时所需了解的唯一基本流程。

你无需学习复杂的符号或概念，只需掌握几个易于理解的自然API即可。

如何使用？

首先，让我们创建一个 Work:

public class PrintMessageWork implements Work {

    private final String message;

    public PrintMessageWork(String message) {
        this.message = message;
    }

    @Override
    public String execute(WorkContext workContext) {
        System.out.println(message);
        return message;
    }
}

此 Work 将指定消息打印至标准输出。现在假设我们想要创建如下工作流程：

打印 a 三次
顺序打印 b c d
并行执行 e f
如果并行执行的结果成功，执行 g, 否则执行 h
最后执行 z

此工作流程说明如下：

flow1 是一个打印 a 的 RepeatFlow，连续执行三次
flow2 是一个依次打印 b c d 的 SequentialFlow，按照顺序依次执行
flow3 是一个并行打印 e f 的 ParallelFlow，同时执行
flow4 是一个基于条件判断的 ConditionalFlow，首先执行flow3，如果执行成功（状态为 COMPLETE）则执行 g，否则执行 h
flow5 是一个顺序执行流程 SequentialFlow，保证顺序执行 flow1 flow2 flow4，最后执行 z

使用Easy Work，此工作流可以通过以下代码段实现：

PrintMessageWork a = new PrintMessageWork("a");
PrintMessageWork b = new PrintMessageWork("b");
PrintMessageWork c = new PrintMessageWork("c");
PrintMessageWork d = new PrintMessageWork("d");
PrintMessageWork e = new PrintMessageWork("e");
PrintMessageWork f = new PrintMessageWork("f");
PrintMessageWork g = new PrintMessageWork("g");
PrintMessageWork h = new PrintMessageWork("h");
PrintMessageWork z = new PrintMessageWork("z");

WorkFlow flow = aNewSequentialFlow(
    aNewRepeatFlow(a).times(3),
    aNewSequentialFlow(b,c,d),
    aNewConditionalFlow(
        aNewParallelFlow(e,f).withAutoShutDown(true)
    ).when(
        WorkReportPredicate.COMPLETED,
        g,
        h
    ),
    z
);
aNewWorkFlowEngine().run(flow, new WorkContext());

暂停工作流

从 v1.0.5开始 EasyWork工作流支持 断点，通过断点 你可以暂停执行工作流，做一些其他事情然后恢复执行工作流。

你可以在工作流的任何位置配置断点。

例如，你可以将断点设置在c工作单元上，然后恢复执行。

此工作流说明如下：

此工作流可以通过以下代码段实现：

SequentialFlow flow = aNewSequentialFlow(
    aNewRepeatFlow(a).times(3),
    aNewSequentialFlow(b,aNamePointWork(c).point("C_BREAK_POINT"),d),
    aNewConditionalFlow(
        aNewParallelFlow(e,f).withAutoShutDown(true)
    ).when(
        WorkReportPredicate.COMPLETED,
        g,
        h
    ),
    z
);
//执行到该断点并暂停
flow.execute("C_BREAK_POINT");
System.out.println("execute to the break point `C_BREAK_POINT`");
//从断点处继续执行，直到完成
flow.execute();

这不是一个非常有用的工作流，只是为了让你了解如何使用Easy Work而编写工作流。

JSON构建工作流

从 V1.0.8开始 EasyWork工作流支持基于 JSON 的构建，你可以通过 JSON 的方式构建任意复杂的工作流。基于以上图示中的例子，通过 JSON 构建工作流的片段为(example.json)：

{
  "type": "sequential",
  "works": [{
    "type": "repeat",
    "times": 3,
    "work": {
      "type": "work.PrintMessageWork",
      "message": "a"
    }
  },{
    "type": "sequential",
    "works": [{
      "type": "work.PrintMessageWork",
      "message": "b"
    },{
      "type": "work.PrintMessageWork",
      "message": "c"
    },{
      "type": "work.PrintMessageWork",
      "message": "d"
    }]
  },{
      "type": "conditional",
      "decide": {
        "type": "parallel",
        "autoShutdown": true,
        "works": [{
          "type": "work.PrintMessageWork",
          "message": "e"
        },{
          "type": "work.PrintMessageWork",
          "message": "f"
        }]
      },
      "predicate": {
        "left" : "$status",
        "operator": "eq",
        "right": "COMPLETED"
      },
      "trueWork": {
        "type": "work.PrintMessageWork",
        "message": "g"
      },
      "falseWork": {
        "type": "work.PrintMessageWork",
        "message": "h"
      }
  }],
  "then": {
    "type": "work.PrintMessageWork",
    "message": "z"
  }
}

你可以通过以下代码反序列化工作流，并进行执行（更多例子请参考test/java/DeserializeTest)

String json = ResourceReader.readJSON("json/example.json");
SequentialFlow sequentialFlow = (SequentialFlow) deserialize(json);
sequentialFlow.execute(new WorkContext());

序列化为 JSON

从 V1.0.9 开始 EasyWork 支持序列化为 JSON, 你可以在构建完工作流后，通过serialize()方法序列化为 JSON. 根据上图所示的示例，您可以使用以下代码序列化为JSON（有关更多示例，请参阅test/java/serializeTest）：

String json = ResourceReader.readJSON("json/example.json");
SequentialFlow sequentialFlow = (SequentialFlow) deserialize(json);
System.out.println(sequentialFlow.serialize());

丰富的条件断言

EasyWork内置了丰富的 Predicate 断言，帮助你更快速、简单的构建条件工作流，对于复杂的嵌套的条件工作流同样变得简单，以下代码为一个构建条件工作流的例子：

PrintMessageWork ageEqualTen = new PrintMessageWork("age equal than 10");
PrintMessageWork ageLessThanTen = new PrintMessageWork("age less than 10");
UserPrintWork userWork = new UserPrintWork(new User().setAge(15).setName("john"));
aNewConditionalFlow(userWork)
  .when(
     andPredicate( 
     //可以直接通过方法引用的方式来构建断言
     aNewEqPredicate(WorkReport::getStatus, "COMPLETED"),
     //可以直接通过表达式的方式 进行结果属性级联 workReport->result->age
     aNewGreaterEqualPredicate("$result.$age",10),
     //也可以通过表达式加方法引用方式构建 workReport->result
     aNewEqPredicate("$result",User::getName, "john")
   ),    
   ageEqualTen,
   ageLessThanTen
 ).execute(new WorkContext());

你可以在 test/java 中查看更多的测试用例。

更详细的信息，请参考 EasyWork

Easy Work-简单、易用、傻瓜式的 Java 流程引擎