Drools规则引擎的基本使用

Drools规则引擎的基本使用

1、概述

规则引擎是一种嵌入在应用程序中的组件，实现了将业务决策从应用程序代码中分离出来，并使用预定义的语义模块编写业务决策。接受数据输入，解释业务规则，并根据业务规则做出业务决策。

Drools是一个基于java的规则引擎，开源的，可以将复杂多变的规则从硬编码中解放出来，以规则脚本的形式存放在文件中，使得规则的变更不需要修正代码重启机器就可以立即在线上环境生效。
其前身是 Codehaus 的一个开源项目叫 Drools，最近被纳入 JBoss 门下，更名为 JBoss Rules，成为了 JBoss 应用服务器的规则引擎。

常见规则引擎:
IBM的iLog，商业产品
Drools，开源
最近比较火的FLink CEP，开源
Easy Rule，开源
阿里的qlexpress，开源

2、工作机制

左边是规则，右边是事实(数据)，中间就是执行器(决策引擎)

在 Drools 中，规则被存放在 Production Memory（规则库）中，要匹配的facts（事实）被存在 Working Memory（工作内存）中。当时facts被插入到工作内存中后，规则引擎会把事实和规则库里的模式进行匹配；

对于匹配成功的规则再由 Agenda 负责具体执行推理算法中被激发规则的结论部分，同时 Agenda 通过冲突决策策略管理这些冲突规则的执行顺序，Drools 中规则冲突决策策略有：(1) 优先级策略 (2) 复杂度优先策略 (3) 简单性优先策略 (4) 广度策略 (5) 深度策略 (6) 装载序号策略 (7) 随机策略

3、基本使用

Kmodule配置

<?xml version="1.0" encoding="utf-8" ?>
<kmodule xmlns="http://www.drools.org/xsd/kmodule">
    <kbase name="rules">
        <ksession name="all-rules"></ksession>
    </kbase>
</kmodule>

Fact类：

@Data
public class Applicant {
    private String name;
    private int age;
    private boolean valid;
​
    public Applicant(String name, int age) {
        this.name = name;
        this.age = age;
        this.valid = true;
    }
}
​
public class Action {
    private String msg;
​
    public Action(String msg) {
        this.msg = msg;
    }
​
    public void doSomeThing() {
        System.out.println(msg);
    }
}

规则模板DRL文件

package cn.yyds.demo.droolsdemo.rules
​
// 导包
import cn.yyds.demo.droolsdemo.Applicant
import cn.yyds.demo.droolsdemo.Action;
​
rule "age if valid"  // rule名称
when  // 触发判断条件
  $a: Applicant(age < 18)
then  // 满足条件后要执行的逻辑
  $a.setValid(false); // 可以执行任何java代码（对输入的对象调用方法）
  new Action("执行动作").doSomeThing(); //可以执行任何java代码（创建对象调方法）
  insert(new Action("不合法")); //可以继续给容器插入对象，以触发其他规则
end

测试代码:

public class TestApp {
    public static void main(String[] args) {
        KieServices kieServices = KieServices.Factory.get();
        //默认自动加载 META-INF/kmodule.xml
        KieContainer kieContainer = kieServices.getKieClasspathContainer();
        //kmodule.xml 中定义的 ksession name
        KieSession kieSession = kieContainer.newKieSession("all-rules");
        Applicant applicant = new Applicant("Mr John Smith", 17);
        kieSession.insert(applicant);
        kieSession.fireAllRules();
        kieSession.dispose();
    }
}

依赖：

<dependency>
    <groupId>org.drools</groupId>
    <artifactId>drools-compiler</artifactId>
    <version>7.23.0.Final</version>
</dependency>

4、语法

规则文件可以使用 .drl文件，也可以是 .xml 文件，这里我们使用drl文件。

package cn.yyds.drools.rules;
import java.util.List;
rule "name"
   no-loop true
​
   when
           $message:Message(status == 0)
   then
           System.out.println("fit");
           $message.setStatus(1);
           update($message);

1、基本定义语法

package： 对一个规则文件而言，package是必须定义的，必须放在规则文件第一行。特别的是，package的名字是随意的，不必必须对应物理路径，跟java的package的概念不同，这里只是逻辑上的一种区分。同样的package下定义的function和query等可以直接使用。
比如：package com.drools.demo.point

import： 导入规则文件需要使用到的外部变量，这里的使用方法跟java相同，但是不同于java的是，这里的import导入的不仅仅可以是一个类，也可以是这个类中的某一个可访问的静态方法。

比如：

import com.drools.demo.point.PointDomain;
import com.drools.demo.point.PointDomain.getById;

rule： 定义一个规则。rule “ruleName”。一个规则可以包含三个部分：
属性部分：定义当前规则执行的一些属性等，比如是否可被重复执行、过期时间、生效时间等。
条件部分，即LHS，定义当前规则的条件，如 when Message(); 判断当前workingMemory中是否存在Message对象。
结果部分，即RHS，这里可以写普通java代码，即当前规则条件满足后执行的操作，可以直接调用Fact对象的方法来操作应用。

2、属性定义ATTRIBUTE

