drools API

drools API 开发步骤

1. 获取KieServices，提供一个类名
2. 有了Service，获取KieContainer容器，容器的对象
3. 有了容器来获取KieSession，session就是会话，学的很多技术都有会话的概念
4. Insert fact 字面翻译就是事实对象，现在可以理解为普通的javabean，使用session来操作这个对象
5. 规则引擎触发规则，规则触发后产生一些结果，这些都是在规则引擎内部执行的
6. 最后把KieSession关闭掉

drools-基础语法

文件构成

在使用Drools时非常重要的一个工作就是编写规则文件，通常规则文件的后缀为.drl。 在上节入门案例里面也写过drl。drl是Drools Rule Language的缩写【翻译就是Drools 规则语言的缩写】在规则文件中编写具体的规则内容。一套完整的规则文件内容构成如下

Drools支持的规则文件,除了drl形式，还有Excel文件类型的。终极目标不是用静态文件，是通过动态进行配置规则。

语法结果

规则体是规则文件内容中的重要组成部分，是进行业务规则判断、处理业务结果的部分。
规则体语法结构如下:

rule "ruleName"
    attri butes 
    when
            LHS
    then
            RHS
end

1. rule ： 关键字，表示规则开始，参数为规则的唯一名称
2. attributes： 规则属性，是rule与when之间的参数，为可选项
3. when： 关键字，后面跟规则的条件部分
4. LHS(Left Hand Side) : 是规则的条件部分的通用名称。它由零个或多个条件元素组成。如果LHS为空，则它将被视为始终为true的条件元素。 （左手边）
5. then : 关键字，后面跟规则的结果部分
6. RHS(Right Hand Side): 是规则的后果或行动部分的通用名称。 （右手边）
7. end: 关键字，表示一个规则结束

注释

类似写java和xml文件加入的注释，使用起来跟java一样的。 在 drl 形式的规则文件中使用注释和Java类中使用注释一致，分为单行注释和多行注释。 单行注释用//进行标记，多行注释以/*开始，以*/结束

//规则rule1的注释，这是一个单行注释
rule "rule1"
    when
    then
        System.out.println("rule1触发");
end

/*
规则rule2的注释，
这是一个多行注释
*/
rule "rule2"
    when
    then
        System.out.println("rule2触发");
end

模式匹配

rools中的匹配器可以将Rule Base中的所有规则与Working Memory中的Fact对象进行模式匹配，那么我们就需要在规则体的LHS部分定义规则并进行模式匹配。LHS部分由一个或者多个条件组成，条件又称为pattern

pattern的语法结构为：绑定变量名:Object(Field约束)

其中绑定变量名可以省略，通常绑定变量名的命名一般建议以$开始。如果定义了绑定变量名，就可以在规则体的RHS部分使用此绑定变量名来操作相应的Fact对象。Field约束部分是 需要返回true或者false的0个或多个表达式

1、工作内存中必须存在Attendance这种类型的Fact对象-----类型约束
2、Fact对象的lateTime属性值必须小于30------属性约束
以上条件必须同时满足当前规则才有可能被激活

绑定变量既可以用在对象上，也可以用在对象的属性上

LHS部分还可以定义多个pattern，多个pattern之间可以使用and或者or进行连接，也可以不写，默认连接为and

比较操作符

Drools提供的比较操作符，之前的实例也使用过比较操作符

contains | not contains语法结构
Object(Field[Collection/Array] contains value)
Object(Field[Collection/Array] not contains value)

memberOf | not memberOf语法结构
Object(field memberOf value[Collection/Array])
Object(field not memberOf value[Collection/Array])

matches | not matches语法结构
Object(field matches “正则表达式”)
Object(field not matches “正则表达式”)

注意: contain是前面包含后面，memberOf是后面包含前面。

第一步，fact传递输入输出类

第二步，在/resources/rules下创建规则文件comparisonOperator.drl

第三步，测试类编写

执行结果

规则制定

之前调用过fireAllRules(); 触发规则，根据前面说过的进行模式匹配，只要匹配成功的所有规则都被执行。下图这个是调用的方法，但是还有个参数的形式，agendaFilter的实现类有几个。里面有个
RuleNameEqualsAgendaFilter指定某个规则名称

Drools给我们提供的方式是通过规则过滤器来实现执行指定规则。对于规则文件不用做任何修改，只需要修改Java代码即可

指定了规则，也不见得这个规则一定执行，还要看这个规则是否匹配成功，才能确定规则是否执行。

