RuleEngine -- 一款使用简单，入门方便的数据库规则引擎

规则引擎是嵌入在应用程序中的组件，实现了决策逻辑和业务系统的分离功能。在现实业务场景中，决策逻辑的复杂性和可变性，使得决策引擎的应用越来越多，把决策逻辑单独分离出来也显得越来越重要了。

目前市场上常用的规则引擎有Ilog JRules，Drools，Jess，Visual Rules等。Ilog JRules 是最有名的商用BRMS；Drools 是最活跃的开源规则引擎；Jess 是Clips的java实现，就如JRuby之于Ruby，是AI系的代表； Visual Rules（旗正规则引擎）国内商业规则引擎品牌。但是这些规则引擎都需要生成大量的bean类和Judgment类，在实现规则判断的时候，需要编写大量的java代码，或者使用rete规范，另外编写脚本。然后我们实际编程中，这些bean的数据大多数存于数据库中，规则引擎的判断实际上是SQL脚本运行的一部分。

因此在这里介绍一款可以使用SQL脚本来定义规则的中间件 -- RuleEngine。RuleEngine已经登记在Maven中的中央库中了，我们可以直接在POM.xml文件中包含就可以了。

<dependency>

        <groupId>com.github.hale-lee</groupId>

        <artifactId>RuleEngine</artifactId>

        <version>0.1.0</version>

    </dependency>

  使用前，需要先配RuleEngine的配置文件ruleEngine.properties，RuleEngine支持3种规则定义方式，分别是1，数据库table配置；2，xml文件配置；3，Drools的drl文件方式。

在ruleEngine.properties中设置rule.reader字段即可，下面分别说明：

1， 数据库table配置方式，在ruleEngine.properties中，设置rule.reader = database

此时需要配置下面的信息

a)    db.rule.table字段，设置db.rule.table=tl_rule_define（表名）。此表结构的定义在https://github.com/Hale-Lee/RuleEngine/tree/dev/referenc中有定义（有oralce和mysql的2种方式）。

b)    db.accesser数据连接方式，RuleEngine提供了直接的jdbc连接，Druid连接池，Spring框架连接3种方式。 如果使用jdbc链接或者是Druid链接，那么需要设置db.accesser=tech.kiwa.engine.utility.DirectDBAccesser（设置DirectDBAccesser的UseDruid可以区别是否使用Druid连接池，默认是true使用）。如果直接使用Spring框架的连接，那么需要设置db.accesser= tech.kiwa.engine.utility. SpringDBAccesser。

RuleEngine也提供DBAccesser的接口，我们可以通过实现DBAccessor的接口的方法来自己获得自己的连接。

c)    如果使用jdbc链接或者是Druid链接，那么需要配置jdbc属性，或者是Druid的连接池参数，RuleEngine可以独立配置连接池参数，也可以直接使用项目中现有的连接参数。

典型的配置文件的方式如下（使用Druid配置）：

#数据驱动

jdbc.driver=com.mysql.cj.jdbc.Driver

#jdbc.driver=oracle.jdbc.driver.OracleDriver

#数据库连接

jdbc.url=jdbc:mysql://127.0.0.1:3306/hosp?useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&useSSL=true

#数据库用户名

jdbc.username=oracle

jdbc.password=user

#规则定义的表

db.rule.table=TL_RULE_DEFINE

db.accesser=tech.kiwa.engine.utility.DirectDBAccesser

rule.reader=database

数据库表结构的定义如下：