no-loop : 定义当前的规则是否不允许多次循环执行，默认是false，也就是当前的规则只要满足条件，可以无限次执行。什么情况下会出现一条规则执行过一次又被多次重复执行呢？drools提供了一些api，可以对当前传入workingMemory中的Fact对象进行修改或者个数的增减，比如上述的update方法，就是将当前的workingMemory中的Message类型的Fact对象进行属性更新，这种操作会触发规则的重新匹配执行，可以理解为Fact对象更新了，所以规则需要重新匹配一遍，那么疑问是之前规则执行过并且修改过的那些Fact对象的属性的数据会不会被重置？结果是不会，已经修改过了就不会被重置，update之后，之前的修改都会生效。当然对Fact对象数据的修改并不是一定需要调用update才可以生效，简单的使用set方法设置就可以完成，这里类似于java的引用调用，所以何时使用update是一个需要仔细考虑的问题，一旦不慎，极有可能会造成规则的死循环。上述的no-loop true，即设置当前的规则，只执行一次，如果本身的RHS部分有update等触发规则重新执行的操作，也不要再次执行当前规则。

但是其他的规则会被重新执行，岂不是也会有可能造成多次重复执行，数据紊乱甚至死循环？答案是使用其他的标签限制，也是可以控制的：lock-on-active true

lock-on-active true：通过这个标签，可以控制当前的规则只会被执行一次，因为一个规则的重复执行不一定是本身触发的，也可能是其他规则触发的，所以这个是no-loop的加强版。当然该标签正规的用法会有其他的标签的配合，后续提及。

date-expires：设置规则的过期时间，默认的时间格式：“日-月-年”，中英文格式相同，但是写法要用各自对应的语言，比如中文：“29-七月-2010”，但是还是推荐使用更为精确和习惯的格式，这需要手动在java代码中设置当前系统的时间格式，后续提及。属性用法举例：date-expires “2011-01-31 23:59:59” // 这里我们使用了更为习惯的时间格式

date-effective：设置规则的生效时间，时间格式同上。

duration：规则定时，duration 3000 ，3秒后执行规则

salience：优先级，数值越大越先执行，这个可以控制规则的执行顺序。

其他的属性可以参照相关的api文档查看具体用法，此处略。

3、条件部分LHS

when：规则条件开始。条件可以单个，也可以多个，多个条件一次排列，比如

 when
         eval(true)
         $customer:Customer()
         $message:Message(status==0)

上述罗列了三个条件，当前规则只有在这三个条件都匹配的时候才会执行RHS部分，三个条件中第一个
eval(true)：是一个默认的api，true 无条件执行，类似于 while(true)

$message:Message(status==0) 这句话标示的：当前的workingMemory存在Message类型并且status属性的值为0的Fact对象，这个对象通常是通过外部java代码插入或者自己在前面已经执行的规则的RHS部分中insert进去的。

前面的$message代表着当前条件的引用变量，在后续的条件部分和RHS部分中，可以使用当前的变量去引用符合条件的FACT对象，修改属性或者调用方法等。可选，如果不需要使用，则可以不写。

条件可以有组合，比如：

Message(status==0 || (status > 1 && status <=100))

RHS中对Fact对象private属性的操作必须使用getter和setter方法，而LHS中则必须要直接用.的方法去使用，比如

$order:Order(name=="qu")
$message:Message(status==0 && orders contains $order && $order.name=="qu")

特别的是，如果条件全部是 &&关系，可以使用“,”来替代，但是两者不能混用

如果现在Fact对象中有一个List，需要判断条件，如何判断呢？

看一个例子，有如下Message类fact对象
Message {
int status;
List names;
}
判断条件：
$message:Message(status==0 && names contains “网易” && names.size >= 1)
上述的条件中，status必须是0，并且names列表中含有“网易”并且列表长度大于等于1
contains：对比是否包含操作，操作的被包含目标可以是一个复杂对象也可以是一个简单的值。
Drools提供了十二中类型比较操作符：

= < <= == != contains / not contains / memberOf / not memberOf /matches/ not matches
not contains：与contains相反。
memberOf：判断某个Fact属性值是否在某个集合中，与contains不同的是他被比较的对象是一个集合，而contains被比较的对象是单个值或者对象。
not memberOf：正好相反。
matches：正则表达式匹配，与java不同的是，不用考虑’/'的转义问题
not matches:正好相反。

4、结果部分RHS

当规则条件满足，则进入规则结果部分执行，结果部分可以是纯java代码，比如：

then
       System.out.println("OK"); //会在控制台打印出ok
end

当然也可以调用Fact的方法，比如 $message.execute();操作数据库等等一切操作。
结果部分也有drools提供的方法：
insert：往当前workingMemory中插入一个新的Fact对象，会触发规则的再次执行，除非使用no-loop限定；
update： 更新
modify： 修改，与update语法不同，结果都是更新操作
retract： 删除

RHS部分除了调用Drools提供的api和Fact对象的方法，也可以调用规则文件中定义的方法，方法的定义使用 function 关键字

function void console {
   System.out.println();
   StringUtils.getId();// 调用外部静态方法，StringUtils必须使用import导入，getId()必须是静态方法
}

5、类声明declare

Drools还有一个可以定义类的关键字：
declare 可以再规则文件中定义一个class，使用起来跟普通java对象相似，你可以在RHS部分中new一个并且使用getter和setter方法去操作其属性。

declare Address
  @author(quzishen) // 元数据，仅用于描述信息
  @createTime(2011-1-24)
  city : String @maxLengh(100)
  postno : int
end

上述的’@'是什么呢？是元数据定义，用于描述数据的数据~，没什么执行含义
可以在RHS部分中使用Address address = new Address()的方法来定义一个对象。