关键字

Drools的关键字分为：硬关键字(Hard keywords)和软关键字(Soft keywords)

硬关键字是我们在规则文件中定义包名或者规则名时明确不能使用的，否则程序会报错。软关键字虽然可以使用，但是不建议使用

硬关键字包括：true false null

软关键字【可能还不太熟悉，其实就是在编写规则文件的时候用到的一些属性】包括：lock-on-active date-effective date-expires no-loop auto-focus activation-group agenda-group ruleflow-group entry-point duration package import dialect salience enabled attributes rule extend when then template query declare function global eval not in or and exists forall accumulate collect from action reverse result end over init

比如：
rule false //不可以
rule “false” //可以

内置方法

规则文件的RHS部分的主要作用是通过插入，删除或修改工作内存中的Fact数据引用，来达到控制规则引擎执行的目的。Drools提供了一些方法可以用来操作工作内存中的数据，操作完成后规则引擎会重新进行相关规则的匹配，原来没有匹配成功的规则在我们修改数据完成后有可能就会匹配成功了

update：update方法的作用是更新工作内存中的数据，并让相关的规则重新匹配。 （要避免死循环）

第一步：编写规则文件
/resources/rules/student.drl

第二步：编写单元测试文件

输出可以看到规则文件中定义的三个规则都触发了。在更新数据时需要注意防止发生死循环

insert ：insert方法的作用是向工作内存中插入数据，并让相关的规则重新匹配

第一步：java的实体Teacher

第二步：编写规则文件
/resources/rules/teacher.drl

第三步：编写单元测试文件

四个规则都触发了，这是因为首先进行规则匹配时只有第一个规则可以匹配成功，但是在第一个规则中向工作内存中插入了一个数据导致重新进行规则匹配，此时第二个规则可以匹配成功。在第二个规则中进行了数据修改导致第三个规则也可以匹配成功，以此类推最终四个规则都匹配成功并执行了

retract方法：retract方法的作用是删除工作内存中的数据，并让相关的规则重新匹配

第一步：java的实体Girl

第二步：编写规则文件/resources/rules/girl.drl

第三步：编写单元测试

drools-规则属性

规则文件的构成

rule 定义规则体的开始，后面跟的规则名称，后面在跟的是规则的属性，前面的专题实例没有提到过属性，后面when 跟的LHS，then跟的RHS部分，end结束

rule "ruleName"
    attributes
    when
        LHS
    then
        RHS
end

这个章节主要说的属性，attributes出现的位置就是rule 和 when之间的

部分常用的属性

enabled属性

enabled属性对应的取值为true和false，默认值为true。用于指定当前规则是否启用，如果设置的值为false则当前规则无论是否匹配成功都不会触发

dialect属性

dialect属性用于指定当前规则使用的语言类型，取值为java和mvel，默认值为java。
注：mvel是一种基于java语法的表达式语言。
mvel像正则表达式一样，有直接支持集合、数组和字符串匹配的操作符。
mvel还提供了用来配置和构造字符串的模板语言。
mvel表达式内容包括属性表达式，布尔表达式，方法调用，变量赋值，函数定义等

salience属性

前面也接触到，salience属性用于指定规则的执行优先级，执行的顺序，取值类型为Integer。数值越大越优先执行。每个规则都有一个默认的执行顺序，如果不设置salience属性，规则体的执行顺序为由上到下。可以通过创建规则文件salience.drl来测试salience属性

没有设置优先级的情况是这样执行的

设置了优先级的情况下是这样的。数值越大，越先执行

no-loop属性

no-loop属性用于防止死循环，当规则通过update之类的函数修改了Fact对象时，可能使当前规则再次被激活从而导致死循环。取值类型为Boolean，默认值为false

调用update方法、 insert方法、retract方法 重新匹配容易产生死循环

解决方法：通过控制台可以看到，由于我们没有设置no-loop属性的值，所以发生了死循环。接下来设置no-loop的值为true再次测试则不会发生死循环

注意：no-loop解决不了多规则文件间的死循环。

activation-group属性

激活分组，取值为String类型。具有相同分组名称的规则只能有一个规则被触发。规则分组后，只执行一个

不加入activation-group分组的话，两个都执行

加入分组后，看看执行情况，只执行了一条

这个属性添加后只执行一条可以理解，但是为什么只执行了上面的不执行下面这个，可以这样解释，在没有设置优先级的情况下，它的执行规则是从上往下来进行执行的

