筹划并用Java实现一个浅易的规则引擎

来自云龙湖轮廓分明的月亮  金牌会员 | 2024-9-8 02:50:00 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 984|帖子 984|积分 2962

前言

使用规则引擎可以很方便的实现一些比力复杂的业务逻辑。
本文介绍的浅易版，是一个小的通用代码结构。
通过组装业务数据，创建执行模版，最终执行，获取到最终结果。
各人在复杂场景下，也可以选用Drools来实现。
   Drools 是一个开源的业务规则管理系统，它提供了基于Java的规则引擎，用于实现复杂的变乱处理和业务逻辑。Drools 支持声明式编程，允许开发人员将业务逻辑从应用程序代码中分离出来，这使得业务逻辑的管理和变动更加机动和便捷。
  正文

一、代码结构


二、焦点代码

maven依赖文件：
  1.     <properties>
  2.         <java.version>17</java.version>
  3.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  4.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  5.         <maven.compiler.source>17</maven.compiler.source>
  6.         <maven.compiler.target>17</maven.compiler.target>
  7.     </properties>
  9.     <dependencies>
  10.         <dependency>
  11.             <groupId>org.projectlombok</groupId>
  12.             <artifactId>lombok</artifactId>
  13.             <optional>true</optional>
  14.         </dependency>
  16.         <dependency>
  17.             <groupId>org.springframework.boot</groupId>
  18.             <artifactId>spring-boot-starter</artifactId>
  19.         </dependency>
  20.     </dependencies>
复制代码
2.1 上下文数据接口 ContextData.java

  1. package com.song.tools.ruleengine.core;
  3. /**
  4. * 上下文数据
  5. *
  6. * @author song tools
  7. */
  8. public interface ContextData {
  10.     /**
  11.      * 校验上下文数据
  12.      */
  13.     default void validProperty() {
  14.     }
  15. }
复制代码
2.2 规则接口 Rule.java

  1. package com.song.tools.ruleengine.core;
  3. /**
  4. * 规则接口
  5. *
  6. * @author song tools
  7. */
  8. public interface Rule<ContextData extends com.song.tools.ruleengine.core.ContextData> {
  10.     /**
  11.      * 执行前
  12.      *
  13.      * @param contextData 上下文数据
  14.      */
  15.     default void before(ContextData contextData) {
  16.         contextData.validProperty();
  17.     }
  19.     /**
  20.      * 执行
  21.      *
  22.      * @param context 上下文
  23.      */
  24.     void execute(RuleEngineContext<ContextData> context);
  26.     /**
  27.      * 执行后
  28.      *
  29.      * @param contextData 上下文数据
  30.      */
  31.     default void after(ContextData contextData) {
  32.     }
  33. }
复制代码
2.3 规则引擎接口 RuleEngine.java

  1. package com.song.tools.ruleengine.core;
  3. /**
  4. * 规则引擎
  5. *
  6. * @author song tools
  7. */
  8. public interface RuleEngine<ContextData extends com.song.tools.ruleengine.core.ContextData> {
  10.     /**
  11.      * 注册规则
  12.      *
  13.      * @param ruleKey 规则key
  14.      * @param rule    规则
  15.      */
  16.     void registerRule(String ruleKey, Rule<ContextData> rule);
  18.     /**
  19.      * 执行规则
  20.      *
  21.      * @param context 上下文
  22.      */
  23.     void executeRule(RuleEngineContext<ContextData> context) throws Exception;
  25.     /**
  26.      * 规则数量
  27.      *
  28.      * @return 规则数量
  29.      */
  30.     int ruleSize();
  31. }
复制代码
2.4 规则引擎上下文类 RuleEngineContext.java

  1. package com.song.tools.ruleengine.core;
  3. import lombok.AllArgsConstructor;
  4. import lombok.Data;
  5. import lombok.NoArgsConstructor;
  7. /**
  8. * 规则引擎上下文
  9. *
  10. * @author song tools
  11. */
  12. @Data
  13. @NoArgsConstructor
  14. @AllArgsConstructor
  15. public class RuleEngineContext<ContextData extends com.song.tools.ruleengine.core.ContextData> {
  17.     /**
  18.      * 上下文数据
  19.      */
  20.     private ContextData contextData;
  21. }
