193 lines
9.7 KiB
Markdown
193 lines
9.7 KiB
Markdown
<div align="center">
|
||
|
||
# <img alt="youlai-boot" height="32" valign="middle" src="./docs/images/logo/logo.png"> youlai-boot
|
||
|
||
**Spring Boot 企业级权限管理系统后端**
|
||
|
||
[](https://spring.io/projects/spring-boot)
|
||
[](https://openjdk.org/)
|
||
[](LICENSE)
|
||
[](https://gitee.com/youlaiorg/youlai-boot/stargazers)
|
||
[](https://github.com/youlaitech/youlai-boot)
|
||
[](https://gitcode.com/youlai/youlai-boot/stargazers)
|
||
|
||
</div>
|
||
|
||
<p align="center"><img src="./docs/images/rainbow.png" alt="rainbow"></p>
|
||
|
||
<div align="center">
|
||
|
||
[](https://vue.youlai.tech)
|
||
[](https://app.youlai.tech)
|
||
[](https://www.youlai.tech/docs/server/spring-boot/)
|
||
[](./README.en.md)
|
||
|
||
</div>
|
||
|
||
## 项目简介
|
||
|
||
**youlai-boot** 是一套基于 Spring Boot 的企业级权限管理系统后端，配套前端 [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) 和移动端 [youlai-app](https://gitee.com/youlaiorg/youlai-app)，并提供 **7 种语言实现**（Java / Node.js / Go / Python / PHP / C# / Rust），共享同一套 API 规范与数据库结构。适用于企业中后台管理系统的学习参考与二次开发。
|
||
|
||
## 核心特性
|
||
|
||
- 🔐 **安全体系** — Spring Security + JWT/Redis Token 双会话模式、令牌续期、多端互斥
|
||
- 🛡️ **细粒度权限** — RBAC 五级：数据 → 菜单 → 按钮 → 接口 → 字段
|
||
- ⚡ **代码生成器** — 一键生成前后端 CRUD 代码
|
||
- 📦 **模块齐全** — 用户、角色、菜单、部门、字典、文件、定时任务、消息中心、操作日志
|
||
- 🌐 **多租户 SaaS** — 数据隔离 + 租户配置，独立 [youlai-boot-tenant](https://gitee.com/youlaiorg/youlai-boot-tenant) 版本
|
||
- 🔌 **实时通信** — SSE 推送：在线用户数、字典同步、通知广播
|
||
|
||
## 系统预览
|
||
|
||
**PC 端**
|
||
|
||
<table align="center">
|
||
<tr>
|
||
<td><img alt="PC预览1" width="400" src="./docs/images/preview/pc-01.png"></td>
|
||
<td><img alt="PC预览2" width="400" src="./docs/images/preview/pc-02.png"></td>
|
||
</tr>
|
||
<tr>
|
||
<td><img alt="PC预览3" width="400" src="./docs/images/preview/pc-03.png"></td>
|
||
<td><img alt="PC预览4" width="400" src="./docs/images/preview/pc-04.png"></td>
|
||
</tr>
|
||
<tr>
|
||
<td><img alt="PC预览3" width="400" src="./docs/images/preview/pc-05.png"></td>
|
||
<td><img alt="PC预览4" width="400" src="./docs/images/preview/pc-06.png"></td>
|
||
</tr>
|
||
</table>
|
||
|
||
**移动端**
|
||
|
||
<table align="center">
|
||
<tr>
|
||
<td><img alt="APP预览1" width="200" src="./docs/images/preview/app-01.png"></td>
|
||
<td><img alt="APP预览2" width="200" src="./docs/images/preview/app-02.png"></td>
|
||
<td><img alt="APP预览3" width="200" src="./docs/images/preview/app-03.png"></td>
|
||
<td><img alt="APP预览4" width="200" src="./docs/images/preview/app-04.png"></td>
|
||
</tr>
|
||
</table>
|
||
|
||
## 快速开始
|
||
|
||
**环境要求**：JDK 17+ · MySQL 8.0+ · Redis 6.0+
|
||
|
||
1. 克隆项目：
|
||
```bash
|
||
git clone https://gitee.com/youlaiorg/youlai-boot.git
|
||
```
|
||
|
||
2. 导入数据库：
|
||
```bash
|
||
sql/youlai-admin.sql
|
||
```
|
||
|
||
3. 修改配置（可选，默认已配置线上只读数据源）：
|
||
```bash
|
||
src/main/resources/application-dev.yml
|
||
```
|
||
|
||
4. 启动服务：
|
||
|
||
**方式一：IDEA 启动（推荐）**
|
||
用 IDEA 打开项目，等待 Maven 依赖下载完成，运行启动类 `YouLaiBootApplication` 即可。
|
||
|
||
**方式二：命令行启动**
|
||
```bash
|
||
mvn spring-boot:run
|
||
```
|
||
|
||
启动后访问 [http://localhost:8000/doc.html](http://localhost:8000/doc.html)，能打开接口文档即说明后端已正常运行。
|
||
|
||
5. 启动前端（可选）：
|
||
如需可视化操作界面，启动配套前端 [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin)，访问 [http://localhost:3000](http://localhost:3000)，使用 `admin` / `123456` 登录。
|
||
|
||
> 更多内容详见官方文档：[快速开始](https://www.youlai.tech/docs/server/spring-boot/quick-start.html) · [部署指南](https://www.youlai.tech/docs/server/spring-boot/deploy.html)
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
youlai-boot/
|
||
├── docker/ # Docker 部署编排
|
||
├── docs/ # 项目文档与图片资源
|
||
├── sql/ # 数据库初始化脚本
|
||
├── src/ # 源码目录
|
||
│ ├── auth/ # 认证模块（登录/登出/令牌/验证码）
|
||
│ ├── codegen/ # 代码生成器
|
||
│ ├── common/ # 公共模块（常量/枚举/异常/统一响应/工具类）
|
||
│ ├── config/ # 配置类（Security/Redis/Captcha/OSS/邮件等）
|
||
│ ├── framework/ # 基础设施层
|
||
│ │ ├── mybatis/ # MyBatis-Plus 配置
|
||
│ │ ├── security/ # Spring Security（过滤器/Token/工具类）
|
||
│ │ └── web/ # Web 层（全局异常/跨域/限流）
|
||
│ ├── support/ # 能力服务
|
||
│ │ ├── file/ # 文件存储（MinIO/阿里云OSS/本地）
|
||
│ │ ├── mail/ # 邮件服务
|
||
│ │ ├── sms/ # 短信服务
|
||
│ │ └── sse/ # SSE 消息推送
|
||
│ └── system/ # 系统业务（用户/角色/菜单/部门/字典等）
|
||
└── pom.xml # Maven 依赖管理
|
||
```
|
||
|
||
## 生态矩阵
|
||
|
||
**前端**
|
||
|
||
| 项目 | 技术栈 | 说明 | 更新状态 |
|
||
|:-----|:-------|:-----|:---------|
|
||
| [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) | Vue 3 + Element Plus | PC 管理前端（主推） | ✅️ |
|
||
| [youlai-app](https://gitee.com/youlaiorg/youlai-app) | Vue 3 + UniApp | 移动端 App | ✅️ |
|
||
|
||
**后端**
|
||
|
||
| 项目 | 技术栈 | 说明 | 更新状态 |
|
||
|:-----|:-------|:-----|:---------|
|
||
| [youlai-boot](https://gitee.com/youlaiorg/youlai-boot) | Spring Boot + MyBatis-Plus | Java（主推） | ✅️ |
|
||
| [youlai-nest](https://gitee.com/youlaiorg/youlai-nest) | NestJS + TypeORM | Node.js | ✅️ |
|
||
| [youlai-gin](https://gitee.com/youlaiorg/youlai-gin) | Go + Gorm | Go | ✅️ |
|
||
| [youlai-django](https://gitee.com/youlaiorg/youlai-django) | Django + DRF | Python | ✅️ |
|
||
| [youlai-fastapi](https://gitee.com/youlaiorg/youlai-fastapi) | FastAPI + SQLAlchemy | Python | ✅️ |
|
||
| [youlai-laravel](https://gitee.com/youlaiorg/youlai-laravel) | Laravel + Eloquent | PHP | ✅️ |
|
||
| [youlai-think](https://gitee.com/youlaiorg/youlai-think) | ThinkPHP + ThinkORM | PHP | ✅️ |
|
||
| [youlai-aspnet](https://gitee.com/youlaiorg/youlai-aspnet) | ASP.NET Core + EF Core | C# | ✅️ |
|
||
| [youlai-axum](https://gitee.com/youlaiorg/youlai-axum) | Axum + SeaORM | Rust | ✅️ |
|
||
|
||
> 九种后端共享同一套 **RESTful API 规范** 和 **数据库结构**，前端可无缝切换。
|
||
|
||
**衍生版本**
|
||
|
||
| 项目 | 基于 | 类型 | 说明 | 更新状态 |
|
||
|:-----|:-----|:-----|:-----|:---------|
|
||
| [youlai-boot-tenant](https://gitee.com/youlaiorg/youlai-boot-tenant) | youlai-boot | 独立仓库 | 多租户 SaaS，租户隔离与租户配置 | ✅️ |
|
||
| [youlai-boot-flex](https://gitee.com/youlaiorg/youlai-boot-flex) | youlai-boot | 独立仓库 | 改用 MyBatis-Flex | ✅️ |
|
||
| [youlai-boot (db-pg)](https://gitee.com/youlaiorg/youlai-boot/tree/db-pg) | youlai-boot | 分支 | PostgreSQL 数据库分支 | ✅️ |
|
||
| [youlai-boot (multi-module)](https://gitee.com/youlaiorg/youlai-boot/tree/multi-module) | youlai-boot | 分支 | 多模块工程拆分 | ✅️ |
|
||
| [youlai-boot (spring-boot-3)](https://gitee.com/youlaiorg/youlai-boot/tree/spring-boot-3) | youlai-boot | 分支 | Spring Boot 3 兼容分支 | ✅️ |
|
||
| [youlai-nest (multi-tenant)](https://gitee.com/youlaiorg/youlai-nest/tree/multi-tenant) | youlai-nest | 分支 | 多租户 SaaS，租户隔离与租户配置 | ✅️ |
|
||
|
||
## 技术合作
|
||
|
||
本项目采用 [Apache License 2.0](LICENSE) 开源，可免费商用。欢迎在 [Issue](https://gitee.com/youlaiorg/youlai-boot/issues) 提交问题或反馈，也欢迎提交 [Pull Request](https://gitee.com/youlaiorg/youlai-boot/pulls) 共建。
|
||
|
||
如需技术支持、商务合作、二次开发、项目定制或私有化部署，可联系作者微信（见下方二维码）。
|
||
|
||
<table align="center">
|
||
<tr>
|
||
<td align="center">
|
||
<img src="./docs/images/qrcode/wechat-official.jpg" height="180" alt="公众号「有来技术」"><br>
|
||
<sub>公众号「有来技术」</sub>
|
||
</td>
|
||
<td> </td>
|
||
<td align="center">
|
||
<img src="./docs/images/qrcode/wechat-mp.jpg" height="180" alt="小程序「有来技术」"><br>
|
||
<sub>小程序「有来技术」</sub>
|
||
</td>
|
||
<td> </td>
|
||
<td align="center">
|
||
<img src="./docs/images/qrcode/wechat-personal.png" height="180" alt="添加作者微信"><br>
|
||
<sub>添加作者微信</sub>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<p align="center"><em>技术交流 · 问题反馈 · 商务合作</em></p>
|