From 3c42f28184756df5a6bf5b107615c9c761d61ef6 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Tue, 26 Aug 2025 15:27:24 +0000 Subject: [PATCH] Update README.md --- README.md | 338 +++++++++++++++++++----------------------------------- 1 file changed, 119 insertions(+), 219 deletions(-) diff --git a/README.md b/README.md index 39b153d..80f3c0f 100644 --- a/README.md +++ b/README.md @@ -1,219 +1,119 @@ -

- - logo - - + - - logo - -

-

RuoYi-Geek v3.8.9-G

-

基于SpringBoot3+Vue3前后端分离的Java快速开发框架

-

- -

- -# 当前版本是3.8.9-G - -本人的其他两个推荐搭配的项目 - -1. [RuoYi-App-Geek: 这是若依极客生态的小程序版本 (gitee.com)](https://gitee.com/geek-xd/geek-uniapp-vue3-uview-plus-uchart) -2. [RuoYi-Vue3-Geek: 这是若依极客生态的Vue3版本 (gitee.com)](https://gitee.com/geek-xd/ruo-yi-vue3-geek) - -与本项目同为一个作者开发，兼容性最好，学习成本最低。 - -# 引言 - -RuoYi-Vue与RuoYi-App是基于SpringBoot2+Vue2打造的企业级开发框架，得到了广大开发者的喜爱和积极反馈。随着技术的迭代进步，SpringBoot3与Vue3逐渐进入开发者的视野。为了满足开发者对于新技术的追求，RuoYi官方文档提供了SpringBoot2至SpringBoot3的升级方法。与此同时，社区也涌现出了RuoYi-Vue3、RuoYi-App-Vue3的版本，展现了开发者社区对于技术升级的热情与努力。 - -然而，在升级的过程中，官方的方法为了兼顾Java1.8的特性与一些老旧的方法，未完全拥抱SpringBoot3与Java17的全部特性。而社区的RuoYi-Vue3、RuoYi-App-Vue3版本由于出自不同的团队之手，兼容性及整合性上存在些许不足。更为关键的是，尽管这些版本支持TypeScript，但缺乏与之相匹配的tsconfig.json配置文件，这使得在主流编辑器如VSCode中，TypeScript的语法提示环境并未达到最佳状态。 - -鉴于此，RuoYi-Geek生态应运而生。它旨在为广大开发者提供一个既保留原版本核心特性，又整合社区版优点的全新解决方案。在RuoYi-Geek中，我们深入调研了企业开发中常用的RuoYi扩展，并直接在框架中集成，确保开发者能够快速上手，高效开发。同时，我们采用了最新的SpringBoot3+Vue3技术栈，彻底移除了为了兼容Java1.8而保留的老旧方法。更为重要的是，我们为TypeScript开发环境加入了常用的tsconfig.json配置，使得开发者在VSCode等编辑器中能够获得更为舒适、便捷的语法提示体验。 - -RuoYi-Geek不仅仅是一个简单的升级版本，更是对于RuoYi生态的一次全面优化与整合。我们相信，通过RuoYi-Geek，开发者将能够更为高效、愉悦地开发出优秀的企业级应用。 - -## 平台简介 - -若依是一套全部开源的快速开发平台，毫无保留给个人及企业免费使用。 - -* 前端采用Vue3、Element Plus。 -* 后端采用Spring Boot3、Spring Security、Redis & Jwt。 -* 权限认证使用Jwt，支持多终端认证系统。 -* 支持加载动态权限菜单，多方式轻松权限控制。 -* 高效率开发，使用代码生成器可以一键生成前后端代码。 -* 多数据源与分库分表默认集成 -* 所有非基本模块可随意插拔，让开发更加简单高效 -* 提供了多个工具模块助力开发，如：在线接口模块、mybatis-jpa模块 -* 提供了多个常见业务模块简化开发，如：第三方认证模块、支付模块 -* 提供了多个常见的服务模块集成开发，如：websocket模块、minio模块 -* 特别鸣谢：[element](https://github.com/ElemeFE/element)，[vue-element-admin](https://github.com/PanJiaChen/vue-element-admin)，[eladmin-web](https://github.com/elunez/eladmin-web)。 -* 阿里云折扣场：[点我进入](http://aly.ruoyi.vip)，腾讯云秒杀场：[点我进入](http://txy.ruoyi.vip)   -* 阿里云优惠券：[点我领取](https://www.aliyun.com/minisite/goods?userCode=brki8iof&share_source=copy_link)，腾讯云优惠券：[点我领取](https://cloud.tencent.com/redirect.php?redirect=1025&cps_key=198c8df2ed259157187173bc7f4f32fd&from=console)   - -## 本项目与原项目的区别 - -### 核心 - -**模块化架构设计，支持各个模块的快速安拆，对第三方认证、第三方支付模块设计了基础的规范和基础模块。** - -### 细节 - -1. 改用SpringBoot3+java17的更新的技术栈并改掉所有的弃用的方法，全面拥抱java17的全新特性。 -2. 升级了代码生成器（配合本项目的vue3版本才可用），使关联表生成更加简单！ -3. 改用最新版本的SpringSecurity安全框架，以及采用最新的lambda 表达式的配置方式，更加通俗易懂！ -4. 自动Api文档以springfox替代springdoc来适配knife4j框架的4.x版本，更好的适配springboot3！ -5. 默认引入mybatis-plus增强mybatis，并自创工具模块mybatis-jpa简化CRUD！ -6. 默认引入lombok简化代码（注：基础模块并未使用mybatis-plus和lombok，对这两个扩展有争议的小伙伴可以直接删除，不会影响到框架本身滴，以及knife4j直接删除也不会影响到springdoc，主要还是为了方便咱们开发者呢！） -7. 提供了大量可随意插拔的模块，助力快速开发！同时ruoyi插件集成中的常用插件也以模块的形式直接集成在了项目中，也是可以随意插拔的嗷~ - -## 模块介绍（简单开发必看） - -* 最简单的开发就是删除所有的可移除模块，按需添加模块。 -* 测试中的模块请自己使用的时候一定要测试一下。 -* 对于小白，开发中的模块请直接删除。 - -``` - - -com.ruoyi -├── common // 工具类 -│ └── annotation // 自定义注解 -│ └── config // 全局配置 -│ └── constant // 通用常量 -│ └── core // 核心控制 -│ └── enums // 通用枚举 -│ └── exception // 通用异常 -│ └── filter // 过滤器处理 -│ └── utils // 通用类处理 -├── framework // 框架核心 -│ └── aspectj // 注解实现 -│ └── config // 系统配置 -│ └── datasource // 数据权限 -│ └── interceptor // 拦截器 -│ └── manager // 异步处理 -│ └── security // 权限控制 -│ └── web // 前端控制 -├── ruoyi-admin // 后台服务 -├── ruoyi-pay // 支付场景（基本业务完成） -│ └── common // 支付框架基础模块（基础框架搭建完成） -│ └── sqb // 收钱吧支付模块（功能可用，业务需要开发） -│ └── wx // 微信支付模块（基础业务完成） -│ └── alipay // 支付宝支付模块（基础业务完成） -│ └── starter // 支付场景启动器 -├── ruoyi-auth // 第三方认证场景（基础框架搭建完成） -│ └── common // 第三方认证基础模块（开发中） -│ └── justauth // 网站第三方认证模块（测试中，参照若依扩展改进，因没有这么多场景的code，请大家测试出问题后help解决一下发出来） -│ └── wx // 微信小程序认证模块（测试中） -│ └── phone // 手机认证模块（基础业务完成） -│ └── email // 邮箱认证模块（基础业务完成） -│ └── starter // 第三方认证启动器 -├── ruoyi-file // 文件服务系统（支持公开访问、临时凭证、分片上传等常见功能） -│ └── common // 基础模块和本地磁盘方式 -│ └── minio // minio分布式文件服务 -│ └── oss-alibaba // alibaba的oss云储存服务 -│ └── starter // 第三方认证启动器 -├── ruoyi-models // 业务场景 -│ └── online // 在线开发模块（可移除） -│ └── quartz // 定时任务（可移除） -│ └── generator // 代码生成（可移除） -│ └── form // 自定义在线表单（可移除） -│ └── flowable // 流程管理（可移除）（依赖于form模块） -│ └── message // 消息模块（可移除）（可以与phone、email模块协同） -│ └── starter // 业务场景启动器 -├── ruoyi-plugins // 插件 -│ └── ehcache // ehcache缓存插件（与redis模块同类，两者二选一） -│ └── mybatis-jpa // mybatis-jpa插件（可移除）（简化CRUD，以数据模型为基础开发） -│ └── mybatis-plus // mybatis-plus插件（可移除）（简化CRUD） -│ └── mybatis-interceptor // mybatis-interceptor插件（可移除）（简化数据鉴权和分页，扩展性强） -│ └── atomikos // atomikos分布式事务插件（可移除） -│ └── netty // netty插件（可移除） -│ └── rabbitmq // rabbitmq队列服务模块 -│ └── redis // redis缓存服务模块（与ehcache插件同类，两者二选一） -│ └── websocket // websocket插件（可移除） -│ └── starter // 插件整合模块 -├── ruoyi-system // 系统代码 -``` - -## 内置功能 - -1. 用户管理：用户是系统操作者，该功能主要完成系统用户配置。 -2. 部门管理：配置系统组织机构（公司、部门、小组），树结构展现支持数据权限。 -3. 岗位管理：配置系统用户所属担任职务。 -4. 菜单管理：配置系统菜单，操作权限，按钮权限标识等。 -5. 角色管理：角色菜单权限分配、设置角色按机构进行数据范围权限划分。 -6. 字典管理：对系统中经常使用的一些较为固定的数据进行维护。 -7. 参数管理：对系统动态配置常用参数。 -8. 通知公告：系统通知公告信息发布维护。 -9. 操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。 -10. 登录日志：系统登录日志记录查询包含登录异常。 -11. 在线用户：当前系统中活跃用户状态监控。 -12. 定时任务：在线（添加、修改、删除)任务调度包含执行结果日志。 -13. 代码生成：前后端代码的生成（java、html、xml、sql）支持CRUD下载 。 -14. 系统接口：根据业务代码自动生成相关的api接口文档。 -15. 服务监控：监视当前系统CPU、内存、磁盘、堆栈等相关信息。 -16. 缓存监控：对系统的缓存信息查询，命令统计等。 -17. 在线构建器：拖动表单元素生成相应的HTML代码。 -18. 连接池监视：监视当前系统数据库连接池状态，可进行分析SQL找出系统性能瓶颈。 -19. 支付场景 -20. 第三方登录场景 -21. 中间件场景 - -## 演示图 - -### 新加功能和增强功能演示 - - - - - - - - - - - - - - -
- -### 原有功能演示 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -# 联系我们： - -QQ交流群：744785891 +# RuoYi-Geek v3.8.9-G + +RuoYi-Geek 是一个基于 **SpringBoot3 + Vue3** 的前后端分离快速开发框架，旨在全面拥抱 SpringBoot3 与 Java17 的新特性，并优化 TypeScript 开发环境，提供更高效、便捷的企业级开发体验。 + +## 当前版本 + +**3.8.9-G** + +## 引言 + +RuoYi-Geek 是 RuoYi 生态的升级版本，专注于整合社区优秀实践，去除老旧兼容性代码，采用最新技术栈，提供更现代化的开发体验。它不仅支持 Vue3、TypeScript，还优化了代码生成器、安全框架、缓存监控等模块，使开发者能够更轻松地构建企业级应用。 + +## 平台简介 + +- **前端**：Vue3 + Element Plus +- **后端**：Spring Boot3 + Spring Security + Redis + Jwt +- **权限认证**：Jwt，支持多终端认证系统 +- **动态权限菜单**：支持多方式权限控制 +- **高效开发**：代码生成器一键生成前后端代码 +- **多数据源与分库分表**：默认集成 +- **模块化架构**：支持模块插拔，简化开发流程 +- **工具模块**：如在线接口模块、mybatis-jpa 模块 +- **业务模块**：如第三方认证、支付模块 +- **服务模块**：如 WebSocket、MinIO 文件服务 + +## 与原 RuoYi 的区别 + +### 核心架构 + +- 模块化架构设计，支持模块快速插拔 +- 针对第三方认证、支付模块设计了基础规范和基础模块 + +### 技术栈升级 + +1. 使用 **SpringBoot3 + Java17**，全面拥抱 Java18+ 的新特性 +2. 升级 **Spring Security**，采用 Lambda 表达式配置方式 +3. 使用 **SpringFox** 替代 SpringDoc，适配 Knife4j 4.x +4. 默认集成 **MyBatis-Plus** 和 **MyBatis-JPA**，简化 CRUD 操作 +5. 默认集成 **Lombok**，简化代码结构（基础模块未强制依赖） +6. Knife4j 可插拔，不影响 SpringDoc 的使用 + +## 模块介绍 + +- **common**：通用工具类 +- **framework**：框架核心模块 +- **ruoyi-admin**：后台服务 +- **ruoyi-pay**：支付场景模块（支持微信、支付宝等） +- **ruoyi-auth**：第三方认证模块（支持微信小程序、邮箱、手机等） +- **ruoyi-file**：文件服务模块（支持本地、MinIO、OSS） +- **ruoyi-models**：业务模块（如在线开发、定时任务、流程管理、消息模块等） +- **ruoyi-plugins**：插件模块（如 Ehcache、Netty、RabbitMQ、WebSocket ://gitee.com/geek-xd/ruoyi-geek-springboot3 +- **RuoYi-Vue3-Geek**：Vue3 版本，兼容性更好，学习成本更低 + +## 内置功能 + +1. 用户管理 +2. 部门管理 +3. 岗位管理 +4. 菜单管理 +5. 角色管理 +6. 字典管理 +7. 参数管理 +8. 通知公告 +9. 操作日志 +10. 登录日志 +11. 在线用户 +12. 定时任务 +13. 代码生成 +14. 系统接口文档 +15. 服务监控 +16. 缓存监控 +17. 在线构建器 +18. 连接池监控 +19. 支付场景 +20. 第三方登录场景 +21. 中间件集成 + +## 演示图 + +### 新增功能与增强功能 + +![在线模块列表](./doc/image/online-mb-list.png) +![在线模块编辑](./doc/image/online-mb-edit.png) +![在线模块代码](./doc/image/online-mb-code.png) +![表单编辑](./doc/image/form-edit.png) +![代码编辑](./doc/image/code-edit.png) +![代码展示](./doc/image/code-show.png) + +### 原有功能 + +![功能截图1](https://oscimg.oschina.net/oscnet/cd1f90be5f2684f4560c9519c0f2a232ee8.jpg) +![功能截图2](https://oscimg.oschina.net/oscnet/1cbcf0e6f257c7d3a063c0e3f2ff989e4b3.jpg) +![功能截图3](https://oscimg.oschina.net/oscnet/up-8074972883b5ba0622e13246738ebba237a.png) +![功能截图4](https://oscimg.oschina.net/oscnet/up-9f88719cdfca9af2e58b352a20e23d43b12.png) +![功能截图5](https://oscimg.oschina.net/oscnet/up-39bf2584ec3a529b0d5a3b70d15c9b37646.png) +![功能截图6](https://oscimg.oschina.net/oscnet/up-936ec82d1f4872e1bc980927654b6007307.png) +![功能截图7](https://oscimg.oschina.net/oscnet/5e8c387724954459291aafd5eb52b456f53.jpg) +![功能截图8](https://oscimg.oschina.net/oscnet/644e78da53c2e92a95dfda4f76e6d117c4b.jpg) +![功能截图9](https://oscimg.oschina.net/oscnet/up-8370a0d02977eebf6dbf854c8450293c937.png) +![功能截图10](https://oscimg.oschina.net/oscnet/up-49003ed83f60f633e7153609a53a2b644f7.png) +![功能截图11](https://oscimg.oschina.net/oscnet/up-d4fe726319ece268d4746602c39cffc0621.png) +![功能截图12](https://oscimg.oschina.net/oscnet/up-c195234bbcd30be6927f037a6755e6ab69c.png) + +## 联系我们 + +- QQ交流群：744785891 + +## 推荐项目 + +1. [RuoYi-App-Geek](https://gitee.com/geek-xd/geek-uniapp-vue3-uview-plus-uchart)：RuoYi 极客生态的小程序版本 +2. [RuoYi-Vue3-Geek](https://gitee.com/geek-xd/ruo-yi-vue3-geek)：RuoYi 极客生态的 Vue3 版本 + +这两个项目与本项目同为一个作者开发，兼容性最好，学习成本最低。 + +--- + +**许可证**：MIT + +**文档更新时间**：2025-04-05 \ No newline at end of file -- Gitee