-- Table structure for TL_RULE_DEFINE

 -- ----------------------------

 DROP TABLE "TL_RULE_DEFINE";

 CREATE TABLE "TL_RULE_DEFINE" (

 "ITEM_NO" NVARCHAR2(32) NOT NULL ,

 "CONTENT" NVARCHAR2(256) NULL ,

 "EXE_SQL" NVARCHAR2(512) NULL ,

 "EXE_CLASS" NVARCHAR2(128) NULL ,

 "PARAM_NAME" NVARCHAR2(128) NULL ,

 "PARAM_TYPE" NVARCHAR2(128) NULL ,

 "COMPARISON_CODE" NVARCHAR2(32) NULL ,

 "COMPARISON_VALUE" NVARCHAR2(64) NULL ,

 "BASELINE" NVARCHAR2(64) NULL ,

 "RESULT" NVARCHAR2(6) NULL ,

 "PRIORITY" NVARCHAR2(32) NULL ,

 "CONTINUE_FLAG" NVARCHAR2(2) NULL ,

 "PARENT_ITEM_NO" NVARCHAR2(2) NULL ,

 "PARENT_EXPRESS" NVARCHAR2(256) NULL ,

 "EXECUTOR" NVARCHAR2(64) NULL ,

 "REMARK" NVARCHAR2(64) NULL ,

 "COMMENTS" NVARCHAR2(64) NULL ,

 "ENABLE_FLAG" NVARCHAR2(2) NULL ,

 "CREATE_TIME" TIMESTAMP(6)  NULL ,

 "UPDATE_TIME" TIMESTAMP(6)  NULL

 )

 LOGGING

 NOCOMPRESS

 NOCACHE;



 COMMENT ON TABLE "TL_RULE_DEFINE" IS '规则引擎定义表';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."ITEM_NO" IS '主key';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."CONTENT" IS '中文的内容说明';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."EXE_SQL" IS '执行的SQL语句';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."EXE_CLASS" IS '执行检查的java类名， 与exe_sql二者只填写一项';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."PARAM_NAME" IS 'SQL语句的参数,多个参数用,分割，读值时需要完成和继承DefaultCustomerCheck类。';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."PARAM_TYPE" IS 'exe_sql或者exe_class的参数类型，多个类型用逗号（,）分割，与param_name需一一对应。';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."COMPARISON_CODE" IS '01: = ，  02: > ， 03 : < ， 04 != ， 05 >= ， 06: <= ， 07 include ， 08 exclude ， 09: included by 10: excluded by  11: equal , 12 : not equal 13: euqalIngoreCase 15: matches 16: NOT MATCHES';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."COMPARISON_VALUE" IS '=,>,<,>=,<=, !=, include, exclude等内容。';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."BASELINE" IS '参数值，比较目标值';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."RESULT" IS '1 - 通过  2 - 关注 3 -拒绝  逻辑运算满足目标值的时候读取改内容。';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."PRIORITY" IS '执行的优先顺序，值大的优先执行.';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."CONTINUE_FLAG" IS '是否继续执行下一条，如果某条规则满足中断的话，那么就设置为 2. 1 -- 继续  2 -- 中断';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."PARENT_ITEM_NO" IS '如果是子规则，那么需要填写父规则的item_no';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."PARENT_EXPRESS" IS '同一PARENT_ITEM的各个ITEM的运算表达式。 ( A AND B OR C)';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."EXECUTOR" IS '结果执行后的被执行体，从AbstractCommand中继承下来。';

 COMMENT ON COLUMN "TL_RULE_DEFINE"."ENABLE_FLAG" IS '是否使用 1 - 有效  2 - 失效';


 -- ----------------------------

 -- Checks structure for table TL_RULE_DEFINE

 -- ----------------------------

 ALTER TABLE "TL_RULE_DEFINE" ADD CHECK ("ITEM_NO" IS NOT NULL);


其说明可以参考:


2， xml文件配置，xml文件配置的方式也需要在ruleEngine.properties中配置引擎的读写方式。仅仅配置两项内容即可。

rule.reader=xml

#指定规则文件的文件名，RuleEngine会从classpath中搜索该文件。

xml.rule.filename=ruleconfig.xml

XML文件的写法与table类似，典型的xml文件格式为：

<?xml version="1.0" encoding="UTF-8"?>

