diff --git a/README.md b/README.md index 81f074aa9217284d71a7c994805ab5009c7288a3..64f32715a20f4b107fe43873353e8517c5a237cb 100644 --- a/README.md +++ b/README.md @@ -25,21 +25,26 @@ REC（Rule Engine Component）规则引擎组件：提供统一的规则处理 - rec-spring-boot-starter：SpringBoot启动器 + ## 什么是规则引擎 -- 当我们在对复杂的业务进行开发的时候，程序本身逻辑代码和业务代码`相互嵌套、耦合`，与此同时，`维护成本比较高，可扩展性也比较差`，我们现在想要举一个营销活动的例子，假如双十一活动，针对某些会员(比如白银会员、黄金会员、白金会员)，每个会员级别可以领取的抵扣券是不一样的，同时每个会员的满减也是不一样的，也就是我们的运营人员在进行活动配置的时候，需要根据不同的条件组合完成响应的逻辑。这些配置是高度灵活、修改是经常发生的，并且每个时间的活动规则都可能不一样，而在活动进行的过程中，不可能随时修改代码，去处理这种动态的数据变更，所以就需要使用规则引擎。 + +- 当我们在对复杂的业务进行开发的时候，程序本身逻辑代码和业务代码`相互嵌套、耦合`，与此同时，`维护成本比较高，可扩展性也比较差`，我们现在想要举一个营销活动的例子，假如双十一活动，针对某些会员(比如白银会员、黄金会员、白金会员) + ，每个会员级别可以领取的抵扣券是不一样的，同时每个会员的满减也是不一样的，也就是我们的运营人员在进行活动配置的时候，需要根据不同的条件组合完成响应的逻辑。这些配置是高度灵活、修改是经常发生的，并且每个时间的活动规则都可能不一样，而在活动进行的过程中，不可能随时修改代码，去处理这种动态的数据变更，所以就需要使用规则引擎。 - 总结下来就是：规则引擎是可降低复杂业务逻辑组件复杂性、降低应用程序的维护和可扩展性成本的组件。 - 下面用一张图来表示`**输入输出**`关系 -![image.png](https://cdn.nlark.com/yuque/0/2022/png/1806904/1667042113083-0ae3c9af-f892-49b8-8262-e1d900aadbd0.png#clientId=uf56dcd1b-5a51-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=267&id=u90e1a10a&margin=%5Bobject%20Object%5D&name=image.png&originHeight=534&originWidth=1436&originalType=binary&ratio=1&rotation=0&showTitle=false&size=111676&status=done&style=none&taskId=u76412d50-f07d-47de-89ee-3eb40456669&title=&width=718) +![image.png](./static/img/rule_engin.png) - 我们在`**业务节点**`触发规则引擎的判断，然后对`**规则引擎**`输入`**规则集合簇**`和`**输入参数**`，经过`**规则引擎计算**`，输入`**执行结果**`，然后根据执行结果进行相应的`业务逻辑处理`，这样的话，每个业务节点就可定制业务规则，交给规则引擎去执行判断，然后拿到结果之后判断是否需要执行。 - 那么通过上述的介绍，相信你就可以了解规则引擎的作用了，那么在实际的业务开发中，我们经常会遇到这种场景，就需要规则引擎进行规则定制执行，来满足业务的诉求。 + ## 主流规则引擎 + | **名称** | **开源** | **流行度** | **运行模式** | **备注** | | --- | --- | --- | --- | --- | | ILog | 商业 | 非常高 | / | 价格昂贵 | -| drools | 开源 | github 3.2k | 嵌入式、分离式 | 支持可视化等整个配套，是一个完整的BMRS系统（业务规则管理系统），同时其生态很活跃 | +| drools | 开源 | github 3.2k | 嵌入式、分离式 | 支持可视化等整个配套，是一个完整的BMRS系统（业务规则管理系统），同时其生态很活跃 | | esayRule | 开源 | github 2.6k | 嵌入式 | 支持yml、java、注解方式配置规则，但是后两者无法实现动态加载 | | qlexpress | 开源 | github 2.3k | 嵌入式 | 支持java方式书写规则，且支持动态加载，但加载比较耗时。后续还有Aviator、Vincio均是类似性质，故不予赘述 | | uRule | 商业 | github 1.1k | 嵌入式、分离式 | 除了部分开源外，其他方面基本和drools差不多，也是一套完整的 BMRS系统，且是国内开发，学习和使用门槛更低 | @@ -49,58 +54,72 @@ REC（Rule Engine Component）规则引擎组件：提供统一的规则处理 - 上述最常用的、最主流的就是`drools`，但是我看了官方的使用和接入文档，使用方式不是很喜欢，而且也不动态，并且还要学习语法的编辑等，我个人认为不是非常友好，因此我重新设计一个只需要页面进行配置即可。 + ## 设计理念 - 方便运营进行操作，只需页面配置，然后发布，即可动态变更数据。 - 而对于页面的操作，将具备完善的文档，方便快速接入，并且理解配置，使得配置不具备复杂性。 - 可以通过SDK的方式进行接入，支持服务端、客户端通信进行处理。 + ## 规则引擎要素 + + ### 域 - **域**作为一个业务单元的概念，尤其是在分布式系统中，域可作为原子系统的边界，也可以理解为每个单独的应用，是一个`**业务域**` - 每个域的数据相互隔离，在进行数据发送的时候，按照域进行加载和发送，之后的所有配置都依托域来进行配置 + ### 场景 - 域下业务节点，比如淘宝买东西，业务节点有：下单成功、物流通知、收货成功、评价等等，这些都是域中，也就是应用中的业务节点，那么这些业务节点可以称之为**场景**，那么`**域加上场景**`，就确定了一个唯一的业务节点。既然可以确定唯一的业务节点，就可以进行接下来的配置 + ### 元数据 - 元数据是一些基本的数据，比如常用的，不会经常变更的，其类似于Java中的枚举，是一组数据的集合，用来归类一些通用的配置项 + ### 操作符 - 操作符即比较符，是一些数学上的概念，比如大于、小于、等于、不等于、包含、不包含，通过操作符，判断左右值，即可判断出当前执行的是否成功，从而判断是否执行下面的节点 + ### 基础数据 - 基础数据是取值上的概念，通过多种脚本执行引擎，可以通过编写脚本来进行取值，来和目标值进行比较运算 + ### 数据源 - 数据源，在执行规则判断的时候，可能存在一些计算得到的数据源，并不是仅仅传参，这样就可以动态的组织起始数据 + ### 策略组 - 策略组是多组策略的集合 + ### 决策树 - 对策略组进行编排，构建决策树，因为策略组具备多个可能的执行流程分支，执行分支可能是且、或、存在等的关系，通过决策树执行最后的结果，可定义简单返回类型，然后后续业务逻辑会根据返回类型进行决断 + ## 规则引擎操作页面 - 操作页面按照规则引擎要素进行划分，分为域配置、场景配置、元数据配置、基础数据配置、策略组配置，具体的页面UI等开发完毕之后进行贴图即可 + ## 规则引擎单节点执行逻辑 - 如下图所示 - 业务节点触发规则执行，执行的时候先判断一些数据的验证逻辑，通过之后才能将数据推到`Rule Engine Calculation`进行执行，在此过程中判断当前业务节点的决策树是否构建完毕，如果构建完毕，则从本地缓存中取出数据，否则重新构建决策树，然后存储到本地缓存执行，最终返回执行结果 -![image.png](https://cdn.nlark.com/yuque/0/2022/png/1806904/1667042132912-e781de18-d095-47c9-a90f-2ba69a8ddc1f.png#clientId=uf56dcd1b-5a51-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=407&id=u31617b92&margin=%5Bobject%20Object%5D&name=image.png&originHeight=814&originWidth=2336&originalType=binary&ratio=1&rotation=0&showTitle=false&size=239707&status=done&style=none&taskId=u20414fe2-e24c-4cb5-b28a-12eb13b541d&title=&width=1168) +![image.png](./static/img/rule_engin_process.png) + ## 规则引擎架构设计 - 架构主要分为两个方面，一方面是页面的规则配置，另外一方面是`**仓储(本地缓存)**`的设计 @@ -108,8 +127,9 @@ REC（Rule Engine Component）规则引擎组件：提供统一的规则处理 - 而接入方可以选择使用SDK方式的接入，但是这种接入方式限制了开发语言为Java；也可以使用HTTP接口的方式提供服务 - 通过SDK的方式需要在当前JVM进程加载当前域所在的配置数据；而通过HTTP接口的方式，则会在HTTP服务端加载所有仓储的数据。当然，在更新的时候也是按需更新 -![image.png](https://cdn.nlark.com/yuque/0/2022/png/1806904/1667042317711-8d703530-d426-4403-b1f1-deb780450b9e.png#clientId=uf56dcd1b-5a51-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=676&id=u4063badb&margin=%5Bobject%20Object%5D&name=image.png&originHeight=1352&originWidth=2232&originalType=binary&ratio=1&rotation=0&showTitle=false&size=377938&status=done&style=none&taskId=u6eef3cb3-df98-44ed-b245-6afa45aa85b&title=&width=1116) +![image.png](./static/img/rule_engin_all.png) + ## 技术与架构选项 - 存储技术选型：MongoDB，因为是一些配置的数据，有一些的数据可能经常的发生改动，使用MySQL不方便经常的变更数据，因此使用文档数据库MongoDB @@ -117,13 +137,14 @@ REC（Rule Engine Component）规则引擎组件：提供统一的规则处理 - 数据请求：OKHTTP - 其他暂无 + ## 数据表设计 - 数据表设计，根据规则引擎要素可以发现聚合了5张表，实际上域和场景应该是绑定到一起的，可以合并，也可以考虑分开，此处选择分开存储 -- 在数据设计的过程中，有些数据是固化的，每5张表数据都有的，如下表，因此这些字段不再单独列出，具体的可在存储的数据结构中看到 +- 在数据设计的过程中，有些数据是固化的，每5张表数据都有的，如下表，因此这些字段不再单独列出，具体的可在存储的数据结构中看到 | **字段名称** | **类型** | **备注** | - | --- | --- | --- | + | --- | --- | --- | | id | object(String) | mongodb 自带id | | uuid | String | 雪花算法随机UUID | | desc | String | 功能描述 | @@ -134,14 +155,14 @@ REC（Rule Engine Component）规则引擎组件：提供统一的规则处理 - 域数据存储设计(文档名称：**rec-domian**) | **字段名称** | **类型** | **备注** | - | --- | --- | --- | + | --- | --- | --- | | domainName | String | 域名称 | | domainCode | String | 域Code | - 域场景 | **字段名称** | **类型** | **备注** | - | --- | --- | --- | + | --- | --- | --- | | domainCode | String | 域Code | | sceneName | String | 场景名称 | | sceneCode | String | 场景Code | @@ -149,7 +170,7 @@ REC（Rule Engine Component）规则引擎组件：提供统一的规则处理 - 元数据 | **字段名称** | **类型** | **备注** | - | --- | --- | --- | + | --- | --- | --- | | domainCode | String | 域Code | | metadataName | String | 元数据名称 | | metadataList | String(JSON格式) | 元数据枚举值 | @@ -157,7 +178,7 @@ REC（Rule Engine Component）规则引擎组件：提供统一的规则处理 - 基础数据 | **字段名称** | **类型** | **备注** | - | --- | --- | --- | + | --- | --- | --- | | domainCode | String | 域Code | | fieldName | String | 基础数据名称 | | dataType | String | 数据类型(布尔、字符串、数值、日期、元数据等) | @@ -168,7 +189,7 @@ REC（Rule Engine Component）规则引擎组件：提供统一的规则处理 - 数据源 | **字段名称** | **类型** | **备注** | - | --- | --- | --- | + | --- | --- | --- | | dataSourceName | String | 数据源名称 | | dataSourceCode | String | 数据源Code | | dataSourceType | String | 数据源类型(脚本、HTTP、SQL) | @@ -179,7 +200,7 @@ REC（Rule Engine Component）规则引擎组件：提供统一的规则处理 - 策略组 | **字段名称** | **类型** | **备注** | - | --- | --- | --- | + | --- | --- | --- | | domainCode | String | 域Code | | sceneCode | String | 场景Code | | strategyName | String | 策略组名称 | @@ -190,11 +211,13 @@ REC（Rule Engine Component）规则引擎组件：提供统一的规则处理 | ruleTreeInfo | Object | 规则配置类型为Tree时候的规则数据 | + ## 项目地址 - [https://gitee.com/icanci/rec](https://gitee.com/icanci/rec) - 分支： dev_vue_admin_template + ## 迭代版本 - 初步设计如上 diff --git a/static/.gitkeep b/static/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/static/img/rule_engin.png b/static/img/rule_engin.png new file mode 100644 index 0000000000000000000000000000000000000000..a2e5e189629b0a334fd004fe76eb70978faf5c97 Binary files /dev/null and b/static/img/rule_engin.png differ diff --git a/static/img/rule_engin_all.png b/static/img/rule_engin_all.png new file mode 100644 index 0000000000000000000000000000000000000000..e9f757447ee6c489754cc000587e26cee039854a Binary files /dev/null and b/static/img/rule_engin_all.png differ diff --git a/static/img/rule_engin_process.png b/static/img/rule_engin_process.png new file mode 100644 index 0000000000000000000000000000000000000000..36af389202a58a22167cdf425817597d24632055 Binary files /dev/null and b/static/img/rule_engin_process.png differ