更新readme

This commit is contained in:
bryan.zhang
2018-03-01 10:52:53 +08:00
parent 93ac2f9b91
commit bfc7c7f9bf

View File

@@ -1,74 +1,16 @@
### 概述
liteFlow是一个轻量快速的组件式流程框架帮助解耦业务代码让每一个业务片段都是一个组件
## 概述
liteFlow是一个轻量快速的组件式流程引擎框架,帮助解耦业务代码,让每一个业务片段都是一个组件,并支持热加载规则配置,实现即时修改。
* 提供本地xml的流程配置后续全面支持spring式流程配置
* 提供基于spring的扫描方式注入component
[中文文档](http://123.206.92.144)
## 特性
* 提供本地xml的流程配置
* 支持zookeeper流程配置即时推送修改内容
* 能自由扩展配置源,提供扩展接口
* 和spring集成支持spring的扫描方式
* 提供串行和并行2种模式。
* 消除组件之间参数传递,引入数据总线概念。
* 数据槽高并发隔离机制。
* 提供无级嵌套条件节点的模式。
* 自带简单的监控,能够知道每个组件的运行耗时排行每隔5分钟会自动打印
* 自带简单的监控,能够知道每个组件的运行耗时排行
### 最新版本1.3.1更新日志
优化大量潜在的问题,此版本为稳定版本,主要更新点如下:
1. 增加条件节点功能
2. 优化异常捕获的日志打印
3. 支持自定义SLOT的特性
4. 优化步骤打印,能够支持开闭区间的打印方式
5. 增加了内部策略的调用方式
6. 增加了追踪ID
7. 优化了监控打印
### Quick Start
1. 定义组件需继承Component项目启动时会被自动发现。
2. 定义xml配置(例子)
```xml
<?xml version="1.0" encoding="UTF-8"?>
<flow>
<!-- 如果和spring集成以下<nodes>配置可以不要 -->
<nodes>
<node id="a" class="com.thebeastshop.liteflow.test.component.AComponent"/>
<node id="b" class="com.thebeastshop.liteflow.test.component.BComponent"/>
<node id="c" class="com.thebeastshop.liteflow.test.component.CComponent"/>
<node id="d" class="com.thebeastshop.liteflow.test.component.DComponent"/>
<node id="e" class="com.thebeastshop.liteflow.test.component.EComponent"/>
<node id="f" class="com.thebeastshop.liteflow.test.component.FComponent"/>
<node id="g" class="com.thebeastshop.liteflow.test.component.GComponent"/>
</nodes>
<chain name="chain1">
<then value="a,c"/> <!-- then代表串行 -->
<when value="b,d"/> <!-- when代表并行 -->
<then value="e,f,g"/>
</chain>
<chain name="chain2">
<then value="a,cond(b|d)"/> <!-- cond节点是条件节点根据cond节点路由到b节点或者d节点 -->
<then value="e,f,g"/>
</chain>
<chain name="chain3">
<then value="a,c,g"/>
<when value="b,e"/>
<then value="d,f"/>
</chain>
</flow>
```
3.spring里声明执行器
```xml
<bean id="flowExecutor" class="com.thebeastshop.liteflow.core.FlowExecutor" init-method="init">
<property name="rulePath">
<list>
<value>flow.xml</value>
</list>
</property>
</bean>
<!-- 自动扫描注入到spring的component组件 -->
<bean class="com.thebeastshop.liteflow.spring.ComponentScaner"/>
```
4.开始一个流程
```java
executor.execute("chain2", 参数);
```