URule規則引擎

沒有規則，不成方圓；

一、背景

前段時間，在做專案重構的時候，遇到很多地方需要做很多的條件判斷。當然可以用很多的if-else判斷去解決，但是當時也不清楚怎麼回事，就想玩點別的。於是乎，就去調研了規則引擎。

當然，市面上有很多成熟的規則引擎，功能很多，效能很好。但是，就是想玩點不一樣的（大家做技術選型別這樣，這個是反面教材）。最終一款URule的規則引擎吸引了我，主要還是採用瀏覽器可直接配置，不需要過多安裝，視覺化規則也做的不錯。經過一系列調研，後面就把它接入了專案中，順便記錄下調研的結果。

二、介紹

規則引擎其實是一種元件，它可以嵌入到程式當中。將程式複雜的判斷規則從業務程式碼中剝離出來，使得程式只需要關心自己的業務，而不需要去進行復雜的邏輯判斷；簡單的理解是規則接受一組輸入的資料，透過預定好的規則配置，再輸出一組結果。

當然，市面上有很多成熟的規則引擎，如：Drools、Aviator、EasyRules等等。但是URule，它可以執行在Windows、Linux、Unix等各種型別的作業系統之上，採用純瀏覽器的編輯模式，不需要安裝工具，直接在瀏覽器上編輯規則和測試規則。

當然這款規則引擎有開源和pro版本的區別，至於pro版是啥，懂的都懂，下面放個表格，瞭解下具體的區別

三、安裝使用

實際使用時，有四種使用URule Pro的方式，分別是嵌入式模式、本地模式、分散式計算模式以及獨立服務模式。

但是我們這裡不考慮URule Pro，我們自己整個開源版，在開源版整合springboot的基礎上做一個二次開發，搜了一圈，其實就有解決方案。大致的專案模組如下：

自己建立個空資料庫，只需要在edas-rule-server服務中修改下資料庫的配置，然後啟動服務即可。第一次啟動完成，資料庫中會建立表。

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/urule-data?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&useSSL=false
spring.datasource.username=root
spring.datasource.password=mysql

上面說過，它是純用瀏覽器進行編輯，配置規則的，只需要開啟瀏覽器，輸入地址：http://localhost:8090/urule/frame,看到這個介面，就說明啟動成功了。

四、基礎概念

3.1整體介紹

先說下URule它的構成部分，主要是兩部分：1、設計器部分 2、規則執行引擎。設計器部分主要是庫檔案和規則檔案構成。下面看下整體的結構圖

3.2庫檔案

如上圖介紹的，庫檔案有4種，包括變數庫，引數庫，常量庫和動作庫。其實類似於Java開發的系統中的實體物件，列舉，常量以及方法。

上面說過，規則都是視覺化配置的。在配置規則的過程中，就需要引入各種已經定義好的庫檔案，再結合業務需求，從而配置出符合業務場景的業務規則，所以哪裡都有庫檔案的身影。

3.2.1變數庫檔案

在業務開發中，我們會建立很多Getter和Setter的Java類，比如PO、VO、BO、DTO、POJO等等，其實這些類new物件後主要起到的作用就是資料的載體，用來傳輸資料。

在URule中，變數庫就是用來對映這些物件，然後可以在規則中使用，最終完成業務和規則的互動。最後上一張圖，用來建立變數庫

對了，上面廢話了這麼多視覺化配置，這才是第一次展示配置介面，慚愧慚愧。

上圖一目瞭然，在“庫”這個選單底下右鍵，然後點選新增變數庫即可，最後定義自己喜歡的變數庫名，當然名字只支援中文或者英文，其他字元不可用。

建立完變數庫後，就可以對變數庫進行編輯，可以認為就是給POJO新增屬性

也不彎彎繞繞講什麼術語，就個人理解。圖左邊是建立類，其中名稱是它的別名，配置規則用它代替這個類。圖右邊是類的屬性，我這裡隨便寫了幾個，估計看了懂得都懂。

最後在業務系統中建立對應的類，注意全限定名和配置變數庫的類路徑一致。

package com.cicada;

import com.bstek.urule.model.Label;
import lombok.Data;

/**
 * @author 往事如風
 * @version 1.0
 * @date 2023/3/3 15:38
 * @description
 */
@Data
public class Stu {

    @Label("姓名")
    private String name;

    @Label("年齡")
    private int age;

    @Label("班級")
    private String classes;
}

最後說下這個@Label註解，這個是由URule提供的註解，主要是描述欄位的屬性，跟變數庫的標題一欄一致就行。聽官方介紹可以透過這個註解，實現POJO屬性和變數庫屬性對映。就是POJO寫好，然後對應規則的變數庫就不需要重新寫，可以直接生成。反正就有這個功能，這裡就直接一筆帶過了。

