Spring Boot + URule 規則引擎，可視化配置太爽了！

作者：知了一笑
來源：juejin.cn/post/7210194936276680759

一、背景

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

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

二、介紹

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

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

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

特性	PRO版	開源版
嚮導式決策集	有	有
腳本式決策集	有	有
決策樹	有	有
決策流	有	有
決策表	有	有
交叉決策表	有	無
複雜評分卡	有	無
文件名、項目名重構	有	無
參數名、變量常量名重構	有	無
Excel決策表導入	有	無
規則集模版保存與加載	有	無
中文項目名和文件名支持	有	無
服務器推送知識包到客戶端功能的支持	有	無
知識包優化與壓縮的支持	有	無
客戶端服務器模式下大知識包的推拉支持	有	無
規則集中執行組的支持	有	無
規則流中所有節點嚮導式條件與動作配置的支持	有	無
循環規則多循環單元支持	有	無
循環規則中無條件執行的支持	有	無
導入項目自動重命名功能	有	無
規則樹構建優化	有	無
對象查找索引支持	有	無
規則樹中短路計算的支持	有	無
規則條件冗餘計算緩存支持	有	無
基於方案的批量場景測試功能	有	無
知識包調用監控	有	無
更爲完善的文件讀寫權限控制	有	無
知識包版本控制	有	無
SpringBean及Java類的熱部署	有	無
技術支持	有	無

三、安裝使用

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

但是我們這裏不考慮URule Pro，咱自己整個開源版，在開源版集成springboot的基礎上做一個二次開發，搜了一圈，其實就有解決方案。

大致的項目模塊如下：

Spring Boot 基礎就不介紹了，推薦看這個實戰項目：

https://github.com/javastacks/spring-boot-best-practice

自己創建個空數據庫，只需要在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嚮導式規則集

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

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

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

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

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

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

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());
    }
}

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