diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index effedd767..000000000 --- a/docs/README.md +++ /dev/null @@ -1,74 +0,0 @@ -### 概述 -liteFlow是一个轻量，快速的组件式流程框架，帮助解耦业务代码，让每一个业务片段都是一个组件 - -* 提供本地xml的流程配置（后续全面支持spring式流程配置） -* 提供基于spring的扫描方式注入component -* 提供串行和并行2种模式。 -* 消除组件之间参数传递，引入数据总线概念。 -* 数据槽高并发隔离机制。 -* 提供无级嵌套条件节点的模式。 -* 自带简单的监控，能够知道每个组件的运行耗时排行（每隔5分钟会自动打印） - -### 最新版本1.3.1更新日志 -优化大量潜在的问题，此版本为稳定版本，主要更新点如下： -1. 增加条件节点功能 -2. 优化异常捕获的日志打印 -3. 支持自定义SLOT的特性 -4. 优化步骤打印，能够支持开闭区间的打印方式 -5. 增加了内部策略的调用方式 -6. 增加了追踪ID -7. 优化了监控打印 - -### Quick Start -1. 定义组件需继承Component，项目启动时会被自动发现。 -2. 定义xml配置(例子) -```xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -``` -3.spring里声明执行器 -```xml - - - - flow.xml - - - - - - - -``` -4.开始一个流程 -```java -executor.execute("chain2", 参数); -``` \ No newline at end of file diff --git a/docs/architecture.md b/docs/architecture.md deleted file mode 100644 index 37f3711c4..000000000 --- a/docs/architecture.md +++ /dev/null @@ -1,9 +0,0 @@ -## 架构设计 - -![architecture_image](images/architecture.png) - -组件式流程引擎架构设计 -Handler Unit：我们想象成每一个业务都是一个业务组件，每一个业务组件就是一个handlerUnit（处理单元） -EPU：这里的epu对应的就是我们的执行器，用来统筹并处理handlerUnit。相当于计算机的CPU -Event Bus：事件总线，用来指定下一个命令是什么，该如何去执行处理单元。这里的时间总线由我们的配置构成 -Data Bus：数据总线，用来存储整个调用链里数据。每一个请求生成一个数据槽。一个数据里最多有1024个数据槽。 \ No newline at end of file diff --git a/docs/guide.md b/docs/guide.md deleted file mode 100644 index 391250caa..000000000 --- a/docs/guide.md +++ /dev/null @@ -1 +0,0 @@ -XXX \ No newline at end of file diff --git a/docs/guide_cn.md b/docs/guide_cn.md new file mode 100644 index 000000000..910af4f3d --- /dev/null +++ b/docs/guide_cn.md @@ -0,0 +1,180 @@ +# 一、快速开始 +liteflow需要你的项目使用maven +## 1.1依赖 +```xml + + com.thebeastshop.liteflow + liteflow + ${liteFlow.version} + +``` +## 1.2流程配置文件 +```xml + + + + + + + + + + + + + + + +``` + +component为组件，这里你需要实现这些组件，每个组件继承`NodeComponent`类 +```java +public class AComponent extends NodeComponent { + + @Override + public void process() { + String str = this.getSlot().getRequestData(); + System.out.println(str); + System.out.println("Acomponent executed!"); + } +} +``` + +chain为流程链，每个链上可配置多个组件节点。目前执行的模式分串行和并行2种。 +串行标签为`then`，并行标签为`when`。 +在串行的模式下，以下2种写法是等价的,可以根据业务需要来把不同种类的节点放一行里。 +```xml + +``` +```xml + + +``` + +## 1.3执行流程链 +```java +FlowExecutor executor = new FlowExecutor(); +executor.setRulePath(Arrays.asList(new String[]{"/config/flow.xml"})); +executor.init(); +Slot slot = executor.execute("demoChain", "arg"); +``` + +如果你的项目使用spring，推荐参考[和Spring进行集成](http://123.206.92.144:3000/guide_cn?id=和spring进行集成) + +# 二、和spring进行集成 +如果你的项目中使用了spring，liteFlow可以很方便和spring进行集成 + +## 2.1流程配置可以省略的部分 +流程配置中的`nodes`节点，可以不用配置了，支持spring的自动扫描方式。你需要在你的spring配置文件中定义 +```xml + + +``` + +当然，你的组件节点也需要注册进spirng容器 +```java +@Component("a") +public class AComponent extends NodeComponent + @Override + public void process() { + String str = this.getSlot().getRequestData(); + System.out.println(str); + System.out.println("Acomponent executed!"); + } +} +``` + +## 2.2spring中执行器的配置 +```xml + + + + /config/flow.xml + + + +``` +然后你的项目中通过spring拿到执行器进行调用流程。 + +## 三、和zookeeper进行集成 +liteFlow支持把配置放在zk集群中，并支持实时修改流程 + +# 3.1spring配置 +你只需在原来配置执行器的地方，把本地xml路径换成zk地址就ok了 +```xml + + + + + 127.0.0.1:2181,127.0.0.1:2182,127.0.0.1:2183 + + + + + +``` + +如果你不加zkNode这个标签，就用默认的节点路径进行读取配置。 +使用这种方式加载配置，在zk上进行更改配置。liteFlow会实时刷新配置。 + +## 四、使用自定义的配置源 +如果你不想用本地的配置，也不打算使用zk作为配置持久化工具。liteFlow支持自定义的配置源的扩展点。 + +# 4.1创建自定义配置源的类 +在你的项目中创建一个类继承`ClassXmlFlowParser`这个类 +```java +public class TestCustomParser extends ClassXmlFlowParser { + + @Override + public String parseCustom() { + System.out.println("进入自定义parser"); + String xmlContent = null; + //这里需要自己扩展从自定义的地方获取配置 + return xmlContent; + } +} +``` + +# 4.2spring配置 +spring中需要改的地方还是执行器的配置，只需要在配置的路径地方放入自定义类的类路径即可 +```xml + + + + com.thebeastshop.liteflow.test.TestCustomParser + + + +``` + +## 五、架构设计 + +![architecture_image](images/architecture.png) + +# 5.1组件式流程引擎架构设计 +Handler Unit：我们想象成每一个业务都是一个业务组件，每一个业务组件就是一个handlerUnit（处理单元） +EPU：这里的epu对应的就是我们的执行器，用来统筹并处理handlerUnit。相当于计算机的CPU +Event Bus：事件总线，用来指定下一个命令是什么，该如何去执行处理单元。这里的时间总线由我们的配置构成 +Data Bus：数据总线，用来存储整个调用链里数据。每一个请求生成一个数据槽。一个数据里最多有1024个数据槽。 + +## 六、接入详细指南 +教你如何利用liteFlow写出低耦合，易扩展的项目 + +# 6.1执行器 +执行器`FlowExecutor`用来执行一个流程，用法为 +```java +public T execute(String chainId,Object param); +``` +第一个参数为流程ID，第二个参数为流程入参 +返回为`Slot`接口的子类，以上方法所返回的为默认的实现类`DefaultSlot` + +?> 实际在使用时，并不推荐用默认的`DefaultSlot`，推荐自己新建一个类继承`AbsSlot`类 +推荐使用带自定义Slot的执行接口： +```java +public T execute(String chainId,Object param,Class slotClazz); +``` + +关于`Slot`的说明，请参照[数据槽](http://123.206.92.144:3000/#/guide?id=数据槽) + +# 6.2数据槽 +数据槽 \ No newline at end of file diff --git a/docs/quickstart.md b/docs/quickstart.md deleted file mode 100644 index eab6d0a46..000000000 --- a/docs/quickstart.md +++ /dev/null @@ -1,62 +0,0 @@ -# 快速开始 -liteflow需要你的项目使用maven -## 依赖 -```xml - - com.thebeastshop.liteflow - liteflow - ${liteFlow.version} - -``` -## 流程配置文件 -```xml - - - - - - - - - - - - - - - -``` - -component为组件，这里你需要实现这些组件，每个组件继承`NodeComponent`类 -```java -public class AComponent extends NodeComponent { - - @Override - public void process() { - String str = this.getSlot().getRequestData(); - System.out.println(str); - System.out.println("Acomponent executed!"); - } -} -``` - -chain为流程链，每个链上可配置多个组件节点。目前执行的模式分串行和并行2种。 -串行标签为`then`，并行标签为`when`。 -在串行的模式下，以下2种写法是等价的,可以根据业务需要来把不同种类的节点放一行里。 -```xml - -``` -```xml - - -``` - -## 执行流程链 -```java -FlowExecutor executor = new FlowExecutor(); -executor.setRulePath(Arrays.asList(new String[]{"/config/flow.xml"})); -executor.init(); -Slot slot = executor.execute("demoChain", "arg"); -``` - -如果你的项目使用spring，推荐参考[和Spring进行集成](http://123.206.92.144:3000/#/runwithspring) \ No newline at end of file diff --git a/docs/runwithcustom.md b/docs/runwithcustom.md deleted file mode 100644 index df0411b10..000000000 --- a/docs/runwithcustom.md +++ /dev/null @@ -1,29 +0,0 @@ -## 使用自定义的配置源 -如果你不想用本地的配置，也不打算使用zk作为配置持久化工具。liteFlow支持自定义的配置源的扩展点。 - -# 创建自定义配置源的类 -在你的项目中创建一个类继承`ClassXmlFlowParser`这个类 -```java -public class TestCustomParser extends ClassXmlFlowParser { - - @Override - public String parseCustom() { - System.out.println("进入自定义parser"); - String xmlContent = null; - //这里需要自己扩展从自定义的地方获取配置 - return xmlContent; - } -} -``` - -# spring配置 -spring中需要改的地方还是执行器的配置，只需要在配置的路径地方放入自定义类的类路径即可 -```xml - - - - com.thebeastshop.liteflow.test.TestCustomParser - - - -``` \ No newline at end of file diff --git a/docs/runwithspring.md b/docs/runwithspring.md deleted file mode 100644 index 292290319..000000000 --- a/docs/runwithspring.md +++ /dev/null @@ -1,34 +0,0 @@ -# 和spring进行集成 -如果你的项目中使用了spring，liteFlow可以很方便和spring进行集成 - -## 流程配置可以省略的部分 -流程配置中的`nodes`节点，可以不用配置了，支持spring的自动扫描方式。你需要在你的spring配置文件中定义 -```xml - - -``` - -当然，你的组件节点也需要注册进spirng容器 -```java -@Component("a") -public class AComponent extends NodeComponent - @Override - public void process() { - String str = this.getSlot().getRequestData(); - System.out.println(str); - System.out.println("Acomponent executed!"); - } -} -``` - -## spring中执行器的配置 -```xml - - - - /config/flow.xml - - - -``` -然后你的项目中通过spring拿到执行器进行调用流程。 \ No newline at end of file diff --git a/docs/runwithzookeeper.md b/docs/runwithzookeeper.md deleted file mode 100644 index c364d63b1..000000000 --- a/docs/runwithzookeeper.md +++ /dev/null @@ -1,20 +0,0 @@ -## 和zookeeper进行集成 -liteFlow支持把配置放在zk集群中，并支持实时修改流程 - -# spring配置 -你只需在原来配置执行器的地方，把本地xml路径换成zk地址就ok了 -```xml - - - - - 127.0.0.1:2181,127.0.0.1:2182,127.0.0.1:2183 - - - - - -``` - -如果你不加zkNode这个标签，就用默认的节点路径进行读取配置。 -使用这种方式加载配置，在zk上进行更改配置。liteFlow会实时刷新配置。 \ No newline at end of file