复制代码
2.5 规则引擎默认实现类 DefaultRuleEngine.java

  1. package com.song.tools.ruleengine.core;
  3. import java.util.LinkedHashMap;
  4. import java.util.Map;
  6. /**
  7. * 默认实现的规则引擎
  8. *
  9. * @author song tools
  10. */
  11. public class DefaultRuleEngine<ContextData extends com.song.tools.ruleengine.core.ContextData> implements RuleEngine<ContextData> {
  13.     private final Map<String, Rule<ContextData>> RULE_MAP;
  15.     public DefaultRuleEngine() {
  16.         RULE_MAP = new LinkedHashMap<>(16);
  17.     }
  19.     @Override
  20.     public void registerRule(String ruleKey, Rule<ContextData> rule) {
  21.         RULE_MAP.put(ruleKey, rule);
  22.     }
  24.     @Override
  25.     public void executeRule(RuleEngineContext<ContextData> context) {
  26.         for (Rule<ContextData> rule : RULE_MAP.values()) {
  27.             rule.before(context.getContextData());
  28.             rule.execute(context);
  29.             rule.after(context.getContextData());
  30.         }
  31.     }
  33.     @Override
  34.     public int ruleSize() {
  35.         return RULE_MAP.size();
  36.     }
  37. }
复制代码
2.6 执行时出错监听器接口 ExecuteOnErrorListener.java

  1. package com.song.tools.ruleengine.core;
  3. /**
  4. * 执行时出错监听器
  5. *
  6. * @author song tools
  7. */
  8. public interface ExecuteOnErrorListener<ContextData extends com.song.tools.ruleengine.core.ContextData> {
  10.     void onError(ContextData contextData, Exception e);
  11. }
复制代码
2.7 规则引擎执行模版类 RuleEngineExecuteTemplate.java

  1. package com.song.tools.ruleengine.core;
  3. import lombok.Getter;
  4. import lombok.extern.slf4j.Slf4j;
  6. import java.util.List;
  7. import java.util.Objects;
  8. import java.util.concurrent.atomic.AtomicInteger;
  10. /**
  11. * 规则执行模版
  12. *
  13. * @author song tools
  14. */
  15. @Getter
  16. @Slf4j
  17. public class RuleEngineExecuteTemplate<ContextData extends com.song.tools.ruleengine.core.ContextData> {
  19.     /**
  20.      * 规则引擎
  21.      */
  22.     private final RuleEngine<ContextData> ruleEngine;
  24.     /**
  25.      * 规则索引
  26.      */
  27.     private final AtomicInteger ruleIndex;
  29.     /**
  30.      * 执行失败监听器
  31.      */
  32.     private ExecuteOnErrorListener<ContextData> executeOnErrorListener;
  34.     public RuleEngineExecuteTemplate() {
  35.         this(new DefaultRuleEngine<>());
  36.     }
  38.     public RuleEngineExecuteTemplate(RuleEngine<ContextData> ruleEngine) {
  39.         Objects.requireNonNull(ruleEngine, "ruleEngine is null");
  40.         this.ruleIndex = new AtomicInteger(1);
  41.         this.ruleEngine = ruleEngine;
  42.     }
  45.     /**
  46.      * 注册规则
  47.      *
  48.      * @param rule 规则
  49.      * @return this 当前模版对象
  50.      */
  51.     public RuleEngineExecuteTemplate<ContextData> registerRule(Rule<ContextData> rule) {
  52.         String ruleKey = rule.getClass().getSimpleName();
  53.         return this.registerRule(ruleKey, rule);
  54.     }
  56.     /**
  57.      * 注册规则
  58.      *
  59.      * @param rules 规则列表
  60.      * @return this 当前模版对象
  61.      */
  62.     public RuleEngineExecuteTemplate<ContextData> registerRule(List<Rule<ContextData>> rules) {
  63.         for (Rule<ContextData> rule : rules) {
  64.             this.registerRule(rule);
  65.         }
  66.         return this;
  67.     }
  69.     /**
  70.      * 注册规则
  71.      *
  72.      * @param ruleKey 规则key
  73.      * @param rule    规则
  74.      * @return this 当前模版对象
  75.      */
  76.     public RuleEngineExecuteTemplate<ContextData> registerRule(String ruleKey, Rule<ContextData> rule) {
  77.         ruleEngine.registerRule(ruleKey + ruleIndex.getAndIncrement(), rule);
  78.         return this;
  79.     }
  81.     public RuleEngineExecuteTemplate<ContextData> registerExecuteOnErrorListener(ExecuteOnErrorListener<ContextData> executeOnErrorListener) {
  82.         this.executeOnErrorListener = executeOnErrorListener;
  83.         return this;
  84.     }
  87.     /**
  88.      * 执行规则
  89.      */
  90.     public void execute(ContextData contextData) throws Exception {
  91.         Objects.requireNonNull(contextData, "contextData is null");
  92.         if (ruleEngine.ruleSize() == 0) {
  93.             throw new IllegalArgumentException("ruleEngine not found register rule");
  94.         }
  96.         // 组装上下文
  97.         RuleEngineContext<ContextData> context = new RuleEngineContext<>();
  98.         context.setContextData(contextData);
  100.         try {
  101.             // 执行规则
  102.             ruleEngine.executeRule(context);
  103.         } catch (Exception e) {
  104.             log.error("execute rule error", e);
  105.             if (Objects.nonNull(executeOnErrorListener)) {
  106.                 executeOnErrorListener.onError(context.getContextData(), e);
  107.             }
  108.             throw e;
  109.         }
  110.     }
  111. }
