From 9d117ce8846d3afea27dea422433070139b5888e Mon Sep 17 00:00:00 2001 From: "Ray.Hao" <1490493387@qq.com> Date: Wed, 4 Mar 2026 10:30:28 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E4=BC=98=E5=8C=96=20README=20=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E7=BB=93=E6=9E=84=E5=92=8C=E5=86=85=E5=AE=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 242 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 125 insertions(+), 117 deletions(-) diff --git a/README.md b/README.md index e7d1096e..c2879605 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@
logo

youlai-boot

- 有来技术 - 有来技术 + Java + Spring Boot - 有来技术 + GitCode - 有来技术 + Gitee - 有来技术 + GitHub
@@ -22,161 +22,169 @@ 🌐 官网

+--- + ## 📢 项目简介 -基于 JDK 17、Spring Boot 4、Spring Security（随 Spring Boot 4.x） -、JWT、Redis、Mybatis-Plus、Vue 3、Element-Plus 构建的前后端分离单体权限管理系统 -。 [Mybatis-Flex 版本](https://gitee.com/youlaiorg/youlai-boot-flex) +基于 JDK 17、Spring Boot 4、Spring Security、JWT、Redis、MyBatis-Plus、Vue 3、Element Plus 构建的前后端分离权限管理系统。 -- **🚀 开发框架**: 使用 Spring Boot 4 和 Vue 3，以及 Element-Plus 等主流技术栈， - 实时更新。 +[MyBatis-Flex 版本](https://gitee.com/youlaiorg/youlai-boot-flex) -- **🔐 安全认证**: 基于 Spring Security 原生架构，集成 JWT 令牌自动续期（无状态 - ）和 Redis 会话多端互斥管理（实时强制离线）双重认证机制，构建企业级身份安全中 - 枢。 +**核心特性** -- **🔑 权限管理**: 基于 RBAC 模型，实现细粒度的权限控制，涵盖接口方法和按钮级别 - 。 +- **🚀 技术栈**：Spring Boot 4 + Vue 3 + Element Plus，持续跟进最新版本 -- **🛠️ 功能模块**: 包括用户管理、角色管理、菜单管理、部门管理、字典管理等功能。 +- **🔐 安全认证**：Spring Security + JWT 无状态认证 + Redis 会话管理，支持令牌自动续期和多端互斥 + +- **🔑 权限控制**：RBAC 模型，接口级 + 按钮级细粒度权限 + +- **🛠️ 功能模块**：用户、角色、菜单、部门、字典管理等基础模块 ## 🌈 项目源码 -| 项目类型 | Gitee | Github | GitCode | -| -------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------ | --------------------------------------------------------------------- | -| ✅ Java 后端 | [youlai-boot](https://gitee.com/youlaiorg/youlai-boot) | [youlai-boot](https://github.com/haoxianrui/youlai-boot) | [youlai-boot](https://gitcode.com/youlai/youlai-boot) | -| vue3 前端 | [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) | [vue3-element-admin](https://github.com/youlaitech/vue3-element-admin) | [vue3-element-admin](https://gitcode.com/youlai/vue3-element-admin) | +| 项目 | Gitee | GitHub | GitCode | +|------|-------|--------|---------| +| Java 后端 | [youlai-boot](https://gitee.com/youlaiorg/youlai-boot) | [youlai-boot](https://github.com/haoxianrui/youlai-boot) | [youlai-boot](https://gitcode.com/youlai/youlai-boot) | +| Vue 3 前端 | [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) | [vue3-element-admin](https://github.com/youlaitech/vue3-element-admin) | [vue3-element-admin](https://gitcode.com/youlai/vue3-element-admin) | | uni-app 移动端 | [vue-uniapp-template](https://gitee.com/youlaiorg/vue-uniapp-template) | [vue-uniapp-template](https://github.com/youlaitech/vue-uniapp-template) | [vue-uniapp-template](https://gitcode.com/youlai/vue-uniapp-template) | ## 📚 项目文档 -| 文档名称 | 访问地址 | -| ------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| 在线接口文档 | [https://www.apifox.cn/apidoc](https://www.apifox.cn/apidoc/shared-195e783f-4d85-4235-a038-eec696de4ea5) | -| 项目介绍与使用指南 | [https://www.youlai.tech/youlai-boot/](https://www.youlai.tech/youlai-boot/) | -| 功能详解与操作手册 | [https://youlai.blog.csdn.net/article/details/145178880](https://youlai.blog.csdn.net/article/details/145178880) | -| 新手入门指南(项目 0 到 1) | [https://youlai.blog.csdn.net/article/details/145177011](https://youlai.blog.csdn.net/article/details/145177011) | +| 文档 | 地址 | +|------|------| +| 在线接口文档 | [Apifox](https://www.apifox.cn/apidoc/shared-195e783f-4d85-4235-a038-eec696de4ea5) | +| 官方文档 | [youlai.tech](https://www.youlai.tech/youlai-boot/) | +| 功能详解 | [CSDN](https://youlai.blog.csdn.net/article/details/145178880) | +| 入门指南 | [CSDN](https://youlai.blog.csdn.net/article/details/145177011) | ## 📁 项目目录
- 目录结构 - -
+展开目录结构 ``` youlai-boot -├── docker # Docker 目录 -│ ├── docker-compose.yml # docker-compose 脚本 -├── sql # SQL脚本 -│ ├── mysql # MySQL 脚本 -├── src # 源码目录 -│ ├── auth # 认证模块（登录入口） -│ ├── common # 公共模块 -│ │ ├── annotation # 注解定义 -│ │ ├── base # 基础类 -│ │ ├── constant # 常量 -│ │ ├── enums # 枚举类型 -│ │ ├── model # 数据模型 -│ │ └── util # 工具类 -│ ├── config # 自动装配配置 -│ │ └── property # 配置属性目录 -│ ├── core # 核心框架 -│ │ ├── aspect # 切面(日志、防重提交) -│ │ ├── exception # 异常处理 -│ │ ├── filter # 过滤器(请求日志、限流) -│ │ ├── validator # 验证器 -│ │ └── web # Web响应封装(Result、PageResult等) -│ ├── infra # 基础服务 -│ │ ├── codegen # 代码生成模块 -│ │ ├── file # 文件服务 -│ │ ├── mail # 邮件服务 -│ │ ├── sms # 短信服务 -│ │ └── websocket # WebSocket服务 -│ ├── plugin # 插件扩展 -│ │ ├── knife4j # Knife4j 扩展 -│ │ └── mybatis # Mybatis 扩展 -│ ├── security # 安全框架（Spring Security） -│ │ ├── exception # 安全异常 -│ │ ├── filter # 安全过滤器 -│ │ ├── handler # 安全处理器 -│ │ ├── model # 安全模型 -│ │ ├── provider # 认证提供者 -│ │ ├── service # 安全服务 -│ │ ├── token # Token管理 -│ │ └── util # 安全工具类 -│ ├── system # 系统模块 -│ │ ├── controller # 控制层 -│ │ ├── converter # MapStruct 转换器 -│ │ ├── enums # 枚举 -│ │ ├── handler # 处理器 -│ │ ├── listener # 监听器 -│ │ ├── mapper # 数据库访问层 -│ │ ├── model # 模型层 -│ │ │ ├── bo # 业务对象 -│ │ │ ├── dto # 数据传输对象 -│ │ │ ├── entity # 实体对象 -│ │ │ ├── event # 事件对象 -│ │ │ ├── form # 表单对象 -│ │ │ ├── query # 查询参数对象 -│ │ │ └── vo # 视图对象 -│ │ └── service # 业务逻辑层 -│ └── YouLaiBootApplication # 启动类 -└── end +├── docker/ # Docker 部署 +│ ├── minio/ # MinIO 对象存储 +│ ├── mysql/ # MySQL 数据库 +│ ├── postgres/ # PostgreSQL 数据库 +│ ├── redis/ # Redis 缓存 +│ ├── xxljob/ # XXL-JOB 调度中心 +│ └── docker-compose.yml # 容器编排脚本 +├── sql/ # 数据库脚本 +│ └── mysql/ # MySQL 初始化脚本 +├── src/main/java/com/youlai/boot/ +│ ├── auth/ # 认证模块 +│ ├── common/ # 公共模块 +│ │ ├── annotation/ # 自定义注解 +│ │ ├── base/ # 基础类 +│ │ ├── constant/ # 常量定义 +│ │ ├── enums/ # 枚举类型 +│ │ ├── model/ # 公共模型 +│ │ └── util/ # 工具类 +│ ├── config/ # 配置模块 +│ │ └── property/ # 配置属性 +│ ├── core/ # 核心模块 +│ │ ├── aspect/ # AOP 切面（日志、防重） +│ │ ├── exception/ # 全局异常处理 +│ │ ├── filter/ # 过滤器（日志、限流） +│ │ ├── validator/ # 参数校验 +│ │ └── web/ # 响应封装 +│ ├── file/ # 文件服务 +│ │ ├── controller/ # 文件接口 +│ │ ├── model/ # 文件模型 +│ │ └── service/ # 文件逻辑 +│ ├── plugin/ # 插件扩展 +│ │ ├── knife4j/ # 接口文档增强 +│ │ └── mybatis/ # MyBatis 扩展 +│ ├── security/ # 安全模块 +│ │ ├── exception/ # 安全异常 +│ │ ├── filter/ # 安全过滤器 +│ │ ├── handler/ # 安全处理器 +│ │ ├── model/ # 安全模型 +│ │ ├── provider/ # 认证提供者 +│ │ ├── service/ # 安全服务 +│ │ ├── token/ # Token 管理 +│ │ └── util/ # 安全工具 +│ ├── support/ # 支撑服务 +│ │ ├── mail/ # 邮件服务 +│ │ ├── sms/ # 短信服务 +│ │ └── websocket/ # WebSocket 服务 +│ ├── system/ # 系统模块 +│ │ ├── controller/ # 控制器 +│ │ ├── converter/ # 对象转换器 +│ │ ├── enums/ # 枚举定义 +│ │ ├── handler/ # 业务处理器 +│ │ ├── listener/ # 事件监听器 +│ │ ├── mapper/ # 数据访问层 +│ │ ├── model/ # 数据模型 +│ │ │ ├── bo/ # 业务对象 +│ │ │ ├── dto/ # 传输对象 +│ │ │ ├── entity/ # 实体对象 +│ │ │ ├── event/ # 事件对象 +│ │ │ ├── form/ # 表单对象 +│ │ │ ├── query/ # 查询对象 +│ │ │ └── vo/ # 视图对象 +│ │ └── service/ # 业务逻辑层 +│ ├── tool/ # 工具模块 +│ │ └── codegen/ # 代码生成器 +│ └── YouLaiBootApplication.java # 启动类 +└── pom.xml # Maven 配置 ```
-## 🚀 项目启动 +## 🚀 快速开始 -📚 完整流程参考: -[项目启动](https://www.youlai.tech/youlai-boot/1.%E9%A1%B9%E7%9B%AE%E5%90%AF%E5%8A%A8/) +**详细文档**：[项目启动指南](https://youlai.blog.csdn.net/article/details/145177011) -1. **克隆项目** +### 1. 克隆项目 - ```bash - git clone https://gitee.com/youlaiorg/youlai-boot.git - ``` +```bash +git clone https://gitee.com/youlaiorg/youlai-boot.git +``` -2. **数据库初始化** +### 2. 初始化数据库 - 执行 [youlai_admin.sql](sql/mysql/youlai_admin.sql) 脚本完成数据库创建、表结 - 构和基础数据的初始化。 +执行 [youlai_admin.sql](sql/mysql/youlai_admin.sql) 创建数据库、表结构和基础数据。 -3. **修改配置** +### 3. 修改配置 - 默认连接`有来`线上 MySQL/Redis（仅读权限），本地开发时请修改 - [application-dev.yml](src/main/resources/application-dev.yml) 中的 MySQL 和 - Redis 连接信息。 +本地开发需修改 [application-dev.yml](src/main/resources/application-dev.yml) 中的 MySQL 和 Redis 连接信息。 -4. **启动项目** +> 默认连接线上环境（仅读权限），仅供体验使用。 - 执行 - [YoulaiBootApplication.java](src/main/java/com/youlai/boot/YoulaiBootApplication.java) - 的 main 方法完成后端项目启动； +### 4. 启动项目 - 访问接口文档地址 - [http://localhost:8000/doc.html](http://localhost:8000/doc.html) 验证项目启动 - 是否成功。 +运行 [YoulaiBootApplication.java](src/main/java/com/youlai/boot/YouLaiBootApplication.java)，访问 [http://localhost:8000/doc.html](http://localhost:8000/doc.html) 验证。 -## 🚀 项目部署 +## 🐳 Docker 部署 -参考官方文档: -[项目部署指南](https://www.youlai.tech/youlai-boot/5.%E9%A1%B9%E7%9B%AE%E9%83%A8%E7%BD%B2/) +**详细文档**：[部署指南](https://www.youlai.tech/docs/admin/backend/java/deploy.html) + +```bash +cd docker +docker-compose up -d +``` ## ✅ 项目统计 -![](https://repobeats.axiom.co/api/embed/544c5c0b5b3611a6c4d5ef0faa243a9066b89659.svg "Repobeats analytics image") +![](https://repobeats.axiom.co/api/embed/544c5c0b5b3611a6c4d5ef0faa243a9066b89659.svg) -Thanks to all the contributors! +## 🤝 贡献者 [![](https://contrib.rocks/image?repo=haoxianrui/youlai-boot)](https://github.com/haoxianrui/youlai-boot/graphs/contributors) -## 💖 加交流群 +## 💖 技术交流 -① 关注「有来技术」公众号，点击菜单 **交流群** 获取加群二维码（此举防止广告进群， -感谢理解和支持）。 +**公众号**：关注「有来技术」，点击菜单 **交流群** 获取加群二维码。 -② 直接添加微信 **`haoxianrui`** 备注「前端/后端/全栈」。 +![](https://foruda.gitee.com/images/1737108820762592766/3390ed0d_716974.png) -![有来技术公众号](https://foruda.gitee.com/images/1737108820762592766/3390ed0d_716974.png) +**微信**：添加 **`haoxianrui`**，备注「前端/后端/全栈」 + +**博客**：[CSDN](https://youlai.blog.csdn.net/) | [掘金](https://juejin.cn/user/4187394044331261) | [博客园](https://www.cnblogs.com/haoxianrui) | [51CTO](https://blog.51cto.com/youlai) | [知乎](https://www.zhihu.com/people/haoxr) + +**官网**：[https://www.youlai.tech](https://www.youlai.tech/) + +**代码仓库**：[Gitee](https://gitee.com/youlaiorg) | [GitHub](https://github.com/youlaitech) | [AtomGit](https://atomgit.com/youlai)