liteFlow/README.zh-CN.md

115 lines
6.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<p align="center">
<a href="https://liteflow.cc/">
<img src="static/img/logo-main.svg" width="50%" height="auto" alt="logo">
</a>
</p>
<h3>您的star是我继续前进的动力如果喜欢LiteFlow请右上角帮忙点个star</h3>
## 🌈概述
LiteFlow是一个轻量且强大的国产规则引擎框架可用于复杂的组件化业务的编排领域独有的DSL规则驱动整个复杂业务并可实现平滑刷新热部署支持多种脚本语言规则的嵌入。帮助系统变得更加丝滑且灵活。
LiteFlow于2020年正式开源直到现在已经是国内开源规则引擎中不可忽视的存在而且最关键的是LiteFlow还是一个持续高速迭代的开源项目。
LiteFlow是一个由社区驱动的项目我们非常重视社区建设拥有一个5000多人的使用者社区在使用中碰到任何问题或者建议都可以在社区中反应。
你在官网中可以找到加入社区的方式!
## 官网链接:[点这里进入官网](https://liteflow.cc/)
## 文档链接:[点这里进入文档进行学习](https://liteflow.cc/pages/5816c5/)
## 示例工程:[DEMO1](https://github.com/bryan31/message-demo) | [DEMO2](https://gitee.com/bryan31/liteflow-example)
## 🍬特性
* **组件定义统一:** 所有的逻辑都是组件,为所有的逻辑提供统一化的组件实现方式,小身材,大能量。
* **规则轻量:** 基于规则文件来编排流程学习规则入门只需要5分钟一看既懂。
* **规则多样化:** 规则支持xml、json、yml三种规则文件写法方式喜欢哪种用哪个。
* **任意编排:** 再复杂的逻辑过程利用LiteFlow的规则都是很容易做到的看规则文件就能知道逻辑是如何运转的。
* **规则持久化:** 框架原生支持把规则存储在标准结构化数据库NacosEtcdZookeeperApolloredis。您也可以自己扩展把规则存储在任何地方。
* **优雅热刷新机制:** 规则变化,无需重启您的应用,即时改变应用的规则。高并发下不会因为刷新规则导致正在执行的规则有任何错乱。
* **支持广泛:** 不管你的项目是不是基于SpringbootSpring还是任何其他java框架构建LiteFlow都能游刃有余。
* **JDK支持** 从JDK8到JDK17全部支持。无需担心JDK版本。
* **Springboot支持全面** 支持Springboot 2.X到最新的Springboot 3.X。
* **脚本语言支持:** 可以定义脚本语言节点支持GroovyJavascriptQLExpressPythonLuaAviatorJavaKotlin。未来还会支持更多的脚本语言。
* **脚本和Java全打通** 所有脚本语言均可调用Java方法甚至于可以引用任意的实例在脚本中调用RPC也是支持的。
* **规则嵌套支持:** 只要你想的出,你可以利用简单的表达式完成多重嵌套的复杂逻辑编排。
* **组件重试支持:** 组件可以支持重试,每个组件均可自定义重试配置和指定异常。
* **上下文隔离机制:** 可靠的上下文隔离机制,你无需担心高并发情况下的数据串流。
* **声明式组件支持:** 你可以让你的任意类秒变组件。
* **详细的步骤信息:** 你的链路如何执行的,每个组件耗时多少,报了什么错,一目了然。
* **稳定可靠:** 历时2年多的迭代在各大公司的核心系统上稳定运行。
* **性能卓越:** 框架本身几乎不消耗额外性能,性能取决你的组件执行效率。
* **自带简单监控:** 框架内自带一个命令行的监控,能够知道每个组件的运行耗时排行。
## ☘️什么场景适用
LiteFlow是一款编排式的规则引擎最擅长去解耦你的系统如果你的系统业务复杂并且代码臃肿不堪那LiteFlow框架会是一个非常好的解决方案。
LiteFlow利用规则表达式为驱动引擎去驱动你定义的组件。你有想过类似以下的多线程流程编排该如何写吗
<img src="static/img/flow_e1.svg" style="zoom: 80%">
<img src="static/img/flow_e2.svg" style="zoom: 80%">
这一切利用LiteFlow轻而易举框架的表达式语言学习门槛很低但是却可以完成超高复杂度的编排。
LiteFlow拥有极其详细易懂的文档体系能帮助你解决在使用框架的时候95%以上的问题。
目前为止LiteFlow拥有1500多个测试用例并且不断在增加中。完备的文档+覆盖全面的测试用例保障了LiteFlow框架的稳定性
LiteFlow期待你的了解
## 👑LF CLUB社区
LF CLUB是由LiteFlow作者创办的高级付费社区
LF CLUB能帮助到所有LiteFlow框架的使用者以及想使用LiteFlow的潜在开发者。
LF CLUB提供以下服务
**1.每周发布一篇LF的解析精华系列。从头开始解析LF只要跟着星球解析系列走使用者一定能完全掌握LF。**
**2.提供答疑服务,会员可以无限制提问,当天必定得到详细的回复和指导建议。**
**3.每个加入的用户每年提供2次远程一对一答疑远程协助服务。**
**4.每1到2天会分享LF目前的进度以及下一个版本的重点。**
LF CLUB里能解决你在使用LiteFlow框架时碰到的所有问题并有系列课程能帮助你深刻理解LiteFlow框架不同于微信社区LF CLUB的问题优先级程度是最高的且答疑非常详细。
独家内容帮助深刻理解,不用在其他平台去搜索问题的答案。作者亲授,相当于随时拥有专家在身边,不用再去求助其他人。
加入LF CLUB请扫描以下二维码或者直接点击图片也可以直达
<a href="https://t.zsxq.com/16jLy4Bj6"><img src="static/img/zsxq-gitee.png"></a>
## 🦾赞助商
**MISBoot低代码开发平台**
<a href="https://www.misboot.com/?from=LiteFlow"><img src="static/img/misboot-banner.png"></a>
**云程企业级低代码平台**
<a href="http://www.yunchengxc.com/"><img src="static/img/yuncheng-banner.png"></a>
**驰骋工作流引擎**
<a href="https://ccbpm.cn/?frm=liteFlow"><img src="static/img/chicheng-banner.png"></a>
**FastBee物联网平台**
<a href="https://fastbee.cn/"><img src="static/img/fb-banner.png"></a>
**JNPF低代码开发平台**
<a href="https://www.jnpfsoft.com/index.html?from=liteflow"><img src="static/img/yinmai-banner.png"></a>
**微信公众号**
社区群需要邀请入群。关注公众号后点击`个人微信`加我,我可以拉你入群
![offIical-wx](static/img/offical-wx.jpg)
开源不易支持就请赞助LiteFlow请我喝一杯咖啡吧
<img src="static/img/support.png" alt="support" width="258" />