复制代码
三、测试业务

假设现在必要机动的计算单个商品的代价折扣相关的内容。
3.1 新增折扣代价上下文实现类DiscountPriceContextData.java

  1. package com.song.tools.ruleengine;
  3. import com.song.tools.ruleengine.core.ContextData;
  4. import lombok.Data;
  6. import java.math.BigDecimal;
  7. import java.util.Objects;
  9. /**
  10. * 折扣价格上下文（对于单件商品，简单场景的计算）
  11. *
  12. * @author song tools
  13. */
  14. @Data
  15. public class DiscountPriceContextData implements ContextData {
  17.     /**
  18.      * 临时价格(存在多个计算规则时，使用它进行传递计算的中间值)
  19.      */
  20.     private BigDecimal calculatedTempPrice;
  22.     /**
  23.      * 原价
  24.      */
  25.     private BigDecimal originalPrice;
  27.     /**
  28.      * 折扣后价格
  29.      */
  30.     private BigDecimal discountedPrice;
  32.     @Override
  33.     public void validProperty() {
  34.         Objects.requireNonNull(originalPrice, "原价不能为空");
  35.     }
  36. }
复制代码
3.2 新增固定金额折扣规则实现类 FixedAmountDiscountRule.java

  1. package com.song.tools.ruleengine;
  3. import com.song.tools.ruleengine.core.Rule;
  4. import com.song.tools.ruleengine.core.RuleEngineContext;
  6. import java.math.BigDecimal;
  7. import java.math.RoundingMode;
  9. public class FixedAmountDiscountRule implements Rule<DiscountPriceContextData> {
  10.     private final BigDecimal discountAmount;
  12.     public FixedAmountDiscountRule(BigDecimal discountAmount) {
  13.         this.discountAmount = discountAmount;
  14.     }
  16.     @Override
  17.     public void execute(RuleEngineContext<DiscountPriceContextData> context) {
  18.         DiscountPriceContextData contextData = context.getContextData();
  19.         // 临时价格
  20.         BigDecimal calculatedTempPrice = contextData.getCalculatedTempPrice();
  21.         // 原始价格
  22.         BigDecimal originalPrice = contextData.getOriginalPrice();
  23.         if (calculatedTempPrice != null) {
  24.             originalPrice = calculatedTempPrice;
  25.         }
  27.         // 进行精确减法运算，并确保结果不会小于0
  28.         BigDecimal discountedPrice = (originalPrice.subtract(discountAmount).max(BigDecimal.ZERO)).setScale(2, RoundingMode.HALF_UP);
  30.         // 设置折扣后的价格
  31.         contextData.setDiscountedPrice(discountedPrice);
  32.         contextData.setCalculatedTempPrice(discountedPrice);
  33.     }
  35.     @Override
  36.     public void before(DiscountPriceContextData contextData) {
  37.         Rule.super.before(contextData);
  38.     }
  40.     @Override
  41.     public void after(DiscountPriceContextData contextData) {
  42.         Rule.super.after(contextData);
  43.     }
  44. }
