diff --git a/docs/guide_cn.md b/docs/guide_cn.md index a2fb0b0cd..c2cbbbb82 100644 --- a/docs/guide_cn.md +++ b/docs/guide_cn.md @@ -40,9 +40,9 @@ public class AComponent extends NodeComponent { } ``` -chain为流程链,每个链上可配置多个组件节点。目前执行的模式分串行和并行2种。 -串行标签为`then`,并行标签为`when`。 -在串行的模式下,以下2种写法是等价的,可以根据业务需要来把不同种类的节点放一行里。 +chain为流程链,每个链上可配置多个组件节点。目前执行的模式分串行和并行2种。 +串行标签为`then`,并行标签为`when`。 +在串行的模式下,以下2种写法是等价的,可以根据业务需要来把不同种类的节点放一行里。 ```xml ``` @@ -96,7 +96,7 @@ public class AComponent extends NodeComponent # 三、和zookeeper进行集成 ## 3.1spring配置 -liteFlow支持把配置放在zk集群中,并支持实时修改流程 +liteFlow支持把配置放在zk集群中,并支持实时修改流程 你只需在原来配置执行器的地方,把本地xml路径换成zk地址就ok了 ```xml @@ -111,13 +111,13 @@ liteFlow支持把配置放在zk集群中,并支持实时修改流程 ``` -如果你不加zkNode这个标签,就用默认的节点路径进行读取配置。 -使用这种方式加载配置,在zk上进行更改配置。liteFlow会实时刷新配置。 +如果你不加zkNode这个标签,就用默认的节点路径进行读取配置。 +使用这种方式加载配置,在zk上进行更改配置。liteFlow会实时刷新配置。 # 四、使用自定义的配置源 ## 4.1创建自定义配置源的类 -如果你不想用本地的配置,也不打算使用zk作为配置持久化工具。liteFlow支持自定义的配置源的扩展点。 -在你的项目中创建一个类继承`ClassXmlFlowParser`这个类 +如果你不想用本地的配置,也不打算使用zk作为配置持久化工具。liteFlow支持自定义的配置源的扩展点。 +在你的项目中创建一个类继承`ClassXmlFlowParser`这个类 ```java public class TestCustomParser extends ClassXmlFlowParser { @@ -132,7 +132,7 @@ public class TestCustomParser extends ClassXmlFlowParser { ``` ## 4.2Spring配置 -spring中需要改的地方还是执行器的配置,只需要在配置的路径地方放入自定义类的类路径即可 +spring中需要改的地方还是执行器的配置,只需要在配置的路径地方放入自定义类的类路径即可 ```xml @@ -146,21 +146,21 @@ spring中需要改的地方还是执行器的配置,只需要在配置的路 # 五、架构设计 ## 5.1组件式流程引擎架构设计 ![architecture_image](images/architecture.png) -Handler Unit:我们想象成每一个业务都是一个业务组件,每一个业务组件就是一个handlerUnit(处理单元) -EPU:这里的epu对应的就是我们的执行器,用来统筹并处理handlerUnit。相当于计算机的CPU -Event Bus:事件总线,用来指定下一个命令是什么,该如何去执行处理单元。这里的时间总线由我们的配置构成 -Data Bus:数据总线,用来存储整个调用链里数据。每一个请求生成一个数据槽。一个数据里最多有1024个数据槽。 +Handler Unit:我们想象成每一个业务都是一个业务组件,每一个业务组件就是一个handlerUnit(处理单元) +EPU:这里的epu对应的就是我们的执行器,用来统筹并处理handlerUnit。相当于计算机的CPU +Event Bus:事件总线,用来指定下一个命令是什么,该如何去执行处理单元。这里的时间总线由我们的配置构成 +Data Bus:数据总线,用来存储整个调用链里数据。每一个请求生成一个数据槽。一个数据里最多有1024个数据槽 # 六、接入详细指南 ## 6.1执行器 -执行器`FlowExecutor`用来执行一个流程,用法为 +执行器`FlowExecutor`用来执行一个流程,用法为 ```java public T execute(String chainId,Object param); ``` -第一个参数为流程ID,第二个参数为流程入参 -返回为`Slot`接口的子类,以上方法所返回的为默认的实现类`DefaultSlot` +第一个参数为流程ID,第二个参数为流程入参 +返回为`Slot`接口的子类,以上方法所返回的为默认的实现类`DefaultSlot` -?> 实际在使用时,并不推荐用默认的`DefaultSlot`,推荐自己新建一个类继承`AbsSlot`类 +?> 实际在使用时,并不推荐用默认的`DefaultSlot`,推荐自己新建一个类继承`AbsSlot`类 推荐使用带自定义Slot的执行接口: ```java public T execute(String chainId,Object param,Class slotClazz);