Spring Boot+規則引擎URule，太強了！

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

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

1. 介紹

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

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

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

基于 Spring Boot + MyBatis Plus + Vue & Element 實現的后臺管理系統 + 用戶小程序，支持 RBAC 動態權限、多租戶、數據權限、工作流、三方登錄、支付、短信、商城等功能

• 項目地址：https://github.com/YunaiV/ruoyi-vue-pro
• 視頻教程：https://doc.iocoder.cn/video/

2. 安裝使用

實際使用時，有四種使用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//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,看到這個界面，就說明啟動成功了。

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 實現的后臺管理系統 + 用戶小程序，支持 RBAC 動態權限、多租戶、數據權限、工作流、三方登錄、支付、短信、商城等功能

• 項目地址：https://github.com/YunaiV/yudao-cloud
• 視頻教程：https://doc.iocoder.cn/video/

3. 基礎概念

3.1整體介紹

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

3.2 庫文件

如上圖介紹的，庫文件有4種，包括變量庫，參數庫，常量庫和動作庫。其實類似于Java開發的系統中的實體對象，枚舉，常量以及方法。

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

3.2.1變量庫文件

在業務開發中，我們會創建很多Getter和Setter的Java類，比如PO、VO、BO、DTO、POJO等等，其實這些類new對象后主要起到的作用就是數據的載體，用來傳輸數據。

在URule中，變量庫就是用來映射這些對象，然后可以在規則中使用，最終完成業務和規則的互動。最后上一張圖，用來創建變量庫

對了，上面廢話了這么多可視化配置，這才是第一次展示配置界面，慚愧慚愧。

上圖一目了然，在“庫”這個菜單底下右鍵，然后點擊添加變量庫即可，最后定義自己喜歡的變量庫名，當然名字只支持中文或者英文，其他字符不可用。

創建完變量庫后，就可以對變量庫進行編輯，可以認為就是給POJO添加屬性

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

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

packagecom.cicada;

importcom.bstek.urule.model.Label;
importlombok.Data;

/**
*@author芋道源碼
*@version1.0
*@date2023/3/315:38
*@description
*/
@Data
publicclassStu{

@Label("姓名")
privateStringname;

@Label("年齡")
privateintage;

@Label("班級")
privateStringclasses;
}

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

3.2.2常量庫文件

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

當然，類似于變量庫，常量庫也可以實現和系統中的枚舉相互映射，這樣做的好處可以避免我們手動輸入，防止輸入錯誤。創建常量庫也比較簡單，直接在“庫”這個菜單下右鍵，“添加常量庫”。

創建好常量庫文件后，也會出現如下頁面：

3.2.3參數庫文件

參數庫，就是URule規則中的臨時變量，變量的類型和數量不固定?？梢哉J為類似于Map，實際上存儲參數庫的也就是個Map。

同樣的套路，直接在“庫”這個菜單下右鍵，“添加參數庫”。

可以看到，參數庫已經少了左邊分類這一項，直接添加參數，選擇類型就是干，相對簡單了很多?！懊Q”這列我這里用了英文，就是Map中的key，而“標題”這列就是在配置規則時候顯示用的，中文看著比較直觀。

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

3.2.4動作庫文件

動作庫可以對配置在spring中的bean方法進行映射，然后可以在規則中直接調用這批方法。慣用套路，還是在“庫”菜單下右鍵，點擊“添加動作庫”。

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

packagecom.bstek.urule.cicada;

importcom.bstek.urule.action.ActionId;
importcom.bstek.urule.model.ExposeAction;
importorg.springframework.stereotype.Component;

importjava.text.SimpleDateFormat;
importjava.util.Date;