复制代码
3.3 新增百分比折扣规则实现类 PercentageDiscountRule.java

  1. package com.song.tools.ruleengine;
  3. import com.song.tools.ruleengine.core.Rule;
  4. import com.song.tools.ruleengine.core.RuleEngineContext;
  6. import java.math.BigDecimal;
  7. import java.math.RoundingMode;
  9. public class PercentageDiscountRule implements Rule<DiscountPriceContextData> {
  11.     private static final BigDecimal ONE_HUNDRED = new BigDecimal("100");
  12.     private final BigDecimal discountPercentage;
  14.     public PercentageDiscountRule(BigDecimal discountPercentage) {
  15.         this.discountPercentage = discountPercentage;
  16.     }
  18.     @Override
  19.     public void execute(RuleEngineContext<DiscountPriceContextData> context) {
  20.         DiscountPriceContextData contextData = context.getContextData();
  21.         // 临时价格
  22.         BigDecimal calculatedTempPrice = contextData.getCalculatedTempPrice();
  23.         // 原始价格
  24.         BigDecimal originalPrice = contextData.getOriginalPrice();
  25.         if (calculatedTempPrice != null) {
  26.             originalPrice = calculatedTempPrice;
  27.         }
  29.         // 计算折扣率
  30.         BigDecimal discountRate = discountPercentage.divide(ONE_HUNDRED, 2, RoundingMode.HALF_UP);
  32.         // 计算折扣后的价格（四舍五入，保留2位小数）
  33.         BigDecimal discountedPrice = originalPrice.multiply(discountRate).setScale(2, RoundingMode.HALF_UP);
  35.         contextData.setDiscountedPrice(discountedPrice);
  36.         contextData.setCalculatedTempPrice(discountedPrice);
  37.     }
  39.     @Override
  40.     public void before(DiscountPriceContextData contextData) {
  41.         Rule.super.before(contextData);
  42.     }
  44.     @Override
  45.     public void after(DiscountPriceContextData contextData) {
  46.         Rule.super.after(contextData);
  47.     }
  48. }
复制代码
3.4 新增满减折扣规则实现类 FullReductionDiscountRule.java

  1. package com.song.tools.ruleengine;
  3. import com.song.tools.ruleengine.core.Rule;
  4. import com.song.tools.ruleengine.core.RuleEngineContext;
  6. import java.math.BigDecimal;
  7. import java.math.RoundingMode;
  9. /**
  10. * 满减折扣规则
  11. *
  12. * @author song tools
  13. */
  14. public class FullReductionDiscountRule implements Rule<DiscountPriceContextData> {
  16.     /**
  17.      * 满减金额，满xx金额数
  18.      */
  19.     private final BigDecimal fullReductionBoundAmount;
  21.     /**
  22.      * 满减折扣金额，减去xx金额数
  23.      */
  24.     private final BigDecimal fullReductionDiscountAmount;
  26.     public FullReductionDiscountRule(BigDecimal fullReductionBoundAmount, BigDecimal fullReductionDiscountAmount) {
  27.         this.fullReductionBoundAmount = fullReductionBoundAmount;
  28.         this.fullReductionDiscountAmount = fullReductionDiscountAmount;
  29.     }
  31.     public void execute(RuleEngineContext<DiscountPriceContextData> context) {
  32.         DiscountPriceContextData contextData = context.getContextData();
  33.         // 临时价格
  34.         BigDecimal calculatedTempPrice = contextData.getCalculatedTempPrice();
  35.         // 原始价格
  36.         BigDecimal originalPrice = contextData.getOriginalPrice();
  37.         if (calculatedTempPrice != null) {
  38.             originalPrice = calculatedTempPrice;
  39.         }
  41.         // 比较金额是否满足满减条件
  42.         if (originalPrice.compareTo(fullReductionBoundAmount) >= 0) {
  43.             BigDecimal discountedPrice = originalPrice.subtract(fullReductionDiscountAmount).setScale(2, RoundingMode.HALF_UP);
  44.             contextData.setDiscountedPrice(discountedPrice);
  45.             contextData.setCalculatedTempPrice(discountedPrice);
  46.         }
  47.     }
  48. }
复制代码
3.5 编写测试类 Test.java