上面的两个规则因为属于同一个分组，所以只有一个触发了。同一个分组中的多个规则如果都能够匹配成功，具体哪一个最终能够被触发可以通过salience属性确定

agenda-group属性

议程分组，属于另一种可控的规则执行方式。用户可以通过设置agenda-group来控制规则的执行，只有获取焦点的组中的规则才会被触发。说白了需要在代码里面获取指定的名称的分组，这样组才能被触发

进行分组

单元测试代码
//设置焦点，对应agenda-group分组中的规则才可能被触发
kieSession.getAgenda().getAgendaGroup(“myagendagroup_1”).setFocus();

执行结果

只有获取焦点的分组中的规则才会触发。与activation-group不同的是，activation-group定义的分组中只能够有一个规则可以被触发，而agenda-group分组中的多个规则都可以被触发。如果when不满足，就算设置了焦点也不执行

auto-focus属性

自动获取焦点，取值类型为Boolean，默认值为false。一般结合agenda-group属性使用，当一个议程分组未获取焦点时，可以设置auto-focus属性来控制

drl文件中设置自动获取焦点的属性

置auto-focus属性为true的规则都触发了。不用java的方式

如果规则属于同一个组，写一个auto-focus就可以了，也就是说同一组只有有一个设置了auto-focus等于true，其他都会设置对应的焦点，不管是设置了false 还是不设置。但是可读性可能不太好，建议都写，方便阅读

timer属性

timer属性可以通过定时器的方式指定规则执行的时间，使用方式有两种：

timer (int: ?)

此种方式遵循java.util.Timer对象的使用方式，第一个参数表示几秒后执行，第二个参数表示每隔几秒执行一次，第二个参数为可选

timer(cron: )

此种方式使用标准的unix cron表达式的使用方式来定义规则执行的时间

规则文件编写drl

指定代码，必须修改。因为目前是通过单元测试来运行的，如果是tomcat容器就不存在这个问题了

运行规则

date-effective

属性用于指定规则的生效时间，即只有当前系统时间大于等于设置的时间或者日期规则才有可能触发。默认日期格式为：dd-MMM-yyyy。用户也可以自定义日期格式

上面的代码需要设置日期格式，否则我们在规则文件中写的日期格式和默认的日期格式不匹配程序会报错

date-expires

date-expires属性用于指定规则的失效时间，即只有当前系统时间小于设置的时间或者日期规则才有可能触发。默认日期格式为：dd-MMM-yyyy。用户也可以自定义日期格式。跟上边类似，只是这个是失效时间

上面的代码需要设置日期格式，否则我们在规则文件中写的日期格式和默认的日期格式不匹配程序会报错

drools-高级语法global

介绍

global关键字用于在规则文件中定义全局变量，它可以让应用程序的对象在规则文件中能够被访问。可以用来为规则文件提供数据或服务

语法结构

global 对象类型 对象名称

注意点

1. 如果对象类型为包装类型是【java.until.* 这些都属于包装类】，在一个规则中改变了global的值，那么只针对当前规则有效，对其他规则中的global不会有影响。可以理解为它是当前规则代码中的global副本，规则内部修改不会影响全局的使用
2. 如果对象类型为集合类型或JavaBean时，在一个规则中改变了global的值，对java代码和所有规则都有效

创建一个drl文件演示，验证包装类的全局变量

定义2个规则，方便看出效果，修改全局的变量，看看下个规则值是不是改变了。count的初始值由java来进行创建。写这个例子就是为了判断在第一个规则里面改变了count的值，在第二个规则里面看count是不是发生了改变

第一个规则执行后count是15，第二个规则执行后count是5，

第三个定义一个集合的drl，并设置初始值，第四个规则集合里面的数量是否有变化

单元测试的结果，已经添加完毕了，在第四个规则里面还存在数量的变化。一旦对这个变量发生改变，任何其他地方都会受到影响

定义个javabean的方式。看是否发生改变。

