一文帶你學會規則引擎Drools的應用

2023-03-13 06:00:18

前言

現在有這麼個需求，網上購物，需要根據不同的規則計算商品折扣，比如VIP客戶增加5%的折扣，購買金額超過1000元的增加10%的折扣等，而且這些規則可能隨時發生變化，甚至增加新的規則。面對這個需求，你該怎麼實現呢？難道是計算規則一變，就要修改業務程式碼，重新測試，上線嗎。

其實，我們可以通過規則引擎來實現，Drools 就是一個開源的業務規則引擎，可以很容易地與 spring boot 應用程式整合，那本文就用Drools來實現一下上面說的需求吧。

引入依賴

我們建立一個spring boot應用程式，pom中新增drools相關的依賴，如下：

<dependency>
  <groupId>org.drools</groupId>
  <artifactId>drools-core</artifactId>
  <version>7.59.0.Final</version>
</dependency>
<dependency>
  <groupId>org.drools</groupId>
  <artifactId>drools-compiler</artifactId>
  <version>7.59.0.Final</version>
</dependency>
<dependency>
  <groupId>org.drools</groupId>
  <artifactId>drools-decisiontables</artifactId>
  <version>7.59.0.Final</version>
</dependency>

Drools設定類

建立一個名為DroolsConfig的設定 java 類。

@Configuration
public class DroolsConfig {
    // 制定規則檔案的路徑
    private static final String RULES_CUSTOMER_RULES_DRL = "rules/customer-discount.drl";
    private static final KieServices kieServices = KieServices.Factory.get();

    @Bean
    public KieContainer kieContainer() {
        KieFileSystem kieFileSystem = kieServices.newKieFileSystem();
        kieFileSystem.write(ResourceFactory.newClassPathResource(RULES_CUSTOMER_RULES_DRL));
        KieBuilder kb = kieServices.newKieBuilder(kieFileSystem);
        kb.buildAll();
        KieModule kieModule = kb.getKieModule();
        KieContainer kieContainer = kieServices.newKieContainer(kieModule.getReleaseId());
        return kieContainer;
    }
}

定義了一個 KieContainer的Spring Bean ，KieContainer用於通過載入應用程式的/resources資料夾下的規則檔案來構建規則引擎。
建立KieFileSystem範例並設定規則引擎並從應用程式的資源目錄載入規則的 DRL 檔案。
使用KieBuilder範例來構建 drools 模組。我們可以使用KieSerive單例範例來建立 KieBuilder 範例。
最後，使用 KieService 建立一個 KieContainer 並將其設定為 spring bean。

新增業務Model

建立一個訂單物件OrderRequest，這個類中的欄位後續回作為輸入資訊傳送給定義的drools規則中，用來計算給定客戶訂單的折扣金額。

@Getter
@Setter
public class OrderRequest {
    /**
     * 客戶號
     */
    private String customerNumber;
    /**
     * 年齡
     */
    private Integer age;
    /**
     * 訂單金額
     */
    private Integer amount;
    /**
     * 客戶型別
     */
    private CustomerType customerType;
}

此外，定義一個客戶型別CustomerType 的列舉，規則引擎會根據該值計算客戶訂單折扣百分比，如下所示。

public enum CustomerType {
    LOYAL, NEW, DISSATISFIED;

    public String getValue() {
        return this.toString();
    }
}

最後，建立一個訂單折扣類 OrderDiscount ，用來表示計算得到的最終的折扣，如下所示。

@Getter
@Setter
public class OrderDiscount {

    /**
     * 折扣
     */
    private Integer discount = 0;
}

我們將使用上述響應物件返回計算出的折扣。

定義drools 規則

前面的DroolsConfig類中指定drools規則的目錄，現在我們在/src/main/resources/rules目錄下新增customer-discount.drl檔案，在裡面定義對應的規則。

這個drl檔案雖然不是java檔案，但還是很容易看懂的。

我們使用了一個名為orderDiscount 的全域性引數，可以在多個規則之間共用。
drl 檔案可以包含一個或多個規則。我們可以使用mvel語法來指定規則。此外，每個規則使用rule關鍵字進行描述。
每個規則when-then語法來定義規則的條件。
根據訂單請求的輸入值，我們正在為結果新增折扣。如果規則表示式匹配，每個規則都會向全域性結果變數新增額外的折扣。

完整的規則原始碼如下：

import com.alvin.drools.model.OrderRequest;
import com.alvin.drools.model.CustomerType;
global com.alvin.drools.model.OrderDiscount orderDiscount;

dialect "mvel"

// 規則1: 根據年齡判斷
rule "Age based discount"
    when
        // 當客戶年齡在20歲以下或者50歲以上
        OrderRequest(age < 20 || age > 50)
    then
        // 則新增10%的折扣
        System.out.println("==========Adding 10% discount for Kids/ senior customer=============");
        orderDiscount.setDiscount(orderDiscount.getDiscount() + 10);
end

// 規則2： 根據客戶型別的規則
rule "Customer type based discount - Loyal customer"
    when
        // 當客戶型別是LOYAL
        OrderRequest(customerType.getValue == "LOYAL")
    then
        // 則增加5%的折扣
        System.out.println("==========Adding 5% discount for LOYAL customer=============");
        orderDiscount.setDiscount(orderDiscount.getDiscount() + 5);
end

rule "Customer type based discount - others"
    when
    OrderRequest(customerType.getValue != "LOYAL")
then
    System.out.println("==========Adding 3% discount for NEW or DISSATISFIED customer=============");
    orderDiscount.setDiscount(orderDiscount.getDiscount() + 3);
end

rule "Amount based discount"
    when
        OrderRequest(amount > 1000L)
    then
        System.out.println("==========Adding 5% discount for amount more than 1000$=============");
    orderDiscount.setDiscount(orderDiscount.getDiscount() + 5);
end

新增Service層

建立一個名為OrderDiscountService 的服務類，如下：。

@Service
public class OrderDiscountService {

    @Autowired
    private KieContainer kieContainer;

    public OrderDiscount getDiscount(OrderRequest orderRequest) {
        OrderDiscount orderDiscount = new OrderDiscount();
        // 開啟對談
        KieSession kieSession = kieContainer.newKieSession();
        // 設定折扣物件
        kieSession.setGlobal("orderDiscount", orderDiscount);
        // 設定訂單物件
        kieSession.insert(orderRequest);
        // 觸發規則
        kieSession.fireAllRules();
        // 中止對談
        kieSession.dispose();
        return orderDiscount;
    }
}

注入KieContainer範例並建立一個KieSession範例。
設定了一個OrderDiscount型別的全域性引數，它將儲存規則執行結果。
使用insert()方法將請求物件傳遞給 drl 檔案。
呼叫fireAllRules()方法觸發所有規則。
最後通過呼叫KieSession 的dispose()方法終止對談。

新增Controller

建立一個名為OrderDiscountController 的Controller類，具體程式碼如下：

@RestController
public class OrderDiscountController {

    @Autowired
    private OrderDiscountService orderDiscountService;

    @PostMapping("/get-discount")
    public ResponseEntity<OrderDiscount> getDiscount(@RequestBody OrderRequest orderRequest) {
        OrderDiscount discount = orderDiscountService.getDiscount(orderRequest);
        return new ResponseEntity<>(discount, HttpStatus.OK);
    }
}