# nexus

**Repository Path**: umb/nexus

## Basic Information

- **Project Name**: nexus
- **Description**: NX 基于 Spring Boot 3.x + Vue 3 的企业级快速开发平台，采用 Maven 多模块架构
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-23
- **Last Updated**: 2026-04-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 项目规划文档

本文档包含 RuoYi-Vue-Plus 多模块重构项目的完整规划。

---

## 文档目录

### 01-项目概述
项目背景、技术架构和演进路线

| 文档 | 说明 | 状态 |
|------|------|------|
| [02-技术架构](01-项目概述/02-技术架构.md) | 整体技术架构设计 | ✅ |
| [04-演进路线](01-项目概述/04-演进路线.md) | 项目发展阶段规划 | ✅ |

### 02-开发指南
开发环境、快速开始和代码规范

| 文档 | 说明 | 状态 |
|------|------|------|
| 01-环境准备 | 开发环境搭建 | 📋 待创建 |
| 02-快速开始 | 快速上手教程 | 📋 待创建 |
| 03-代码规范 | 编码规范 | 📋 待创建 |
| 04-目录结构 | 项目目录结构说明 | 📋 待创建 |

### 03-核心模块
基础架构到系统管理的实现

| 文档 | 说明 | 状态 |
|------|------|------|
| [01-基础工程](03-核心模块/01-基础工程.md) | 多模块 Maven 项目结构 | ✅ |
| [02-配置与文档](03-核心模块/02-配置与文档.md) | 多环境配置、统一返回、异常处理 | ✅ |
| [03-数据库集成](03-核心模块/03-数据库集成.md) | MyBatis-Plus、多数据源、分页 | ✅ |
| [04-权限认证](03-核心模块/04-权限认证.md) | Sa-Token、JWT、RBAC | ✅ |
| [05-缓存与Redis](03-核心模块/05-缓存与Redis.md) | Redisson、Spring Cache、分布式锁 | ✅ |
| [06-系统管理](03-核心模块/06-系统管理.md) | 用户/角色/菜单/部门/岗位/字典/参数 | ✅ |

### 04-高级功能
企业级高级功能模块

| 文档 | 说明 | 状态 |
|------|------|------|
| [01-数据脱敏](04-高级功能/01-数据脱敏.md) | 敏感数据自动脱敏 | ✅ |
| [02-Excel处理](04-高级功能/02-Excel处理.md) | 导入导出、类型转换 | ✅ |
| [03-文件存储](04-高级功能/03-文件存储.md) | S3 协议对象存储 | ✅ |
| [04-操作日志](04-高级功能/04-操作日志.md) | 操作/登录日志、异步存储 | ✅ |
| [05-数据权限](04-高级功能/05-数据权限.md) | 行级数据权限过滤 | ✅ |
| [06-幂等性](04-高级功能/06-幂等性.md) | 防重复提交、Token 幂等 | ✅ |
| [07-限流](04-高级功能/07-限流.md) | 接口限流、熔断降级 | ✅ |

### 05-扩展功能
待规划的功能模块

| 文档 | 说明 | 状态 |
|------|------|------|
| [01-代码生成器](05-扩展功能/01-代码生成器.md) | 基于模板生成代码 | 📋 |
| [02-定时任务](05-扩展功能/02-定时任务.md) | 分布式定时任务 | 📋 |
| [03-消息通知](05-扩展功能/03-消息通知.md) | 短信/邮件/站内信 | 📋 |
| [04-工作流](05-扩展功能/04-工作流.md) | 流程引擎集成 | 📋 |
| [05-多租户](05-扩展功能/05-多租户.md) | SaaS 多租户支持 | 📋 |

### 06-运维部署
部署、监控和性能优化

| 文档 | 说明 | 状态 |
|------|------|------|
| 01-部署指南 | Docker/K8s 部署 | 📋 待创建 |
| 02-监控告警 | 监控指标、告警配置 | 📋 待创建 |
| 03-性能优化 | 性能调优指南 | 📋 待创建 |

### 07-问题记录
问题排查与解决方案

| 文档 | 说明 |
|------|------|
| [登录失败问题分析](07-问题记录/登录失败问题分析.md) | 登录失败原因分析 |

### 99-附录
数据库设计、API 规范等

| 文档 | 说明 | 状态 |
|------|------|------|
| 数据库设计 | ER图、表结构 | 📋 待创建 |
| API规范 | 接口设计规范 | 📋 待创建 |
| 更新日志 | 文档更新历史 | 📋 待创建 |

---

## 快速导航

### 如果你是新加入的开发者

推荐阅读顺序：

1. **[01-项目概述/02-技术架构.md](01-项目概述/02-技术架构.md)** - 了解整体技术架构
2. **[01-项目概述/04-演进路线.md](01-项目概述/04-演进路线.md)** - 了解项目发展阶段
3. **[02-开发指南/](02-开发指南/)** - 搭建开发环境
4. **[03-核心模块/](03-核心模块/)** - 了解已实现的功能

### 如果你要开始新功能开发

1. 查看 **[01-项目概述/04-演进路线.md](01-项目概述/04-演进路线.md)**，确定当前阶段
2. 查看对应章节的文档
3. 如果文档不存在，启动 `/plan` 模式规划新阶段

### 如果你要排查问题

查看 **[07-问题记录/](07-问题记录/)** 目录下是否有类似问题的记录。

---

## 当前进度

```
阶段 1: ████████████████████ 100% 基础工程
阶段 2: ████████████████████ 100% 配置与文档
阶段 3: ████████████████████ 100% 数据库集成
阶段 4: ████████████████████ 100% 权限认证
阶段 5: ████████████████████ 100% 缓存与Redis
阶段 6: ████████████████████ 100% 系统管理
阶段 7: ████████████████████ 100% 高级功能模块
阶段 8: ░░░░░░░░░░░░░░░░░░░░   0% 代码生成器
阶段 9: ░░░░░░░░░░░░░░░░░░░░   0% 定时任务
阶段 10: ░░░░░░░░░░░░░░░░░░░░  0% 消息通知
阶段 11: ░░░░░░░░░░░░░░░░░░░░  0% 工作流
阶段 12: ░░░░░░░░░░░░░░░░░░░░  0% 多租户支持
```

**总体进度**: 7/12 阶段完成 (58%)

---

## 文档维护

### 新增章节文档

1. 在对应章节目录下创建文档
2. 按 `XX-文档名称.md` 格式命名
3. 更新本文档的目录表格

### 文档命名规范

| 目录 | 命名格式 | 示例 |
|------|----------|------|
| `03-核心模块/` | `XX-简短描述.md` | `01-基础工程.md` |
| `04-高级功能/` | `XX-功能名称.md` | `01-数据脱敏.md` |
| `05-扩展功能/` | `XX-功能名称.md` | `01-代码生成器.md` |
| `07-问题记录/` | `问题简述.md` | `登录失败问题分析.md` |

---

## 更新日志

| 日期 | 更新内容 |
|------|----------|
| 2026-03-30 | 重新规划文档结构，按章节整理 |
| 2026-03-30 | 拆分阶段7为7个独立章节 |
| 2026-03-30 | 创建扩展功能占位文档 |

---

## 相关链接

- [项目主页](../README.md)
- [源码目录](../nx-admin/)