# rule-engine

**Repository Path**: ouyang_shaohui/rule-engine

## Basic Information

- **Project Name**: rule-engine
- **Description**: 规则引擎
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-05-13
- **Last Updated**: 2026-04-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# rule-engine

## 介绍

这是一个功能强大的规则引擎框架，用于定义和执行业务规则。它支持复杂的表达式语法，提供灵活的变量占位符系统，具有高效的缓存机制和完善的日志记录功能。

## 软件架构

规则引擎框架采用模块化设计，主要包括以下组件：

1. **规则引擎核心** - 负责规则的注册、执行和管理
2. **规则解析器** - 解析规则表达式并生成可执行的结构，支持操作符优先级
3. **规则执行器** - 执行解析后的规则
4. **规则仓库** - 存储和管理规则定义
5. **变量解析器** - 解析上下文中的变量值，支持嵌套属性访问
6. **缓存管理器** - 提供规则解析结果的缓存机制
7. **日志系统** - 提供详细的执行日志

## 功能特性

- 灵活的表达式语法支持，包括括号和操作符优先级
- 支持嵌套属性访问的变量占位符系统（如 `#{user.address.city}`）
- 规则的动态注册和管理
- 高效的规则编译缓存机制
- 完善的错误处理和日志记录
- 支持多种规则存储方式（内存、文件系统等）
- 可扩展的函数库
- 支持数学运算、逻辑运算和比较运算

## 安装教程

1. 克隆项目到本地
2. 使用 Maven 构建项目：
   ```bash
   mvn clean install
   ```

## 使用说明

### 基本用法

```java
// 创建规则解析器
RuleParser parser = new DefaultRuleParser();

// 创建规则引擎
RuleEngine engine = new DefaultRuleEngine(parser);

// 定义规则
Rule rule = Rule.builder()
        .name("ageCheck")
        .expression("#{user.age} >= 18")
        .build();

// 注册规则
engine.registerRule(rule);

// 准备上下文数据
Map<String, Object> context = new HashMap<>();
Map<String, Object> user = new HashMap<>();
user.put("age", 20);
context.put("user", user);

// 执行规则
RuleExecutionResult result = engine.executeRule("ageCheck", context);
```

### 表达式语法

规则引擎支持以下表达式语法：

- 变量引用：`#{variable}`
- 比较操作：`==`, `!=`, `>`, `<`, `>=`, `<=`
- 数学运算：`+`, `-`, `*`, `/`
- 逻辑运算：`&&`, `||`
- 括号：`(`, `)`
- 嵌套属性访问：`#{user.address.city}`
- 常量：数字、字符串

### 规则存储

框架支持多种规则存储方式：

1. **内存存储**（默认）- 适用于简单的应用场景
2. **文件系统存储** - 将规则持久化到文件系统

## 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

## 特技

1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)