aviator-rule-engine

基于AviatorScript的规则引擎实例

Requirements

Spring Boot 2.0+
MySQL 5.5+
AviatorScript 5.3.0+

Tables Required

t_rule_info

CREATE TABLE `t_rule_info` (
`id` bigint(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '规则id',
`code` VARCHAR(20) NOT NULL COMMENT '规则编码（唯一 用于调用方进行绑定）',
`name` VARCHAR(20) NOT NULL COMMENT '规则名称',
`remark` VARCHAR(128) NULL COMMENT '规则备注',
`expression` VARCHAR(1024) NULL COMMENT '规则表达式',
`mode` TINYINT(4) UNSIGNED NOT NULL DEFAULT 1 COMMENT '模式（1：规则已设置  2：表达式已设置）',
`status` TINYINT(4) UNSIGNED NOT NULL DEFAULT 1 COMMENT '状态（1：启用  0：禁用）',
PRIMARY KEY (`id`),
  KEY `ix_code` (`code`)
) ENGINE = InnoDB AUTO_INCREMENT = 1 DEFAULT CHARSET = utf8mb4 COMMENT = '规则信息表';

t_condition_info

CREATE TABLE `t_condition_info` (
`id` BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '条件id',
`rule_id` BIGINT(20) UNSIGNED NOT NULL COMMENT '所属规则id',
`name` VARCHAR(20) NOT NULL COMMENT '条件名称',
`remark` VARCHAR(128) NULL COMMENT '条件备注',
`variable_name` varchar(32) NOT NULL COMMENT '变量名（作为变量传入的唯一标识符）',
 `reference_value` varchar(256) NOT NULL COMMENT '参考值',
`operate_type` TINYINT(4) UNSIGNED NOT NULL COMMENT '条件运算类型',
`logic_type` TINYINT(4) UNSIGNED NOT NULL COMMENT '条件逻辑类型（1-当前条件满足则继续，否则跳过后续条件 2-当前条件满足则跳过后续条件，否则继续）',
`priority` SMALLINT(15) UNSIGNED NOT NULL COMMENT '条件优先级（值越大优先级越高）',
PRIMARY KEY (`id`),
KEY `ix_rule_id` (`rule_id`)
) ENGINE = InnoDB AUTO_INCREMENT = 1 DEFAULT CHARSET = utf8mb4 COMMENT = '条件信息表';

支持的条件逻辑运算类型

ConditionLogicType.java

逻辑类型	值	描述
AND	&&	所在条件单元必须满足，否则条件单元值为false
OR	\|\|	所在条件单元如果满足，则条件单元值为true

支持的条件关系运算类型

ConditionOperateType.java

关系型条件

条件类型	描述
EQUAL	等于（=）
NOT_EQUAL	不等于（!=）
LESS_EQUAL	小于等于（<=）
GREATER_EQUAL	大于等于（>=）
LESS	小于（<）
GREATER	大于（>）

集合型条件

条件类型	描述
INCLUDE_IN_LIST	包括
NOT_INCLUDE_IN_LIST	不包括
SOME_CONTAINS_IN_LIST	包含
NONE_CONTAINS_IN_LIST	不包含

正则型条件

条件类型	描述
REGULAR	正则

条件组合

同一规则下的所有条件可以进行组合，组成一个完整的规则表达式。

通常条件组合为两个条件的组合，也支持三个及三个以上条件的组合。

在实践中，不建议配置三个及三个以上的条件组合，组合条件数量过多影响规则可读性及维护性，可以考虑将条件拆分到多个规则中。

条件优先级

条件优先级决定了条件之间的组合次序。一个规则下所有条件按优先级进行排序，优先级越高，组合次序越靠前。

例如，定义一个规则下的条件表达式及优先级如下：

条件表达式	条件逻辑运算符	条件优先级
x == 1	\|\|	8
y > 2	&&	4
z <= 3	&&	2
v != 4	\|\|	1

最后生成的规则表达式为：

((x ==1 || y>2) && z <= 3) && v != 4

条件单元

条件单元是逻辑运算类型作用的目标对象，逻辑运算类型左侧（沿优先级最高的方向）的部分称为它所在的条件单元。以规则表达式为例：

((x ==1 || y>2) && z <= 3) && v != 4

第一个“||”逻辑运算类型所在的条件单元为：x ==1
第二个“||”逻辑运算类型所在的条件单元为：v !=4（优先级最低的逻辑运算类型在生成表达式时自动忽略）
第一个“&&”逻辑运算类型所在的条件单元为：(x ==1 || y>2)
第二个“&&”逻辑运算类型所在的条件单元为：((x ==1 || y>2) && z <= 3)

条件与条件单元的关系

条件单元是条件组合场景中引申出的概念，主要用于定位逻辑运算类型作用的目标对象。

条件是规则组成的基本单位，用于定义条件本身的属性。

一个条件单元包含一个或多个条件，一个条件可以在多个条件单元中，条件自身作为一个最小的条件单元。

Getting started

Example

在规则管理中添加一条规则，规则编码定义为BUSINESS_RULE_001，在规则下添加以下两个条件：

条件	变量名	参考值	逻辑运算类型	关系运算类型	优先级
条件1	price	49.99	AND（&&）	GREATER_EQUAL（>=）	2
条件2	discount	0.85	AND（&&)	LESS（<）	1

最终生成条件表达式为：

price >= 49.99 && discount < 0.85

从外部调用中，传入price = 50，discount = 0.75，计算表达式值为true。

@Autowired
private RuleCoreService ruleCoreService;

String ruleCode = "BUSINESS_RULE_001";
Map<String, Object> paraMap = new HashMap<>();
paramMap.put("price", 50);
paramMap.put("discount", 0.75);
boolean result = ruleCoreService.executeRule(ruleCode, paramMap);

nutzside / aviator-rule-engine Goto Github PK