aviator-rule-engine

一个基于AviatorScript的简单规则引擎实例。

将规则划分为规则集、规则、条件三个维度，可以满足业务规则的通用性配置，同时也可以进行扩展。

依赖版本

AviatorScript 5.3.0+
SpringBoot 2.0+

创建数据表

条件(t_condition_info)

CREATE TABLE `t_condition_info` (
`id` bigint unsigned NOT NULL AUTO_INCREMENT,
`rule_id` bigint unsigned NOT NULL COMMENT '所属规则id',
`name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '条件名称',
`remark` varchar(128) DEFAULT NULL COMMENT '条件备注',
`variable_name` varchar(32) NOT NULL COMMENT '变量名（作为参数传入的唯一标识符）',
`reference_value` varchar(256) NOT NULL COMMENT '参考值',
`relation_type` varchar(32) NOT NULL COMMENT '条件关系运算类型',
`logic_type` varchar(32) NOT NULL COMMENT '条件逻辑运算类型',
`priority` smallint unsigned NOT NULL COMMENT '条件优先级（值越大优先级越高）',
PRIMARY KEY (`id`),
KEY `ix_rule_id` (`rule_id`)
) ENGINE = InnoDB AUTO_INCREMENT = 1 DEFAULT CHARSET = utf8mb4 COMMENT = '条件';

规则(t_rule_info)

CREATE TABLE `t_rule_info` (
`id` bigint unsigned NOT NULL AUTO_INCREMENT,
`ruleset_id` bigint NOT NULL COMMENT '所属规则集ID',
`name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '规则名称',
`remark` varchar(128) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL COMMENT '规则备注',
`return_values` varchar(256) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '返回值集合',
PRIMARY KEY (`id`),
KEY `ix_ruleset_id` (`ruleset_id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 1 DEFAULT CHARSET = utf8mb4 COMMENT = '规则';

规则集(t_ruleset_info)

CREATE TABLE `t_ruleset_info` (
`id` bigint NOT NULL AUTO_INCREMENT,
`code` varchar(20) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '规则集编码',
`name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL COMMENT '规则集名称',
`remark` varchar(128) DEFAULT NULL COMMENT '规则集备注',
`expression` varchar(1024) DEFAULT NULL COMMENT '规则集表达式',
`mode` tinyint NOT NULL DEFAULT '0' COMMENT '模式（0：创建中  1：已创建）',
PRIMARY KEY (`id`),
KEY `ix_code` (`code`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 1 DEFAULT CHARSET = utf8mb4 COMMENT = '规则集';

支持的条件逻辑运算类型

ConditionLogicType

逻辑类型	值	描述
AND	&&	如果当前条件单元为真，则继续向后执行，否则跳过后面的条件单元，直接返回假
OR	\|\|	如果当前条件单元为真，则跳过后面的条件单元直接返回真，否则继续向后执行

支持的条件关系运算类型

ConditionRelationType

关系类型条件

条件类型	描述
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 >= 99。

多个条件可以按照关系运算类型、逻辑运算类型组合成一个规则。例如：x >= 99 || y < 45。

当然单个条件本身也是一个规则，可以认为x >= 99等同于x >= 99 && true。

条件优先级

条件优先级决定了条件之间的组合次序和执行顺序。同一个规则下所有条件按优先级进行排序，优先级越高，组合次序和执行顺序越靠前。（同一规则下，不能存在优先级相同的条件，保证执行顺序唯一。）

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

条件表达式	条件逻辑运算符	条件优先级
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逻辑运算类型为||，作用于条件y > 2。
条件y > 2逻辑运算类型为&&，由于和左侧条件x == 1进行组合，所以作用于右侧条件z <= 3。
条件z <= 3逻辑运算类型为&&，由于和左侧条件组合(x == 1 || y> 2)进行组合，所以作用于右侧条件v != 4。
条件v != 4优先级最低，在生成规则表达式时将会自动忽略其逻辑运算类型。

条件关系运算

每个条件都附带条件关系类型，用于和参考值进行比较。

例如条件x >= 99，x是条件的变量名，作为参数传入的唯一标识符，>=是条件的关系运算符（对应的关系运算类型为，ConditionRelationType.EQUAL），99是条件的参考值，用于和以x为变量名的参数值进行对应的关系运算。

规则

条件之上就是规则，规则相当于一个条件组合，一个规则下附带一个条件列表，在生成规则表达式时，条件列表中的所有条件将自动进行组合。

规则集

规则集是规则引擎执行的对象，一个规则集下包含一个或多个规则，默认添加的规则集处于RulesetMode.BUILDING模式，表示当前的规则集表达式未生成，规则集处于不可用状态。当规则集下存在规则，并且每个规则下存在条件时，规则集自动切换为RulesetMode.BUILT模式，并且生成规则集表达式。

使用示例

一个计算费用、费率的简单示例

如下为一个产品费率计算规则：

年龄（AGE）	额度（AMT）	费用（PREM）	费率（RATE）‰
0~3岁	1000000	67.9	0.0679
4~11岁	1000000	198.2	0.1982
12岁	1000000	18	0.018

需要按上述规则，通过年龄、额度来动态计算0~12岁的儿童产品的费用和费率。

添加规则集

指定规则集编码为RULEST_RATE_CALC，参数如下：

{
    "code": "RULEST_RATE_CALC",
    "name": "ruleset for rate calculate"
}

在当前规则集下添加规则

定义返回值集合，用于接收规则引擎执行的返回值，例如PREM:67.9,RATE:0.0679，含义就是如果满足规则对应的条件，就返回一个map集合：

{
    "PREM": 67.9,
    "RATE": 0.0679
}

通过返回值集合中定义的返回值变量名PREM和RATE，可以从map集合中获取对应的值。

在当前例子中，需要添加三组规则，参数如下：

{
    "rulesetId": 2,
    "name": "rule for age(0-3)",
    "returnValues": "PREM:67.9,RATE:0.0679"
}

{
    "rulesetId": 2,
    "name": "rule for age(4-11)",
    "returnValues": "PREM:198.2,RATE:0.1982"
}

{
    "rulesetId": 2,
    "name": "rule for age(12)",
    "returnValues": "PREM:18,RATE:0.018"
}

在每个对应规则下添加条件

rule for age(0-3)

[
    {
        "ruleId": 2,
        "name": "children age lower",
        "variableName": "AGE",
        "referenceValue": "0",
        "relationType": "GREATER_EQUAL",
        "logicType": "AND",
        "priority": 10
    },
    {
        "ruleId": 2,
        "name": "children age upper",
        "variableName": "AGE",
        "referenceValue": "3",
        "relationType": "LESS_EQUAL",
        "logicType": "AND",
        "priority": 9
    },
    {
        "ruleId": 2,
        "name": "amount total",
        "variableName": "AMT",
        "referenceValue": "1000000",
        "relationType": "EQUAL",
        "logicType": "AND",
        "priority": 8
    }
]

rule for age(4-11)

[
    {
        "ruleId": 4,
        "name": "children age lower",
        "variableName": "AGE",
        "referenceValue": "4",
        "relationType": "GREATER_EQUAL",
        "logicType": "AND",
        "priority": 10
    },
    {
        "ruleId": 4,
        "name": "children age upper",
        "variableName": "AGE",
        "referenceValue": "11",
        "relationType": "LESS_EQUAL",
        "logicType": "AND",
        "priority": 9
    },
    {
        "ruleId": 4,
        "name": "amount total",
        "variableName": "AMT",
        "referenceValue": "1000000",
        "relationType": "EQUAL",
        "logicType": "AND",
        "priority": 8
    }
]

rule for age(12)

[
    {
        "ruleId": 5,
        "name": "children age",
        "variableName": "AGE",
        "referenceValue": "12",
        "relationType": "EQUAL",
        "logicType": "AND",
        "priority": 10
    },
    {
        "ruleId": 5,
        "name": "amount total",
        "variableName": "AMT",
        "referenceValue": "1000000",
        "relationType": "EQUAL",
        "logicType": "AND",
        "priority": 9
    }
]

生成规则表达式

添加规则集、规则、条件之后，自动生成规则表达式如下：

let rmap = seq.map();
if((AGE >= 0 && AGE <= 3) && AMT == 1000000){
seq.put(rmap, 'PREM', 67.9);
seq.put(rmap, 'RATE', 0.0679);
}
elsif((AGE >= 4 && AGE <= 11) && AMT == 1000000){
seq.put(rmap, 'PREM', 198.2);
seq.put(rmap, 'RATE', 0.1982);
}
elsif(AGE == 12 && AMT == 1000000){
seq.put(rmap, 'PREM', 18);
seq.put(rmap, 'RATE', 0.018);
}
return rmap;

另外，对于所有浮点数类型的入参和出参，在AviatorScript实际执行上述表达式时，会将所有浮点数都解析为decimal，保证高精度运算的要求。（在默认配置的引擎实例中已开启此配置项Options.ALWAYS_PARSE_FLOATING_POINT_NUMBER_INTO_DECIMAL）。

执行规则集

假设现在要计算年龄为9岁的儿童，额度为1000000时的费用和费率，规则引擎请求参数为：

{
    "rulesetCode": "RULEST_RATE_CALC",
    "paraMap": {
        "AGE": 9,
        "AMT": 1000000
    }
}

规则引擎返回结果：

{
    "status": 200,
    "success": true,
    "message": null,
    "body": {
        "RATE": 0.1982,
        "PREM": 198.2
    }
}

接口调用

在服务中，调用接口方式如下：

@Autowired
private RuleCoreService ruleCoreService;

Map<String, Object> paraMap = new HashMap<>();
paraMap.put("AGE", 9);
paraMap.put("AMT", 1000000);
String rulesetCode = "RULEST_RATE_CALC";
Map<String, Object> resultMap = ruleCoreService.executeRuleset(rulesetCode, paraMap);

System.out.println("费用：" + resultMap.get("PREM"));// 198.2
System.out.println("费率：" + resultMap.get("RATE"));// 0.1982

或者通过外部接口直接调用/executeRuleset。

接口说明

项目中主要有两大类接口，包括外部请求接口和内部管理接口。

外部请求接口

执行规则集

/executeRuleset

内部管理接口

查询所有逻辑运算类型

/logicTypeMap

查询所有关系运算类型

/relationTypeMap

查询规则集（分页）

/findRulesetInfoPage

查询规则集下的所有规则（分页）

/findRuleInfoPage

查询规则下的所有条件（分页）

/findConditionInfoPage

保存规则集

/saveRulesetInfo

删除规则集

/deleteRulesetInfo

保存规则

/saveRuleInfo

删除规则

/deleteRuleInfo

保存规则下的所有条件

/saveConditionInfoList

刷新规则集

/refreshRuleset

使用说明

建议将本项目部署为独立的服务。数据库及相关服务配置请修改配置文件。

在服务部署前，请在配置的数据库中创建数据表。

目前规则维护仅提供内部管理接口，建议按照：规则集->规则->条件的顺序进行配置。

CVEDetect / aviator-rule-engine