![img](../../img/088e05112a2

指定drl中的那个规则执行

目前drl太多了，控制台打印的东西太乱了，不好控制

// 指定某种规则开头的规则名称

 kieSession.fireAllRules(new RuleNameStartsWithAgendaFilter("rule_global"));

PS：排除干扰只执行需要看结果的字段。今天全部变量的使用讲解完了，下次咱们说说查询Query

drools-高级语法query

介绍

query查询提供了一种查询working memory中符合约束条件的Fact对象的简单方法。它仅包含规则文件中的LHS部分，不用指定“when”和“then”部分并且以end结束

语法结构

query 查询的名称(可选参数)
    LHS
end

java调用类

不仅仅返回fact的对象的数量，还能具体地返回这fact。通过遍历的方式可以取到

第一个查询没有参数，第二个查询里面有参数的。
kieSession.getQueryResults(“query_2”,“王五”); 这个方式就是传递参数，可以传递多个

drools-高级语法function

介绍

function关键字用于在规则文件中定义函数，就相当于java类中的方法一样。可以在规则体中调用定义的函数。使用函数的好处是可以将业务逻辑集中放置在一个地方，根据需要可以对函数进行修改

语法结构

function 返回值类型 函数名(可选参数){
    //逻辑代码
}

调用步骤

function.drl

编写单元测试

PS：本节讲述的内容主要是query查询内存中的对象，function是为了方便自定义一些函数，调用的时候使用

drools-LHS部分

在规则体中的LHS部分是介于when和then之间的部分。主要用于模式匹配，只有匹配结果为true时，才会触发RHS部分的执行。本节我们会针对LHS部分学习几个新的用法

复合值限制in/not in

介绍

复合值限制是指超过一种匹配值的限制条件，类似于SQL语句中的in关键字。Drools规则体中的LHS部分可以使用in或者not in进行复合值的匹配

语法结构

Object(field in (比较值1,比较值2...))

例子

$s:Student(name in ("三三","四四","五五"))
$s:Student(name not in ("三三","四四","五五"))

创建规则文件

创建lhs.drl

测试类

条件元素eval

介绍

eval用于规则体的LHS部分，并返回一个Boolean类型的值

语法

eval(true)
eval(false)
eval(1 == 1)

编写drl

运行测试类

条件元素not

介绍

not用于判断Working Memory中是否存在某个Fact对象，如果不存在则返回true，如果存在则返回false

语法结构

not Object(可选属性约束)
not Student()
not Student(age < 10)

drl

测试类

条件元素exists

介绍

exists的作用与not相反，用于判断Working Memory中是否存在某个Fact对象，如果存在则返回true，不存在则返回false

语法结构

exists Object(可选属性约束)
exists Student()
exists Student(age < 10 && name != null)

疑问

可能有人会有疑问，我们前面在LHS部分进行条件编写时并没有使用exists也可以达到判断Working Memory中是否存在某个符合条件的Fact元素的目的，那么我们使用exists还有什么意义？当向Working Memory中加入多个满足条件的Fact对象时，使用了exists的规则执行一次，不使用exists的规则会执行多次

测试类

工作内存中有2个student的对象，发现规则：rule_lhs_6触发了。。。 打印了2次

继承extends

介绍

规则之间可以使用extends关键字进行规则条件部分的继承，类似于java类之间的继承。

规则drl

测试类

PS：LHS加强大概说完了，下次一起说说RHS加强。

drools-RHS部分

RHS部分是规则体的重要组成部分，当LHS部分的条件匹配成功后，对应的RHS部分就会触发执行。一般在RHS部分中需要进行业务处理。在RHS部分Drools为提供了一个内置对象，名称就是drools

halt

介绍

halt方法的作用是立即终止后面所有规则的执行。

语法

drools.halt();

drl文件

测试类

因为rule_rhs_1 中包含halt 所以 rule_rhs_2 没有被触发

getWorkingMemory

介绍

getWorkingMemory方法的作用是返回工作内存对象。

语法

drools.getWorkingMemory()

drl

测试类

获取工作内存堆存，本质是一个会话对象session

getRule

介绍

getRule方法的作用是返回规则对象。

语法

drools.getRule()

drl

测试类

规则文件编码规范（重要）

1. 所有的规则文件(.drl)应统一放在一个规定的文件夹中，如：/rules文件夹
2. 书写的每个规则应尽量加上注释。注释要清晰明了，言简意赅
3. 同一类型的对象尽量放在一个规则文件中，如所有Student类型的对象尽量放在一个规则文件中
4. 规则结果部分(RHS)尽量不要有条件语句，如if(…)，尽量不要有复杂的逻辑和深层次的嵌套语句
5. 每个规则最好都加上salience属性，明确执行顺序
6. Drools默认dialect为"Java"，尽量避免使用dialect “mvel”

PS：下节说说大家做java常用的drools和spring的整合。