编排差别的规则，不通的顺序，验证最终的执行结果。
  1. package com.song.tools.ruleengine;
  3. import com.song.tools.ruleengine.core.DefaultRuleEngine;
  4. import com.song.tools.ruleengine.core.RuleEngineContext;
  5. import com.song.tools.ruleengine.core.RuleEngineExecuteTemplate;
  7. import java.math.BigDecimal;
  8. import java.math.RoundingMode;
  10. /**
  11. * 测试规则执行
  12. *
  13. * @author song tools
  14. */
  15. public class Test {
  17.     public static void main(String[] args) throws Exception {
  18.         System.out.println("----------------test1----------------");
  19.         test1();
  20.         System.out.println("----------------test1----------------");
  22.         System.out.println("----------------test2----------------");
  23.         test2();
  24.         System.out.println("----------------test2----------------");
  25.     }
  28.     private static void test1() {
  29.         // 创建规则引擎
  30.         DefaultRuleEngine<DiscountPriceContextData> ruleEngine = new DefaultRuleEngine<>();
  31.         // 创建规则+注册规则
  32.         ruleEngine.registerRule("percentageDiscountRule1", new PercentageDiscountRule(BigDecimal.valueOf(95)));
  33.         ruleEngine.registerRule("fixedAmountDiscountRule1", new FixedAmountDiscountRule(BigDecimal.valueOf(12.34)));
  34.         ruleEngine.registerRule("percentageDiscountRule2", new PercentageDiscountRule(BigDecimal.valueOf(80)));
  35.         ruleEngine.registerRule("fixedAmountDiscountRule2", new FixedAmountDiscountRule(BigDecimal.valueOf(12.4)));
  37.         // 创建上下文数据
  38.         RuleEngineContext<DiscountPriceContextData> context = new RuleEngineContext<>();
  39.         DiscountPriceContextData discountPriceContextData = new DiscountPriceContextData();
  40.         discountPriceContextData.setOriginalPrice(BigDecimal.valueOf(100));
  41.         context.setContextData(discountPriceContextData);
  43.         // 执行规则引擎
  44.         ruleEngine.executeRule(context);
  46.         // 打印执行结果
  47.         System.out.println(discountPriceContextData.getDiscountedPrice());
  49.         System.out.println(BigDecimal.valueOf(100).multiply(BigDecimal.valueOf(0.95)).subtract(BigDecimal.valueOf(12.34)));
  50.         System.out.println(BigDecimal.valueOf(82.66).multiply(BigDecimal.valueOf(0.8).setScale(2, RoundingMode.HALF_UP)).subtract(BigDecimal.valueOf(12.4)).setScale(2, RoundingMode.HALF_UP));
  51.     }
  53.     private static void test2() throws Exception {
  54.         // 创建上下文数据
  55.         DiscountPriceContextData discountPriceContextData = new DiscountPriceContextData();
  56.         discountPriceContextData.setOriginalPrice(BigDecimal.valueOf(100));
  58.         // 创建规则引擎执行模板
  59.         RuleEngineExecuteTemplate<DiscountPriceContextData> ruleEngineExecuteTemplate = new RuleEngineExecuteTemplate<>();
  61.         // 注册规则&执行规则
  62.         ruleEngineExecuteTemplate.registerRule(new PercentageDiscountRule(BigDecimal.valueOf(95))) // 95折
  63.                 .registerRule(new FixedAmountDiscountRule(BigDecimal.valueOf(12.34))) // 减12.34元
  64.                 .registerRule(new PercentageDiscountRule(BigDecimal.valueOf(80))) // 80折
  65.                 .registerRule(new FullReductionDiscountRule(BigDecimal.valueOf(50), BigDecimal.valueOf(10))) // 满50减10
  66.                 .registerRule(new FixedAmountDiscountRule(BigDecimal.valueOf(12.4))) // 减12.4元
  67.                 .registerRule(new FullReductionDiscountRule(BigDecimal.valueOf(40), BigDecimal.valueOf(19.9))) // 满40减19.9元
  68.                 .execute(discountPriceContextData);
  70.         // 打印最终结果
  71.         System.out.println(discountPriceContextData.getDiscountedPrice());
  72.     }
  73. }
复制代码
3.6 测试类运行结果

  1. ----------------test1----------------
  2. 53.73
  3. 82.66
  4. 53.73
  5. ----------------test1----------------
  6. ----------------test2----------------
  7. 23.83
  8. ----------------test2----------------
复制代码
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

来自云龙湖轮廓分明的月亮

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

AI 运维 CIO 存储 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表