3.2.2常量庫檔案

說到常量庫，這個就可以認為是我們Java系統中的常量，列舉。比如性別，要定義列舉吧；比如對接的機構，也可以定義一個列舉吧。

當然，類似於變數庫，常量庫也可以實現和系統中的列舉相互對映，這樣做的好處可以避免我們手動輸入，防止輸入錯誤。建立常量庫也比較簡單，直接在“庫”這個選單下右鍵，“新增常量庫”。

建立好常量庫檔案後，也會出現如下頁面：

3.2.3引數庫檔案

引數庫，就是URule規則中的臨時變數，變數的型別和數量不固定。可以認為類似於Map，實際上儲存引數庫的也就是個Map。

同樣的套路，直接在“庫”這個選單下右鍵，“新增引數庫”。

可以看到，引數庫已經少了左邊分類這一項，直接新增引數，選擇型別就是幹，相對簡單了很多。“名稱”這列我這裡用了英文，就是Map中的key，而“標題”這列就是在配置規則時候顯示用的，中文看著比較直觀。

當然還需要注意的點是，定義的名稱要保證唯一，因為Map中的key是唯一的，不然就會存在覆蓋的情況。

3.2.4動作庫檔案

動作庫可以對配置在spring中的bean方法進行對映，然後可以在規則中直接呼叫這批方法。
慣用套路，還是在“庫”選單下右鍵，點選“新增動作庫”。

然後我在系統中新增了一個類Action，然後在類上標記@Component註解，將該類交給spring的bean容器管理。該類中新增一些方法，在方法上標記@ExposeAction註解，該註解是URule定義的，說明被標記的方法都會被動作庫讀取到。

package com.bstek.urule.cicada;

import com.bstek.urule.action.ActionId;
import com.bstek.urule.model.ExposeAction;
import org.springframework.stereotype.Component;

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * @author 往事如風
 * @version 1.0
 * @date 2023/3/10 13:59
 * @description
 */
@Component("action")
public class Action {

    @ActionId("Hello")
    public String hello(){
        return "hello";
    }

    @ExposeAction(value="方法1")
    public boolean evalTest(String username){
        if(username==null){
            return false;
        }else if(username.equals("張三")){
            return true;
        }
        return false;
    }

    @ExposeAction(value="測試Int")
    public int testInt(int a,int b){
        return a+b;
    }

    @ExposeAction(value="列印內容")
    public void printContent(String username, Date birthday){
        SimpleDateFormat sd=new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        if(birthday!=null){
            System.out.println(username+"今年已經"+sd.format(birthday)+"歲了!");
        }else{
            System.out.println("Hello "+username+"");
        }
    }
    
    @ExposeAction(value="列印Stu")
    public void printUser(Stu m){
        System.out.println("Hello "+m.getName()+", is age:"+m.getAge());
    }
}

最後在動作庫頁面上新增bean，“Bean Id”一列輸入對應的spring bean的名稱，這裡輸入action。然後點選操作列中的小手按鈕，就會彈出剛在Action類中標記了ExposeAction註解的方法。選擇一個指定的方法新增進來，最後看到方法對應的引數也會被自動載入進去。

最後，變數庫、引數庫、動作庫、常量庫這些庫檔案定義好後，各種規則檔案配置的時候就可以匯入他們。但是一旦這些庫檔案被某個規則檔案使用，就不要隨意修改庫檔案了。

3.3規則集

說到規則集，顧名思義，就是配置規則了。前面定義的庫檔案就需要匯入到規則集中去配置使用。它是使用頻率最高的一個業務規則實現方式。

規則集說的是規則的集合，由三個部分規則組成：如果、那麼、否則。

在規則集的定義的方式上，URule由嚮導式和指令碼式兩種；

• 嚮導式規則集：就是在頁面上透過滑鼠點點點，高度的視覺化配置，不是開發都能懂，這也是這個規則引擎的亮點所在。

• 指令碼式規則集：聽名字就知道了，這玩意要寫指令碼的。拉高配置門檻，需要懂點編碼的人來編寫。

  3.3.1嚮導式規則集

  還是一樣，首先新建。這次是在“決策集”選單上右鍵，點選“新增嚮導式決策集”，這樣就建立好一個規則集了。
  
  在配置規則前，可以先匯入前面定義好的庫檔案。我這裡匯入變數庫檔案，頁面上點選“變數庫”，然後選擇指定的變數庫檔案即可。如圖所示；
  
  最後，可以愉快的配置規則了，嚮導式沒什麼好講的，都是視覺化介面，點點點即可。下面是我配置的一個簡單的規則集；
  
  可以看到由三部分組成：如果、那麼、否則；

