RuleBook扩展开发：自定义RuleChain与Auditor实现-尧图网络科技

RuleBook扩展开发：自定义RuleChain与Auditor实现

【免费下载链接】rulebook100% Java, Lambda Enabled, Lightweight Rules Engine with a Simple and Intuitive DSL项目地址: https://gitcode.com/gh_mirrors/ru/rulebook

RuleBook是一个100% Java编写、支持Lambda、轻量级的规则引擎，提供简单直观的DSL。本文将详细介绍如何扩展RuleBook框架，实现自定义RuleChain与Auditor，以满足复杂业务场景的需求。

一、RuleChain基础与扩展原理

RuleChain决定了规则执行的流程和失败处理策略，是RuleBook的核心组件之一。RuleBook提供了默认的规则链实现，但在实际业务中，我们常常需要根据特定需求自定义规则执行顺序和错误处理逻辑。

1.1 RuleChainActionType枚举解析

RuleBook框架通过RuleChainActionType枚举定义了规则失败时的默认处理策略：

public enum RuleChainActionType { STOP_ON_FAILURE, // 规则失败时停止执行 ERROR_ON_FAILURE, // 规则失败时抛出异常 CONTINUE_ON_FAILURE // 规则失败时继续执行 }

这个枚举位于com/deliveredtechnologies/rulebook/model/RuleChainActionType.java，是理解RuleChain工作机制的基础。

1.2 自定义RuleChain实现步骤

实现自定义RuleChain通常需要以下步骤：

创建RuleChain接口实现类，继承RuleBook或其实现类
重写规则执行方法，定义自定义执行流程
实现规则间数据传递机制
定义失败处理策略

二、自定义RuleChain实战

2.1 基于CoRRuleBook的扩展

RuleBook提供了CoRRuleBook（责任链模式规则书）实现，我们可以基于它进行扩展：

public class CustomRuleChain extends CoRRuleBook<String> { @Override public void run() { // 自定义规则执行逻辑 for (Rule rule : _rules) { try { rule.invoke(); // 自定义规则间数据传递 propagateResults(rule); } catch (Exception e) { // 自定义错误处理 handleException(rule, e); if (shouldStopOnFailure(rule)) { break; } } } } // 自定义结果传递逻辑 private void propagateResults(Rule rule) { // 实现规则间结果传递 } // 自定义失败判断逻辑 private boolean shouldStopOnFailure(Rule rule) { return rule.getRuleChainAction() == RuleChainActionType.STOP_ON_FAILURE; } }

2.2 规则优先级与条件执行

在复杂业务场景中，我们可能需要根据动态条件调整规则执行顺序：

public class PriorityRuleChain extends CoRRuleBook<String> { @Override public void defineRules() { // 根据条件动态排序规则 _rules.sort((r1, r2) -> { int priority1 = getRulePriority(r1); int priority2 = getRulePriority(r2); return Integer.compare(priority2, priority1); // 降序排列 }); } // 获取规则优先级 private int getRulePriority(Rule rule) { // 从规则注解或属性中获取优先级 return rule instanceof PrioritizedRule ? ((PrioritizedRule) rule).getPriority() : 0; } }

三、Auditor实现与规则审计

RuleBook的审计功能允许我们跟踪规则执行过程，记录规则状态、执行时间和结果，这对于调试和业务分析非常有价值。

3.1 Auditor接口与默认实现

RuleBook提供了Auditor接口和RuleBookAuditor实现类，位于com/deliveredtechnologies/rulebook/model/RuleBookAuditor.java。默认实现可以记录规则执行状态、开始和结束时间。

3.2 自定义Auditor实现

要创建自定义审计器，只需实现Auditor接口或扩展RuleBookAuditor：

public class DetailedAuditor extends RuleBookAuditor<String> { private Map<String, RuleExecutionDetails> executionDetails = new HashMap<>(); @Override public void beforeRuleExecution(Rule rule) { RuleExecutionDetails details = new RuleExecutionDetails(); details.setRuleName(rule.getName()); details.setStartTime(System.currentTimeMillis()); executionDetails.put(rule.getName(), details); super.beforeRuleExecution(rule); } @Override public void afterRuleExecution(Rule rule, RuleStatus status) { super.afterRuleExecution(rule, status); RuleExecutionDetails details = executionDetails.get(rule.getName()); details.setEndTime(System.currentTimeMillis()); details.setStatus(status); details.setExecutionTime(details.getEndTime() - details.getStartTime()); // 记录规则结果 if (rule.getResult() != null) { details.setResult(rule.getResult().getValue().toString()); } } // 获取详细审计报告 public String getDetailedReport() { // 生成格式化报告 } }

3.3 使用自定义Auditor

在RuleBook中使用自定义审计器非常简单：

RuleBook ruleBook = new RuleBookAuditor<>(new CustomRuleChain(), new DetailedAuditor()); ruleBook.addRule(new SampleRule1()); ruleBook.addRule(new SampleRule2()); ruleBook.run(); // 获取审计报告 DetailedAuditor auditor = (DetailedAuditor) ruleBook; System.out.println(auditor.getDetailedReport());

四、高级应用：结合Spring框架

如果在Spring环境中使用RuleBook，可以创建Spring-aware的RuleChain和Auditor：

@Component public class SpringRuleChain extends CoRRuleBook<String> { @Autowired private RuleRepository ruleRepository; @Override public void defineRules() { // 从数据库加载规则 List<Rule> rules = ruleRepository.findByActiveTrue(); rules.forEach(this::addRule); } } @Component public class SpringAuditor extends RuleBookAuditor<String> { @Autowired private AuditLogService auditLogService; @Override public void afterRuleExecution(Rule rule, RuleStatus status) { super.afterRuleExecution(rule, status); // 保存审计日志到数据库 auditLogService.save(new AuditLog( rule.getName(), status.toString(), System.currentTimeMillis() - getRuleStartTime(rule) )); } }