SpringBoot整合Drools規則引擎動態生成業務規則的實現
最近的項目中，使用的是flowable工作流來處理業務流程，但是在業務規則的配置中，是在代碼中直接固定寫死的，領導說這樣不好，需要規則可以動態變化，可以通過頁面去動態配置改變，所以就花瞭幾天時間去研究瞭一下Drools規則引擎框架。然後應用到瞭項目中。
首先在項目中引入規則引擎相關依賴
<properties>
<java.version>1.8</java.version>
<drools.version>7.20.0.Final</drools.version>
</properties>
<dependencies>
<!--引入規則引擎-->
<dependency>
<groupId>org.kie</groupId>
<artifactId>kie-spring</artifactId>
<version>${drools.version}</version>
<exclusions>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
</exclusion>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
</exclusion>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
</exclusion>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.drools</groupId>
<artifactId>drools-compiler</artifactId>
<version>${drools.version}</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided</scope>
<version>1.18.20</version>
</dependency>
</dependencies>
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.*</include>
</includes>
</resource>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml</include>
</includes>
</resource>
</resources>
</build>
這裡的drools版本使用的是7.20.0.Final，如果想和Flowable結合使用，在流程畫圖中插入規則任務，可以將drools版本和flowable starter中管理的drools版本 一致，比如我現在的項目中用到的
flowable-srping-boot-starter的依賴版本是6.5.0，點進去這個jar包的pom文件
再進一步點parent標簽
然後再點parent標簽的依賴
然後再點parent標簽內的flowable-root,然後搜索drools
可以看到flowable starter集成管理的drools版本是7.6.0-Final，所以最好和這個版本保持一致
當然你需要在flowable modeler畫圖項目中引入，然後啟動flowable modeler程序，在畫圖界面
任務類型中就可以看到一個Business rule task，商業規則任務。
如果隻是獨立使用，則可以直接使用我最開始引入的那個版本7.20.0.Final
還有一個問題就是如果你的項目中引入瞭spring boot的熱部署工具，
需要把這個依賴註釋掉，項目中不能引入這個jar包，不然這個jar包會影響drools規則引擎執行生成的規則，而且在運行規則的時候也不會報錯，這是個很隱蔽的坑，我在項目中已經踩過坑瞭，所以特別提示一下，就是這個jar包存在，規則引擎在觸發執行規則的時候，是 不會執行的，在日志信息中一直顯示的是執行規則0條，即使你的規則文件語法沒有任何錯誤，直接將這個依賴刪除後，就可以正常執行規則瞭。
引入相關依賴後，需要在項目中添加配置類：
在config包下創建DroolsAutoConfiguration類
import cn.hutool.core.util.CharsetUtil;
import lombok.extern.slf4j.Slf4j;
import org.kie.api.KieBase;
import org.kie.api.KieServices;
import org.kie.api.builder.*;
import org.kie.api.runtime.KieContainer;
import org.kie.api.runtime.KieSession;
import org.kie.internal.io.ResourceFactory;
import org.kie.spring.KModuleBeanFactoryPostProcessor;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import java.io.IOException;
/**
* @author xiaomifeng1010
* @version 1.0
* @date: 2021/12/6 9:30
* @Description drools配置類
*/
@Configuration
@Slf4j
public class DroolsAutoConfiguration {
public static final String RULE_PATH="rules/";
public KieServices getKieServices(){
KieServices kieServices = KieServices.Factory.get();
return kieServices;
}
/**
* 管理規則文件的位置路徑信息
* @return
* @throws IOException
*/
@Bean
@ConditionalOnMissingBean(KieFileSystem.class)
public KieFileSystem kieFileSystem() throws IOException {
KieFileSystem kieFileSystem = getKieServices().newKieFileSystem();
for (Resource file:getRuleFiles()) {
kieFileSystem.write(ResourceFactory.newClassPathResource(RULE_PATH+file.getFilename(), CharsetUtil.UTF_8));
}
return kieFileSystem;
}
@Bean
@ConditionalOnMissingBean(KieContainer.class)
public KieContainer kieContainer() throws IOException {
KieServices kieServices = getKieServices();
KieRepository kieRepository = kieServices.getRepository();
kieRepository.addKieModule(new KieModule() {
@Override
public ReleaseId getReleaseId() {
return kieRepository.getDefaultReleaseId();
}
});
KieBuilder kieBuilder = kieServices.newKieBuilder(kieFileSystem());
kieBuilder.buildAll();
Results results = kieBuilder.getResults();
if (results.hasMessages(Message.Level.ERROR)){
log.error(results.getMessages().toString());
}
KieContainer kieContainer = kieServices.newKieContainer(kieRepository.getDefaultReleaseId());
return kieContainer;
}
@Bean
@ConditionalOnMissingBean(KieBase.class)
public KieBase kieBase() throws IOException {
KieBase kieBase = kieContainer().getKieBase();
return kieBase;
}
@Bean
@ConditionalOnMissingBean(KieSession.class)
public KieSession kieSession() throws IOException {
return kieContainer().newKieSession();
}
@Bean
@ConditionalOnMissingBean(KModuleBeanFactoryPostProcessor.class)
public KModuleBeanFactoryPostProcessor kModuleBeanFactoryPostProcessor(){
KModuleBeanFactoryPostProcessor kModuleBeanFactoryPostProcessor = new KModuleBeanFactoryPostProcessor();
return kModuleBeanFactoryPostProcessor;
}
/**
* 獲取規則文件資源
* @return
* @throws IOException
*/
private Resource[] getRuleFiles() throws IOException {
ResourcePatternResolver resourcePatternResolver
=new PathMatchingResourcePatternResolver();
Resource[] resources = resourcePatternResolver.getResources("classpath*:" + RULE_PATH + "**/*.*");
return resources;
}
}
然後在項目的resources下創建rules文件夾存放規則文件
創建一個drl後綴的規則文件FixRateCostCalculatorRule.drl
//package 可以隨意指定，沒有具體的要求，可以命名成和項目相關的，或者直接rules
package com.drools
//或者這樣
//package rules
import java.math.BigDecimal
import java.lang.Integer
import org.apache.commons.lang3.math.NumberUtils;
import com.drools.bo.GuatanteeCost
//這裡設置的全局變量隻相當於聲明變量，需要在代碼執行規則前給該變量賦值初始化
global org.slf4j.Logger logger
rule "rule1"
//dialect "java"
salience 30
//防止死循環
//no-loop true
enabled false
when
$guaranteeCost:GuatanteeCost(amount>NumberUtils.DOUBLE_ZERO && amount<=300000)
then
$guaranteeCost.setCost(200d);
logger.info("保費"+200);
update($guaranteeCost)
end
rule "rule2"
enabled false
salience 20
when
$guaranteeCost:GuatanteeCost(amount>300000,amount<=500000)
then
$guaranteeCost.setCost(300d);
logger.info("保費"+300);
update($guaranteeCost)
end
rule "rule3"
enabled false
salience 10
when
$guaranteeCost:GuatanteeCost(amount>500000,amount<=800000)
then
// 效果和上邊兩條范圍中的更新數據效果一樣
modify($guaranteeCost){
setCost(400d)
}
logger.info("保費"+400);
end
然後需要創建一個java對象GuatanteeCost，用於向規則文件中傳遞Fact(java對象）變量值
amount是GuatanteeCost類中的屬性
@Data
@NoArgsConstructor
@AllArgsConstructor
public class GuatanteeCost {
/**
* 保證金金額
*/
private Double amount;
/**
* 保費金額
*/
private Double cost;
}
然後就可以寫一個單元測試方法，或者創建一個controller進行測試
import cn.hutool.core.util.CharsetUtil;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.drools.bo.GuatanteeCost;
import com.drools.entity.DroolsRuleConfig;
import com.drools.service.DroolsRuleConfigService;
import com.github.xiaoymin.knife4j.annotations.ApiSort;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.drools.template.ObjectDataCompiler;
import org.kie.api.io.ResourceType;
import org.kie.api.runtime.KieSession;
import org.kie.internal.io.ResourceFactory;
import org.kie.internal.utils.KieHelper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.io.IOException;
import java.io.InputStream;
import java.math.BigDecimal;
import java.util.List;
/**
* @author xiaomifeng1010
* @version 1.0
* @date: 2021/12/6 15:41
* @Description
*/
@RestController
@RequestMapping("/drools")
@AllArgsConstructor(onConstructor_={@Autowired})
@Api(tags = "drools規則引擎測試接口")
@ApiSort(30)
@Slf4j
public class DroolsTestController {
@Autowired
private KieSession kieSession;
@Autowired
private DroolsRuleConfigService droolsRuleConfigService;
@ApiOperation("測試計算保費規則")
@ApiImplicitParam(name="bzjAmount",value = "保證金金額(單位元)")
@PostMapping("test/rule")
public String testDrools(BigDecimal bzjAmount){
GuatanteeCost guatanteeCost = new GuatanteeCost();
guatanteeCost.setAmount(bzjAmount.doubleValue());
kieSession.insert(guatanteeCost);
kieSession.setGlobal("logger",log);
int allRules = kieSession.fireAllRules();
Double cost = guatanteeCost.getCost();
log.info("成功執行{}條規則",allRules);
log.info("計算保費{}元", cost);
kieSession.dispose();
return cost+"";
}
@ApiOperation("測試使用規則模板計算保費規則")
@ApiImplicitParam(name="bzjAmount",value = "保證金金額(單位元)")
@PostMapping("test/ruleTemplate")
public String testDroolsRuleTemplate(BigDecimal bzjAmount){
GuatanteeCost guatanteeCost = new GuatanteeCost();
guatanteeCost.setAmount(bzjAmount.doubleValue());
List<DroolsRuleConfig> droolsRuleConfigList = droolsRuleConfigService.list(Wrappers.<DroolsRuleConfig>lambdaQuery()
.eq(DroolsRuleConfig::getRuleName, "fix"));
ObjectDataCompiler converter = new ObjectDataCompiler();
String drlContent = StringUtils.EMPTY;
try(InputStream dis= ResourceFactory.
newClassPathResource("rules/FixRateCostCalculatorRule.drt", CharsetUtil.UTF_8)
.getInputStream()){
// 填充模板內容
drlContent=converter.compile(droolsRuleConfigList, dis);
log.info("生成的規則內容:{}",drlContent);
}catch (IOException e) {
log.error("獲取規則模板文件出錯:{}",e.getMessage());
}
KieHelper helper = new KieHelper();
helper.addContent(drlContent, ResourceType.DRL);
KieSession ks = helper.build().newKieSession();
ks.insert(guatanteeCost);
// kieSession.setGlobal("logger",log);
int allRules = ks.fireAllRules();
Double cost = guatanteeCost.getCost();
log.info("成功執行{}條規則",allRules);
log.info("計算保費{}元", cost);
kieSession.dispose();
return cost+"";
}
}
至此，可以先忽視第二個接口方法，使用第一個接口方法來測試規則的運行
計算的費用是200,執行的是rule1規則，200000介於0-300000之間，所以保費計算的是200
這種直接寫drl規則文件，在裡邊設定規則的方式比較簡便，但是卻不靈活，如果我想再添加幾條范圍，那麼就需要重新再來修改這個drl文件，所以在項目中可以使用規則模板drt
然後在項目resources的rules目錄下再創建一個drt文件FixRateCostCalculatorRule.drt
//模板文件
template header
min
max
fixedFee
package drools.templates
import com.drools.bo.GuatanteeCost
template "fixRate"
rule "calculate rule_@{row.rowNumber}"
dialect "mvel"
no-loop true
when
$guaranteeCost:GuatanteeCost(amount>@{min} && amount<=@{max})
then
modify($guaranteeCost){
setCost(@{fixedFee})
}
end
end template
然後創建一個表，用於保存min,max和fixed的參數值（註意事項：template header下邊的min,max和fixedFee都相當於聲明的參數，但是不能在min上邊加一行註釋如：//參數說明，在解析規則模板時候會把“//參數說明”也當做聲明的參數變量），因為這些值可以動態變化瞭，所以范圍規則也相當於可以動態變化，范圍就不是之前設置的固定的啦
創建這樣一個表，這樣就可以靈活配置范圍和保費金額瞭
CREATE TABLE `biz_drools_rule_config` ( `id` bigint(20) NOT NULL, `rule_code` varchar(255) DEFAULT NULL COMMENT '規則編碼', `rule_name` varchar(255) DEFAULT NULL COMMENT '規則名稱', `min` int(10) DEFAULT NULL COMMENT '保證金范圍最小值', `max` int(10) DEFAULT NULL COMMENT '保證金范圍最大值', `fixed_fee` decimal(10,2) DEFAULT NULL COMMENT '固定保費', `fee_rate` decimal(5,3) DEFAULT NULL COMMENT '費率(小數)', `create_by` varchar(25) DEFAULT NULL, `create_time` datetime DEFAULT NULL, `update_by` varchar(25) DEFAULT NULL, `update_time` datetime DEFAULT NULL, PRIMARY KEY (`id`) USING BTREE ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 ROW_FORMAT=DYNAMIC;
然後創建對應的實體類，mapper和service，可以使用項目中的代碼生成器快捷生成或者idea的插件生成
然後就可以使用controller中的第二個接口方法來測試瞭
數據庫中的數據插入，可以在項目頁面中寫一個用於添加規則配置參數的頁面，在裡邊插入幾條數
這裡我是先隨意手動添加瞭幾條數據
然後在knife4j文檔頁面執行接口測試
加上oauth2的驗證信息
輸入amount的值，也計算的固定保費200
同時從數據庫中查詢出來3條數據，對應三個范圍，生成瞭三個規則（rule），可以從項目日志中查看
此時可以把數據庫中的最大最小值改變一下，再測試一下
此時再傳入一個保證金amount值20萬，就會計算出保費費用是300元 ，執行代碼時，會再次生成新的規則，每次執行規則模板動態生成的規則drl內容實際上保存在內存中的，並不像最開始創建的drl文件那樣
再次執行，就會發現保費計算就成瞭300元
同時規則模板動態生成的規則內容也對應發生瞭變化
為瞭方便使用這個規則模板，可以將測試規則模板的這個接口方法封裝成一個輔助類，在業務使用時，可以直接調用
package com.drools.util;
import cn.hutool.core.util.CharsetUtil;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.drools.bo.GuatanteeCost;
import com.drools.entity.DroolsRuleConfig;
import com.drools.service.DroolsRuleConfigService;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.drools.template.ObjectDataCompiler;
import org.kie.api.io.ResourceType;
import org.kie.api.runtime.KieSession;
import org.kie.internal.io.ResourceFactory;
import org.kie.internal.utils.KieHelper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.io.IOException;
import java.io.InputStream;
import java.math.BigDecimal;
import java.util.List;
/**
* @author xiaomifeng1010
* @version 1.0
* @date: 2021/12/8 16:22
* @Description 根據規則引擎模板獲取保費金額
*/
@Component
@Slf4j
public class CalculateCostUtil {
@Autowired
private DroolsRuleConfigService droolsRuleConfigService;
/**
* @description: 獲取固定保費
* @author: xiaomifeng1010
* @date: 2021/12/8
* @param bzjAmount
* @return: BigDecimal
**/
public BigDecimal getFixedFee(BigDecimal bzjAmount){
GuatanteeCost guatanteeCost = new GuatanteeCost();
guatanteeCost.setAmount(bzjAmount.doubleValue());
List<DroolsRuleConfig> droolsRuleConfigList = droolsRuleConfigService.list(Wrappers.<DroolsRuleConfig>lambdaQuery()
.eq(DroolsRuleConfig::getRuleName, "fix"));
ObjectDataCompiler converter = new ObjectDataCompiler();
String drlContent = StringUtils.EMPTY;
try(InputStream dis= ResourceFactory.
newClassPathResource("rules/FixRateCostCalculatorRule.drt", CharsetUtil.UTF_8)
.getInputStream()){
// 填充模板內容
drlContent=converter.compile(droolsRuleConfigList, dis);
log.info("生成的規則內容:{}",drlContent);
}catch (IOException e) {
log.error("獲取規則模板文件出錯:{}",e.getMessage());
}
KieHelper helper = new KieHelper();
helper.addContent(drlContent, ResourceType.DRL);
KieSession ks = helper.build().newKieSession();
ks.insert(guatanteeCost);
int allRules = ks.fireAllRules();
Double cost = guatanteeCost.getCost();
log.info("成功執行{}條規則",allRules);
log.info("計算保費{}元", cost);
ks.dispose();
return BigDecimal.valueOf(cost);
}
}
暫時就研究瞭這些點東西，算是剛剛入門這個框架，買的drools圖書，還得再多讀幾遍，多實踐操作一下，以後再做一些更深入的總結
到此這篇關於SpringBoot整合Drools規則引擎動態生成業務規則的實現的文章就介紹到這瞭,更多相關SpringBoot整合Drools生成業務規則內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！
推薦閱讀：
- drools中使用function的方法小結
- 一文帶你學會規則引擎Drools的應用
- drools中query的用法小結
- 深入淺析drools中Fact的equality modes
- 聊聊drools session的不同