1. 如果：配置規則的條件；
2. 那麼：配置滿足條件後執行的動作，一般配置變數賦值比較多
3. 否則：配置不滿足條件執行的動作

最後，附上新增完規則後，透過程式碼去執行規則；

package com.cicada;

import cn.hutool.core.bean.BeanUtil;
import com.Result;
import com.bstek.urule.Utils;
import com.bstek.urule.runtime.KnowledgePackage;
import com.bstek.urule.runtime.KnowledgeSession;
import com.bstek.urule.runtime.KnowledgeSessionFactory;
import com.bstek.urule.runtime.service.KnowledgeService;
import com.cicada.req.StuReq;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.io.IOException;

/**
 * @author 往事如風
 * @version 1.0
 * @date 2023/3/10 16:47
 * @description
 */
@RestController
@RequestMapping("/rule")
public class RuleDataController {

    @PostMapping("/stu")
    public Result rule(@RequestBody StuReq stuReq) throws IOException {
        KnowledgeService knowledgeService = (KnowledgeService) Utils.getApplicationContext().getBean(KnowledgeService.BEAN_ID);
        KnowledgePackage knowledgePackage = knowledgeService.getKnowledge("xxx/xxx");
        KnowledgeSession knowledgeSession = KnowledgeSessionFactory.newKnowledgeSession(knowledgePackage);
        Stu stu = BeanUtil.copyProperties(stuReq, Stu.class);
        knowledgeSession.insert(stu);
        knowledgeSession.fireRules();
        return Result.success(stu.getTeacher());
    }
}

請求介面，最終引數符合配置的條件，返回“那麼”中配置的輸出結果。

3.3.2指令碼式規則集

指令碼式的規則集，各種原理都是和嚮導式一模一樣，無非就是拉高門檻，用寫指令碼的方式去實現配置的規則。這裡不做過多的介紹了。

3.4決策表

再聊下決策表，其實它就是規則集的另一種展示形式，比較相對規則集，我更喜歡用決策表去配置規則，應為它呈現的更加直觀，更便於理解。但是本質和規則集沒啥區別。

也不展開過多的贅述，這裡我就放一張配置過的決策表；

3.5其他

當然，還有其他的概念和功能，這裡也不一一介紹了，因為上面說的已經是最常用的了，想了解的可以自行去了解。其他功能包括：交叉決策表、評分卡、複雜評分卡、決策樹、規則流；當然，其中有些是Pro版的功能。

四、運用場景

最近在開發一期大版本的需求，其中就有個場景，具體如下；
參與購買訂單的使用者都會有自己的一個職級，也可以說是角色。每個使用者都會有三個職位：普通使用者、會員、精英會員。

然後，每個月初都會對使用者進行一次晉升處理，普通使用者達到要求，就會晉升為會員，會員達到要求就會晉升為精英會員。

當然，普通使用者晉升會員，會員晉升精英會員，都會有不同的規則；

1. 普通使用者->會員：3個月內幫註冊人數達到3人；3個月內自己和底下團隊的人，下單金額超過1萬；個人的訂單繼續率超過80%。
2. 會員->精英會員：3個月內幫註冊人數達到6人；3個月內自己和底下團隊的人，下單金額超過5萬；個人的訂單繼續率超過90%。

3. 不能跨級晉升，普通使用者最多隻能到會員，達到會員了才能晉升到精英會員。

   當然，這只是做過簡化的一部分需求，我做過稍許的改動，真實的需求場景並沒有這麼簡單。

下面，我對這個需求做一個規則的配置，這裡用一個決策表進行配置；在配置規則前，我新增一個變數庫檔案和常量庫；


最後，新增一個決策表，並進行規則配置；

可以看到，表格一共五列，其中前四列是規則，最後一列是滿足規則後輸出的資訊。這樣看著就很清晰，即使並不是技術人員，也可以輕鬆看懂其中的規則。

五、總結

規則引擎對於我們的系統而言可用可不用，它可以錦上添花，幫助我們剝離出業務中需要進行大量判斷的場景。但是，這種規則的剝離，需要我們開發人員對需求進行理解，在理解的基礎上進行抽象概念的具化。這，也是整個程式設計的必經之路。

六、參考原始碼

程式設計文件：
https://gitee.com/cicadasmile/butte-java-note

應用倉庫：
https://gitee.com/cicadasmile/butte-flyer-parent