Merge pull request #51 from codingapi/dev

Dev

Author: xlorne

designs/groovy-script/DESiGN.md

@@ -0,0 +1,43 @@
+# Groovy Script 脚本设计规范
+
+## 脚本的实例写法如下
+```
+def run(request){
+    return "Hello, ${request.name}!"
+}
+```
+
+## 脚本规范
+request对象，根据脚本的不同，起传递的request对象也不同。
+return语句，return语句根据脚本的不同，起返回的对象也不同。
+
+## 开发规范
+为了让脚本可以更好的呈现和使用，脚本的配置分为两种模式，一种是可视化配置模式，一种是代码配置模式。
+
+* 代码配置模式
+  代码配置模式的脚本中，将会通过注释的方式添加一行@CUSTOM_SCRIPT，来标识这是一个自定义脚本，这样在编辑器中就会以代码的形式展示出来。
+```
+// @CUSTOM_SCRIPT
+def run(request){
+    return "Hello, ${request.name}!"
+}
+```
+
+* 可视化配置模式
+  可视化配置模式的脚本中，没有@CUSTOM_SCRIPT的注释标识，这样在编辑器中就会以可视化的形式展示出来。
+```
+def run(request){
+    return "Hello, ${request.name}!"
+}
+```
+
+## 脚本展示标题
+为了让脚本在在展示时可以更好的展示脚本的作用，所以在脚本中支持通过@SCRIPT_TITLE的注释来标识脚本的展示标题，这样在编辑器中就会以这个标题来展示脚本。
+
+```
+// @SCRIPT_TITLE 这是一个示例脚本
+def run(request){
+    return "Hello, ${request.name}!"
+}
+```
+上述的脚本在编辑器中就会以“这是一个示例脚本”来展示，而不是以代码的方式来展示。

flow-engine-framework/src/main/java/com/codingapi/flow/script/node/ConditionScript.java

@@ -9,7 +9,12 @@
 @AllArgsConstructor
 public class ConditionScript {
 
-    public static final String SCRIPT_DEFAULT = "def run(request){return true}";
+    public static final String SCRIPT_DEFAULT = """
+            // @SCRIPT_TITLE 默认条件（允许执行）
+            def run(request){
+                return true;
+            }
+            """;
 
     @Getter
     private final String script;

flow-engine-framework/src/main/java/com/codingapi/flow/script/node/ErrorTriggerScript.java

@@ -13,9 +13,19 @@
 public class ErrorTriggerScript {
 
 
-    public static final String SCRIPT_NODE_DEFAULT = "def run(request){ return $bind.createErrorThrow(request.getStartNode()); }";
-
-    public static final String SCRIPT_OPERATOR_DEFAULT = "def run(request){ return $bind.createErrorThrow(request.getCreatedOperator()); }";
+    public static final String SCRIPT_NODE_DEFAULT = """
+            // @SCRIPT_TITLE 回退至开始节点 
+            def run(request){ 
+                return $bind.createErrorThrow(request.getStartNode());
+            }
+            """;
+
+    public static final String SCRIPT_OPERATOR_DEFAULT = """
+            // @SCRIPT_TITLE 指定用户到流程发起者 
+            def run(request){ 
+                return $bind.createErrorThrow(request.getCreatedOperator());
+            }
+            """;
 
     @Getter
     private final String script;

flow-engine-framework/src/main/java/com/codingapi/flow/script/node/NodeTitleScript.java

@@ -12,7 +12,12 @@
 @AllArgsConstructor
 public class NodeTitleScript {
 
-    public static final String SCRIPT_DEFAULT = "def run(request){return '你有一条待办'}";
+    public static final String SCRIPT_DEFAULT = """
+            // @SCRIPT_TITLE 你有一条待办 
+            def run(request){
+                return '你有一条待办'
+            }
+            """;
 
     @Getter
     private final String script;

flow-engine-framework/src/main/java/com/codingapi/flow/script/node/OperatorLoadScript.java

@@ -15,7 +15,12 @@
 @AllArgsConstructor
 public class OperatorLoadScript {
 
-    public static final String SCRIPT_CREATOR = "def run(request){return [request.getCreatedOperator()]}";
+    public static final String SCRIPT_CREATOR = """
+            // @SCRIPT_TITLE 流程创建者 
+            def run(request){
+                return [request.getCreatedOperator()]
+            }
+            """;
 
     @Getter
     private final String script;

flow-engine-framework/src/main/java/com/codingapi/flow/script/node/OperatorMatchScript.java

@@ -11,7 +11,12 @@
 @AllArgsConstructor
 public class OperatorMatchScript {
 
-    public static final String SCRIPT_ANY = "def run(operator){return true}";
+    public static final String SCRIPT_ANY = """
+            // @SCRIPT_TITLE 任意用户 
+            def run(request){
+                return true
+            }
+            """;
 
     @Getter
     private final String script;

flow-engine-framework/src/main/java/com/codingapi/flow/script/node/RouterNodeScript.java

@@ -6,13 +6,13 @@
 import lombok.Getter;
 
 /**
- * 异常触发脚本
+ * 路由触发脚本
  */
 @AllArgsConstructor
 public class RouterNodeScript {
 
-
     public static final String SCRIPT_NODE_DEFAULT = """
+            // @SCRIPT_TITLE 发起节点 
             def run(request){
                 return request.getStartNode().getId();
             }

flow-engine-framework/src/main/java/com/codingapi/flow/script/node/SubProcessScript.java

@@ -13,7 +13,12 @@
 @AllArgsConstructor
 public class SubProcessScript {
 
-    public static final String SCRIPT_DEFAULT = "def run(session){ return session.toCreateRequest() }";
+    public static final String SCRIPT_DEFAULT = """
+            // @SCRIPT_TITLE 创建当前流程 
+            def run(request){ 
+                return request.toCreateRequest() 
+            }
+            """;
 
     @Getter
     private final String script;

flow-engine-framework/src/main/java/com/codingapi/flow/script/node/TriggerScript.java

@@ -11,7 +11,12 @@
 @AllArgsConstructor
 public class TriggerScript {
 
-    public static final String SCRIPT_DEFAULT = "def run(session){ print('hello trigger node.') }";
+    public static final String SCRIPT_DEFAULT = """
+            // @SCRIPT_TITLE 示例触发节点（打印触发日志） 
+            def run(request){ 
+                print('hello trigger node.'); 
+            }
+            """;
 
     @Getter
     private final String script;

flow-engine-framework/src/main/java/com/codingapi/flow/script/request/BaseGroovyRequest.java

@@ -22,7 +22,7 @@ public abstract class BaseGroovyRequest {
     /**
      * 当前操作人ID
      */
-    protected Integer operatorId;
+    protected long operatorId;
 
     /**
      * 是否流程管理员