/**
*@author芋道源碼
*@version1.0
*@date2023/3/1013:59
*@description
*/
@Component("action")
publicclassAction{

@ActionId("Hello")
publicStringhello(){
return"hello";
}

@ExposeAction(value="方法1")
publicbooleanevalTest(Stringusername){
if(username==null){
returnfalse;
}elseif(username.equals("張三")){
returntrue;
}
returnfalse;
}

@ExposeAction(value="測試Int")
publicinttestInt(inta,intb){
returna+b;
}

@ExposeAction(value="打印內容")
publicvoidprintContent(Stringusername,Datebirthday){
SimpleDateFormatsd=newSimpleDateFormat("yyyy-MM-ddHHss");
if(birthday!=null){
System.out.println(username+"今年已經"+sd.format(birthday)+"歲了!");
}else{
System.out.println("Hello"+username+"");
}
}

@ExposeAction(value="打印Stu")
publicvoidprintUser(Stum){
System.out.println("Hello"+m.getName()+",isage:"+m.getAge());
}
}

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

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

3.3規則集

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

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

在規則集的定義的方式上，URule由向導式和腳本式兩種；

• 向導式規則集 ：就是在頁面上通過鼠標點點點，高度的可視化配置，不是開發都能懂，這也是這個規則引擎的亮點所在。
• 腳本式規則集 ：聽名字就知道了，這玩意要寫腳本的。拉高配置門檻，需要懂點編碼的人來編寫。

3.3.1向導式規則集

還是一樣，首先新建。這次是在“決策集”菜單上右鍵，點擊“添加向導式決策集”，這樣就創建好一個規則集了。

在配置規則前，可以先導入前面定義好的庫文件。我這里導入變量庫文件，頁面上點擊“變量庫”，然后選擇指定的變量庫文件即可。如圖所示；

最后，可以愉快的配置規則了，向導式沒什么好講的，都是可視化界面，點點點即可。下面是我配置的一個簡單的規則集；

可以看到由三部分組成：如果、那么、否則；

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

最后，附上添加完規則后，通過代碼去執行規則；

packagecom.cicada;

importcn.hutool.core.bean.BeanUtil;
importcom.Result;
importcom.bstek.urule.Utils;
importcom.bstek.urule.runtime.KnowledgePackage;
importcom.bstek.urule.runtime.KnowledgeSession;
importcom.bstek.urule.runtime.KnowledgeSessionFactory;
importcom.bstek.urule.runtime.service.KnowledgeService;
importcom.cicada.req.StuReq;
importorg.springframework.web.bind.annotation.PostMapping;
importorg.springframework.web.bind.annotation.RequestBody;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.RestController;

importjava.io.IOException;

/**
*@author芋道源碼
*@version1.0
*@date2023/3/1016:47
*@description
*/
@RestController
@RequestMapping("/rule")
publicclassRuleDataController{

@PostMapping("/stu")
publicResultrule(@RequestBodyStuReqstuReq)throwsIOException{
KnowledgeServiceknowledgeService=(KnowledgeService)Utils.getApplicationContext().getBean(KnowledgeService.BEAN_ID);
KnowledgePackageknowledgePackage=knowledgeService.getKnowledge("xxx/xxx");
KnowledgeSessionknowledgeSession=KnowledgeSessionFactory.newKnowledgeSession(knowledgePackage);
Stustu=BeanUtil.copyProperties(stuReq,Stu.class);
knowledgeSession.insert(stu);
knowledgeSession.fireRules();
returnResult.success(stu.getTeacher());
}
}

請求接口，最終參數符合配置的條件，返回“那么”中配置的輸出結果。

3.3.2腳本式規則集

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

3.4決策表

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

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

3.5其他

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

4. 運用場景

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

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

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

1. 普通用戶->會員：3個月內幫注冊人數達到3人；3個月內自己和底下團隊的人，下單金額超過1萬；個人的訂單繼續率超過80%。
2. 會員->精英會員：3個月內幫注冊人數達到6人；3個月內自己和底下團隊的人，下單金額超過5萬；個人的訂單繼續率超過90%。
3. 不能跨級晉升，普通用戶最多只能到會員，達到會員了才能晉升到精英會員。

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

下面，我對這個需求做一個規則的配置，這里用一個決策表進行配置；在配置規則前，我添加一個變量庫文件和常量庫；

最后，添加一個決策表，并進行規則配置；

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

5. 總結

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

審核編輯 ：李倩