<rules >

  <organization>

      <url>www.keaitupian.com</url>

  </organization>

    <description>

        Configuration for the rule list which stores the rule information in-memory and executed by rule engine service.

    </description>

    <rule id="totallist" exe_class="" method="" parent="">

        <property name="content" value="客户身份证号码规则"/>

        <property name="result" value="RESULT.REJECTED" desc="拒绝"/>

        <property name="continue_flag" value="1"/>

        <property name="group_express" value="(blacklist || graylist)"/>

      <property name="priority" value="10"/>

    </rule>

    <rule id="blacklist" parent="totallist">

        <property name="content" value="客户身份证号码命中内部黑名单"/>

        <property name="exe_sql" value="select count(1) from customer_black_list where certificate_type >=1 and customer_no = ? and is_black = 1"/>

        <property name="param" value="CUSTOMER_NO" type="java.lang.String" desc="客户编号"/>

        <property name="comparison_code" value="02"/>

        <property name="comparison_value" value="&gt;"/>

        <property name="baseline" value="0"/>

        <property name="baseline_desc" value="客户的身份证号码在黑名单表个数中大于0"/>

    </rule>

    <rule id="graylist" exe_class="" method="" parent="totallist">

        <property name="content" value="客户身份证号码命中内部灰名单"/>

        <property name="exe_sql" value="select count(1) from customer_black_list where certificate_type =1 and customer_no = ? and is_gray = 1"/>

        <property name="param" value="CUSTOMER_NO" type="java.lang.String" desc="客户编号"/>

        <property name="comparison_code" value="02"/>

        <property name="comparison_value" value="&gt;"/>

        <property name="baseline" value="0"/>

        <property name="baseline_desc" value="客户的身份证号码在黑名单表个数中大于0"/>

    </rule>

</rules>

3， Drools文件方式，RuleEngine同样支持读取Drools的drl文件中的规则，并且可以直接执行其规则体。此时需要在ruleEngine.properties中配置引擎的读写方式。仅仅配置两项内容即可。

rule.reader=drools

drools.rule.filename=sample.drl

Drools的文件样式请参考具体Drools的文档，典型的样式为：

#this is a test

package tech.kiwa.engine.entity;

globals java.util.List myGlobalList

import tech.kiwa.engine.sample.Student;

function void callOver(Student $student){

  if($student != null){

  System.out.println("student [" +  $student.name + "] is called.");

  }

}

function void ageUp(Student $student, int age ){

  if($student != null){

  $student.setAge( $student.getAge() + age);

  }

}

declare teacher

  age : int

  name : String

  sex : int

end

query "juniorBoy"

  $student: Student( age <=14 && (age >10 || age !=12 , sex  ==1 || sex == 2 ), name =="tony")

end

query "querymale"(int $gender)

  $student: Student(sex == $gender)

end

rule "ageUp12"

salience 400

when

  $student: Student(age < 8)

  /* antoher rule */

then

  System.out.println("I was called, my name is : " + $student.name);

  ageUp($student,12);

  //callOver($student);

end

rule "isTom"

salience 30

date-expires "2018-12-01"

dialet "java"

when

  $student: Student(name == tom)

then

  $student.sex = 4;

    callOver($student);

end

启动RuleEngine，RuleEngine是针对一个具体的目标对象(Bean)进行检测的，该目标对象（Bean）必须是可读的，必须提供对应的get方法，或者其成员变量是public的。比如学生对象，我们需要检测该学生对象是否符合我们定义的规则。因此，在调用规则引擎前，必须存在该对象，如果有多个对象，那请在循环体中执行该条件。

示例代码如下：

        EngineService service = new EngineService();

        try {

            Student st = new Student();  //建立学生对象

            st.setAge(5);

            st.name = "tom";

            st.sex = 1;

            EngineRunResult result = service.start(st);

            System.out.println(result.getResult().getName());

            System.out.println(st.getAge());

        } catch (RuleEngineException e) {

            e.printStackTrace();

        }

上述代码中，Sutdent对象存在getAge方法，因此是可以被访问的，其规则也是可以执行的，否则会抛出RuleEngineException异常，在对应的规则中，执行了ageUp()的Command操作。

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 213,099评论 6赞 492
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,828评论 3赞 387
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 158,540评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,848评论 1赞 285
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,971评论 6赞 385
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,132评论 1赞 291
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,193评论 3赞 412
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,934评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,376评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,687评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,846评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,537评论 4赞 335
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,175评论 3赞 317
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,887评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,134评论 1赞 267
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,674评论 2赞 362
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,741评论 2赞 351

推荐阅读更多精彩内容