mirror of
https://gitee.com/dromara/RuoYi-Vue-Plus.git
synced 2026-09-18 01:25:28 +08:00
配置
This commit is contained in:
lizhw
parent
00936946d8
commit
70418bfb84
373
README.md
373
README.md
@ -1,182 +1,261 @@
|
|||||||
<img src="https://foruda.gitee.com/images/1679673773341074847/178e8451_1766278.png" width="50%" height="50%">
|
# RuoYi-Vue-Plus
|
||||||
<div style="height: 10px; clear: both;"></div>
|
|
||||||
|
|
||||||
- - -
|
## 项目介绍
|
||||||
## 平台简介
|
|
||||||
|
|
||||||
[](https://gitee.com/dromara/RuoYi-Vue-Plus)
|
RuoYi-Vue-Plus是一个基于Spring Boot、Spring Cloud和Vue的企业级后台管理系统，提供了完整的微服务架构解决方案。本项目在RuoYi-Vue的基础上进行了功能扩展和性能优化，旨在为企业级应用提供更加稳定、高效、安全的开发框架。
|
||||||
[](https://github.com/dromara/RuoYi-Vue-Plus)
|
|
||||||
[](https://gitee.com/dromara/RuoYi-Vue-Plus/blob/master/LICENSE)
|
|
||||||
[](https://www.jetbrains.com/?from=RuoYi-Vue-Plus)
|
|
||||||
<br>
|
|
||||||
[](https://gitee.com/dromara/RuoYi-Vue-Plus)
|
|
||||||
[]()
|
|
||||||
[]()
|
|
||||||
[]()
|
|
||||||
|
|
||||||
> RuoYi-Vue-Plus 是重写 RuoYi-Vue 针对 `分布式集群与多租户` 场景全方位升级(不兼容原框架)
|
## 技术栈
|
||||||
|
|
||||||
> 项目代码、文档 均开源免费可商用 遵循开源协议在项目中保留开源协议文件即可<br>
|
### 后端技术
|
||||||
活到老写到老 为兴趣而开源 为学习而开源 为让大家真正可以学到技术而开源
|
- Spring Boot 3.x
|
||||||
|
- Spring Cloud
|
||||||
|
- MyBatis-Plus
|
||||||
|
- MySQL 8
|
||||||
|
- Redis
|
||||||
|
- Docker
|
||||||
|
- Sa-Token（认证授权）
|
||||||
|
- SnailJob（任务调度）
|
||||||
|
|
||||||
> 系统演示: [传送门](https://plus-doc.dromara.org/#/common/demo_system)
|
### 前端技术
|
||||||
|
- Vue 3
|
||||||
|
- Element Plus
|
||||||
|
- Vite
|
||||||
|
|
||||||
> 前端项目地址: [plus-ui](https://gitee.com/JavaLionLi/plus-ui)
|
## 功能特性
|
||||||
|
|
||||||
> 文档地址: [plus-doc](https://plus-doc.dromara.org)
|
### 核心功能
|
||||||
|
- 用户管理：用户注册、登录、权限管理
|
||||||
|
- 角色管理：角色权限分配
|
||||||
|
- 部门管理：组织架构管理
|
||||||
|
- 菜单管理：动态菜单配置
|
||||||
|
- 字典管理：系统参数配置
|
||||||
|
- 日志管理：操作日志、登录日志
|
||||||
|
- 系统监控：服务器监控、数据库监控
|
||||||
|
|
||||||
## 赞助商
|
### 扩展功能
|
||||||
|
- 工作流管理：流程定义、流程实例、任务管理
|
||||||
|
- 表单管理：动态表单设计与配置
|
||||||
|
- 多租户支持：SaaS模式部署
|
||||||
|
- 短信服务：集成短信发送功能
|
||||||
|
- 邮件服务：集成邮件发送功能
|
||||||
|
- OSS服务：对象存储集成
|
||||||
|
- 社交登录：支持第三方登录
|
||||||
|
- 小程序登录：支持微信小程序登录
|
||||||
|
- API文档：自动生成API文档
|
||||||
|
|
||||||
MaxKey 业界领先单点登录产品 - https://gitee.com/dromara/MaxKey <br>
|
## 快速开始
|
||||||
CCFlow 驰聘低代码-流程-表单 - https://gitee.com/opencc/RuoYi-JFlow <br>
|
|
||||||
数舵科技 软件定制开发APP小程序等 - http://www.shuduokeji.com/ <br>
|
|
||||||
引迈信息 软件开发平台 - https://www.jnpfsoft.com/index.html?from=plus-doc <br>
|
|
||||||
[如何成为赞助商 加群联系作者详谈](https://plus-doc.dromara.org/#/common/add_group)
|
|
||||||
|
|
||||||
# 本框架与RuoYi的功能差异
|
### 环境要求
|
||||||
|
- JDK 17+
|
||||||
|
- MySQL 8+
|
||||||
|
- Redis 7+
|
||||||
|
- Node.js 16+
|
||||||
|
- Maven 3.6+
|
||||||
|
- Docker（可选）
|
||||||
|
|
||||||
| 功能 | 本框架 | RuoYi |
|
### 本地开发
|
||||||
|-------------|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
|
|
||||||
| 前端项目 | 采用 Vue3 + TS + ElementPlus 重写 | 基于Vue2/Vue3 + JS |
|
|
||||||
| 后端项目结构 | 采用插件化 + 扩展包形式 结构解耦 易于扩展 | 模块相互注入耦合严重难以扩展 |
|
|
||||||
| 后端代码风格 | 严格遵守Alibaba规范与项目统一配置的代码格式化 | 代码书写与常规结构不同阅读障碍大 |
|
|
||||||
| Web容器 | 采用 Undertow 基于 XNIO 的高性能容器 | 采用 Tomcat |
|
|
||||||
| 权限认证 | 采用 Sa-Token、Jwt 静态使用功能齐全 低耦合 高扩展 | Spring Security 配置繁琐扩展性极差 |
|
|
||||||
| 权限注解 | 采用 Sa-Token 支持注解 登录校验、角色校验、权限校验、二级认证校验、HttpBasic校验、忽略校验<br/>角色与权限校验支持多种条件 如 `AND` `OR` 或 `权限 OR 角色` 等复杂表达式 | 只支持是否存在匹配 |
|
|
||||||
| 三方鉴权 | 采用 JustAuth 第三方登录组件 支持微信、钉钉等数十种三方认证 | 无 |
|
|
||||||
| 关系数据库支持 | 原生支持 MySQL、Oracle、PostgreSQL、SQLServer<br/>可同时使用异构切换(支持其他 mybatis-plus 支持的所有数据库 只需要增加jdbc依赖即可使用 达梦金仓等均有成功案例) | 支持 Mysql、Oracle 不支持同时使用、不支持异构切换 |
|
|
||||||
| 缓存数据库 | 支持 Redis 5-7 支持大部分新功能特性 如 分布式限流、分布式队列 | Redis 简单 get set 支持 |
|
|
||||||
| Redis客户端 | 采用 Redisson Redis官方推荐 基于Netty的客户端工具<br/>支持Redis 90%以上的命令 底层优化规避很多不正确的用法 例如: keys被转换为scan<br/>支持单机、哨兵、单主集群、多主集群等模式 | Lettuce + RedisTemplate 支持模式少 工具使用繁琐<br/>连接池采用 common-pool Bug多经常性出问题 |
|
|
||||||
| 缓存注解 | 采用 Spring-Cache 注解 对其扩展了实现支持了更多功能<br/>例如 过期时间 最大空闲时间 组最大长度等 只需一个注解即可完成数据自动缓存 | 需手动编写Redis代码逻辑 |
|
|
||||||
| ORM框架 | 采用 Mybatis-Plus 基于对象几乎不用写SQL全java操作 功能强大插件众多<br/>例如多租户插件 分页插件 乐观锁插件等等 | 采用 Mybatis 基于XML需要手写SQL |
|
|
||||||
| SQL监控 | 采用 p6spy 可输出完整SQL与执行时间监控 | log输出 需手动拼接sql与参数无法快速查看调试问题 |
|
|
||||||
| 数据分页 | 采用 Mybatis-Plus 分页插件<br/>框架对其进行了扩展 对象化分页对象 支持多种方式传参 支持前端多排序 复杂排序 | 采用 PageHelper 仅支持单查询分页 参数只能从param传 只能单排序 功能扩展性差 体验不好 |
|
|
||||||
| 数据权限 | 采用 Mybatis-Plus 插件 自行分析拼接SQL 无感式过滤<br/>只需为Mapper设置好注解条件 支持多种自定义 不限于部门角色 | 采用 注解+aop 实现 基于部门角色 生成的sql兼容性差 不支持其他业务扩展<br/>生成sql后需手动拼接到具体业务sql上 对于多个Mapper查询不起作用 |
|
|
||||||
| 数据脱敏 | 采用 注解 + jackson 序列化期间脱敏 支持不同模块不同的脱敏条件<br/>支持多种策略 如身份证、手机号、地址、邮箱、银行卡等 可自行扩展 | 无 |
|
|
||||||
| 数据加解密 | 采用 注解 + mybatis 拦截器 对存取数据期间自动加解密<br/>支持多种策略 如BASE64、AES、RSA、SM2、SM4等 | 无 |
|
|
||||||
| 接口传输加密 | 采用 动态 AES + RSA 加密请求 body 每一次请求秘钥都不同大幅度降低可破解性 | 无 |
|
|
||||||
| 数据翻译 | 采用 注解 + jackson 序列化期间动态修改数据 数据进行翻译<br/>支持多种模式: `映射翻译` `直接翻译` `其他扩展条件翻译` 接口化两步即可完成自定义扩展 内置多种翻译实现 | 无 |
|
|
||||||
| 多数据源框架 | 采用 dynamic-datasource 支持市面大部分数据库<br/>通过yml配置即可动态管理异构不同种类的数据库 也可通过前端页面添加数据源<br/>支持spel表达式从请求头参数等条件切换数据源 | 基于 druid 手动编写代码配置数据源 配置繁琐 支持性差 |
|
|
||||||
| 多数据源事务 | 采用 dynamic-datasource 支持多数据源不同种类的数据库事务回滚 | 不支持 |
|
|
||||||
| 数据库连接池 | 采用 HikariCP Spring官方内置连接池 配置简单 以性能与稳定性闻名天下 | 采用 druid bug众多 社区维护差 活跃度低 配置众多繁琐性能一般 |
|
|
||||||
| 数据库主键 | 采用 雪花ID 基于时间戳的 有序增长 唯一ID 再也不用为分库分表 数据合并主键冲突重复而发愁 | 采用 数据库自增ID 支持数据量有限 不支持多数据源主键唯一 |
|
|
||||||
| WebSocket协议 | 基于 Spring 封装的 WebSocket 协议 扩展了Token鉴权与分布式会话同步 不再只是基于单机的废物 | 无 |
|
|
||||||
| SSE推送 | 采用 Spring SSE 实现 扩展了Token鉴权与分布式会话同步 | 无 |
|
|
||||||
| 序列化 | 采用 Jackson Spring官方内置序列化 靠谱!!! | 采用 fastjson bugjson 远近闻名 |
|
|
||||||
| 分布式幂等 | 参考美团GTIS防重系统简化实现(细节可看文档) | 手动编写注解基于aop实现 |
|
|
||||||
| 分布式锁 | 采用 Lock4j 底层基于 Redisson | 无 |
|
|
||||||
| 分布式任务调度 | 采用 SnailJob 天生支持分布式 统一的管理中心 支持多种数据库 支持分片重试DAG任务流等 | 采用 Quartz 基于数据库锁性能差 集群需要做很多配置与改造 |
|
|
||||||
| 文件存储 | 采用 Minio 分布式文件存储 天生支持多机、多硬盘、多分片、多副本存储<br/>支持权限管理 安全可靠 文件可加密存储 | 采用 本机文件存储 文件裸漏 易丢失泄漏 不支持集群有单点效应 |
|
|
||||||
| 云存储 | 采用 AWS S3 协议客户端 支持 七牛、阿里、腾讯 等一切支持S3协议的厂家 | 不支持 |
|
|
||||||
| 短信 | 采用 sms4j 短信融合包 支持数十种短信厂家 只需在yml配置好厂家密钥即可使用 可多厂家共用 | 不支持 |
|
|
||||||
| 邮件 | 采用 mail-api 通用协议支持大部分邮件厂商 | 不支持 |
|
|
||||||
| 接口文档 | 采用 SpringDoc、javadoc 无注解零入侵基于java注释<br/>只需把注释写好 无需再写一大堆的文档注解了 | 采用 Springfox 已停止维护 需要编写大量的注解来支持文档生成 |
|
|
||||||
| 校验框架 | 采用 Validation 支持注解与工具类校验 注解支持国际化 | 仅支持注解 且注解不支持国际化 |
|
|
||||||
| Excel框架 | 采用 Alibaba EasyExcel 基于插件化<br/>框架对其增加了很多功能 例如 自动合并相同内容 自动排列布局 字典翻译等 | 基于 POI 手写实现 功能有限 复杂 扩展性差 |
|
|
||||||
| 工作流支持 | 支持各种复杂审批 转办 委派 加减签 会签 或签 票签 等功能 | 无 |
|
|
||||||
| 工具类框架 | 采用 Hutool、Lombok 上百种工具覆盖90%的使用需求 基于注解自动生成 get set 等简化框架大量代码 | 手写工具稳定性差易出问题 工具数量有限 代码臃肿需自己手写 get set 等 |
|
|
||||||
| 监控框架 | 采用 SpringBoot-Admin 基于SpringBoot官方 actuator 探针机制<br/>实时监控服务状态 框架还为其扩展了在线日志查看监控 | 无 |
|
|
||||||
| 链路追踪 | 采用 Apache SkyWalking 还在为请求不知道去哪了 到哪出了问题而烦恼吗<br/>用了它即可实时查看请求经过的每一处每一个节点 | 无 |
|
|
||||||
| 代码生成器 | 只需设计好表结构 一键生成所有crud代码与页面<br/>降低80%的开发量 把精力都投入到业务设计上<br/>框架为其适配MP、SpringDoc规范化代码 同时支持动态多数据源代码生成 | 代码生成原生结构 只支持单数据源生成 |
|
|
||||||
| 部署方式 | 支持 Docker 编排 一键搭建所有环境 让开发人员从此不再为搭建环境而烦恼 | 原生jar部署 其他环境需手动下载安装 自行搭建 |
|
|
||||||
| 项目路径修改 | 提供详细的修改方案文档 并为其做了一些改动 非常简单即可修改成自己想要的 | 需要做很多改造 文档说明有限 |
|
|
||||||
| 国际化 | 基于请求头动态返回不同语种的文本内容 开发难度低 有对应的工具类 支持大部分注解内容国际化 | 只提供基础功能 其他需自行编写扩展 |
|
|
||||||
| 代码单例测试 | 提供单例测试 使用方式编写方法与maven多环境单测插件 | 只提供基础功能 其他需自行编写扩展 |
|
|
||||||
| Demo案例 | 提供框架功能的实际使用案例 单独一个模块提供了很多很全 | 无 |
|
|
||||||
|
|
||||||
|
#### 1. 克隆项目
|
||||||
|
```bash
|
||||||
|
git clone https://gitee.com/xxx/ruoyi-vue-plus.git
|
||||||
|
cd ruoyi-vue-plus
|
||||||
|
```
|
||||||
|
|
||||||
## 本框架与RuoYi的业务差异
|
#### 2. 配置数据库
|
||||||
|
- 创建数据库 `ruoyi-vue-plus`
|
||||||
|
- 导入 `sql` 目录下的初始化脚本
|
||||||
|
|
||||||
| 业务 | 功能说明 | 本框架 | RuoYi |
|
#### 3. 配置Redis
|
||||||
|--------|----------------------------------------------------------------------|-----|------------------|
|
- 启动Redis服务
|
||||||
| 租户管理 | 系统内租户的管理 如:租户套餐、过期时间、用户数量、企业信息等 | 支持 | 无 |
|
- 修改 `application.yml` 中的Redis配置
|
||||||
| 租户套餐管理 | 系统内租户所能使用的套餐管理 如:套餐内所包含的菜单等 | 支持 | 无 |
|
|
||||||
| 客户端管理 | 系统内对接的所有客户端管理 如: pc端、小程序端等<br>支持动态授权登录方式 如: 短信登录、密码登录等 支持动态控制token时效 | 支持 | 无 |
|
|
||||||
| 用户管理 | 用户的管理配置 如:新增用户、分配用户所属部门、角色、岗位等 | 支持 | 支持 |
|
|
||||||
| 部门管理 | 配置系统组织机构（公司、部门、小组） 树结构展现支持数据权限 | 支持 | 支持 |
|
|
||||||
| 岗位管理 | 配置系统用户所属担任职务 | 支持 | 支持 |
|
|
||||||
| 菜单管理 | 配置系统菜单、操作权限、按钮权限标识等 | 支持 | 支持 |
|
|
||||||
| 角色管理 | 角色菜单权限分配、设置角色按机构进行数据范围权限划分 | 支持 | 支持 |
|
|
||||||
| 字典管理 | 对系统中经常使用的一些较为固定的数据进行维护 | 支持 | 支持 |
|
|
||||||
| 参数管理 | 对系统动态配置常用参数 | 支持 | 支持 |
|
|
||||||
| 通知公告 | 系统通知公告信息发布维护 | 支持 | 支持 |
|
|
||||||
| 操作日志 | 系统正常操作日志记录和查询 系统异常信息日志记录和查询 | 支持 | 支持 |
|
|
||||||
| 登录日志 | 系统登录日志记录查询包含登录异常 | 支持 | 支持 |
|
|
||||||
| 文件管理 | 系统文件展示、上传、下载、删除等管理 | 支持 | 无 |
|
|
||||||
| 文件配置管理 | 系统文件上传、下载所需要的配置信息动态添加、修改、删除等管理 | 支持 | 无 |
|
|
||||||
| 在线用户管理 | 已登录系统的在线用户信息监控与强制踢出操作 | 支持 | 支持 |
|
|
||||||
| 定时任务 | 运行报表、任务管理(添加、修改、删除)、日志管理、执行器管理等 | 支持 | 仅支持任务与日志管理 |
|
|
||||||
| 代码生成 | 多数据源前后端代码的生成（java、html、xml、sql）支持CRUD下载 | 支持 | 仅支持单数据源 |
|
|
||||||
| 系统接口 | 根据业务代码自动生成相关的api接口文档 | 支持 | 支持 |
|
|
||||||
| 服务监控 | 监视集群系统CPU、内存、磁盘、堆栈、在线日志、Spring相关配置等 | 支持 | 仅支持单机CPU、内存、磁盘监控 |
|
|
||||||
| 缓存监控 | 对系统的缓存信息查询，命令统计等。 | 支持 | 支持 |
|
|
||||||
| 在线构建器 | 拖动表单元素生成相应的HTML代码。 | 支持 | 支持 |
|
|
||||||
| 使用案例 | 系统的一些功能案例 | 支持 | 不支持 |
|
|
||||||
|
|
||||||
## 参考文档
|
#### 4. 编译打包
|
||||||
|
```bash
|
||||||
|
# 编译后端
|
||||||
|
mvn clean install -DskipTests
|
||||||
|
|
||||||
使用框架前请仔细阅读文档重点注意事项
|
# 编译前端
|
||||||
<br>
|
cd ruoyi-ui
|
||||||
>[初始化项目 必看](https://plus-doc.dromara.org/#/ruoyi-vue-plus/quickstart/init)
|
npm install
|
||||||
>>[https://plus-doc.dromara.org/#/ruoyi-vue-plus/quickstart/init](https://plus-doc.dromara.org/#/ruoyi-vue-plus/quickstart/init)
|
npm run build
|
||||||
>
|
```
|
||||||
>[专栏与视频 入门必看](https://plus-doc.dromara.org/#/common/column)
|
|
||||||
>>[https://plus-doc.dromara.org/#/common/column](https://plus-doc.dromara.org/#/common/column)
|
|
||||||
>
|
|
||||||
>[部署项目 必看](https://plus-doc.dromara.org/#/ruoyi-vue-plus/quickstart/deploy)
|
|
||||||
>>[https://plus-doc.dromara.org/#/ruoyi-vue-plus/quickstart/deploy](https://plus-doc.dromara.org/#/ruoyi-vue-plus/quickstart/deploy)
|
|
||||||
>
|
|
||||||
>[如何加群](https://plus-doc.dromara.org/#/common/add_group)
|
|
||||||
>>[https://plus-doc.dromara.org/#/common/add_group](https://plus-doc.dromara.org/#/common/add_group)
|
|
||||||
>
|
|
||||||
>[参考文档 Wiki](https://plus-doc.dromara.org)
|
|
||||||
>>[https://plus-doc.dromara.org](https://plus-doc.dromara.org)
|
|
||||||
|
|
||||||
## 软件架构图
|
#### 5. 启动服务
|
||||||
|
```bash
|
||||||
|
# 启动后端服务
|
||||||
|
java -jar ruoyi-admin/target/ruoyi-admin.jar
|
||||||
|
|
||||||
|
# 启动前端服务（开发模式）
|
||||||
|
cd ruoyi-ui
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
## 如何参与贡献
|
### Docker部署
|
||||||
|
|
||||||
[参与贡献的方式 https://plus-doc.dromara.org/#/common/contribution](https://plus-doc.dromara.org/#/common/contribution)
|
#### 1. 构建镜像
|
||||||
|
```bash
|
||||||
|
docker-compose build
|
||||||
|
```
|
||||||
|
|
||||||
## 捐献作者
|
#### 2. 启动服务
|
||||||
作者为兼职做开源,平时还需要工作,如果帮到了您可以请作者吃个盒饭
|
```bash
|
||||||
<img src="https://foruda.gitee.com/images/1678975784848381069/d8661ed9_1766278.png" width="300px" height="450px" />
|
docker-compose up -d
|
||||||
<img src="https://foruda.gitee.com/images/1678975801230205215/6f96229d_1766278.png" width="300px" height="450px" />
|
```
|
||||||
|
|
||||||
## 演示图例
|
## 目录结构
|
||||||
|
|
||||||
| | |
|
```
|
||||||
|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
|
ruoyi-vue-plus/
|
||||||
|  |  |
|
├── ruoyi-common/ # 通用模块
|
||||||
|  |  |
|
│ ├── ruoyi-common-bom/ # 依赖管理
|
||||||
|  |  |
|
│ ├── ruoyi-common-core/ # 核心工具类
|
||||||
|  |  |
|
│ ├── ruoyi-common-core-api/ # 核心API
|
||||||
|  |  |
|
│ ├── ruoyi-common-security/ # 安全框架
|
||||||
|  |  |
|
│ ├── ruoyi-common-redis/ # Redis工具
|
||||||
|  |  |
|
│ ├── ruoyi-common-mybatis/ # MyBatis增强
|
||||||
|  |  |
|
│ └── ...
|
||||||
|  |  |
|
├── ruoyi-modules/ # 业务模块
|
||||||
|  |  |
|
│ ├── ruoyi-admin/ # 管理后台
|
||||||
|  |  |
|
│ ├── ruoyi-system/ # 系统管理
|
||||||
|  |  |
|
│ ├── ruoyi-generator/ # 代码生成器
|
||||||
|  |  |
|
│ ├── ruoyi-job/ # 任务调度
|
||||||
|  |  |
|
│ ├── ruoyi-md-system/ # 多租户系统管理
|
||||||
|  |  |
|
│ ├── ruoyi-md-form/ # 表单管理
|
||||||
|  |  |
|
│ ├── ruoyi-md-h5/ # H5应用
|
||||||
|  |  |
|
│ └── ...
|
||||||
|  |  |
|
├── ruoyi-site/ # 站点模块
|
||||||
|  |  |
|
│ ├── ruoyi-admin/ # 管理后台站点
|
||||||
|
│ ├── ruoyi-gateway/ # 网关服务
|
||||||
|
│ ├── ruoyi-sso-server/ # 单点登录服务
|
||||||
|
│ └── ...
|
||||||
|
├── ruoyi-extend/ # 扩展模块
|
||||||
|
│ ├── ruoyi-snailjob-server/ # 任务调度服务
|
||||||
|
│ ├── ruoyi-monitor-admin/ # 监控服务
|
||||||
|
│ └── ...
|
||||||
|
├── ruoyi-ui/ # 前端代码
|
||||||
|
├── docker-compose.yml # Docker-compose配置
|
||||||
|
├── pom.xml # Maven配置
|
||||||
|
└── README.md # 项目说明
|
||||||
|
```
|
||||||
|
|
||||||
|
## 核心模块说明
|
||||||
|
|
||||||
|
### 1. 系统管理（ruoyi-system）
|
||||||
|
- 用户管理：用户信息、角色分配、状态管理
|
||||||
|
- 角色管理：角色权限配置、菜单分配
|
||||||
|
- 部门管理：组织架构维护
|
||||||
|
- 菜单管理：动态菜单配置、权限控制
|
||||||
|
- 字典管理：系统参数配置、数据字典
|
||||||
|
|
||||||
|
### 2. 工作流（ruoyi-workflow）
|
||||||
|
- 流程定义：流程模板设计、部署
|
||||||
|
- 流程实例：流程运行状态管理
|
||||||
|
- 任务管理：待办任务、已办任务
|
||||||
|
- 流程监控：流程执行情况监控
|
||||||
|
|
||||||
|
### 3. 表单管理（ruoyi-md-form）
|
||||||
|
- 表单设计：可视化表单设计器
|
||||||
|
- 表单配置：表单字段、验证规则配置
|
||||||
|
- 表单实例：表单数据管理
|
||||||
|
|
||||||
|
### 4. 多租户（ruoyi-md-system-saas）
|
||||||
|
- 租户管理：租户信息、状态管理
|
||||||
|
- 租户套餐：租户权限套餐配置
|
||||||
|
- 租户菜单：租户菜单权限配置
|
||||||
|
|
||||||
|
## 配置说明
|
||||||
|
|
||||||
|
### 数据源配置
|
||||||
|
```yaml
|
||||||
|
spring:
|
||||||
|
datasource:
|
||||||
|
url: jdbc:mysql://localhost:3306/ruoyi-vue-plus?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
|
||||||
|
username: root
|
||||||
|
password: 123456
|
||||||
|
```
|
||||||
|
|
||||||
|
### Redis配置
|
||||||
|
```yaml
|
||||||
|
spring:
|
||||||
|
redis:
|
||||||
|
host: localhost
|
||||||
|
port: 6379
|
||||||
|
password:
|
||||||
|
database: 0
|
||||||
|
```
|
||||||
|
|
||||||
|
### 微服务配置
|
||||||
|
```yaml
|
||||||
|
spring:
|
||||||
|
cloud:
|
||||||
|
nacos:
|
||||||
|
discovery:
|
||||||
|
server-addr: localhost:8848
|
||||||
|
config:
|
||||||
|
server-addr: localhost:8848
|
||||||
|
file-extension: yml
|
||||||
|
```
|
||||||
|
|
||||||
|
## 开发规范
|
||||||
|
|
||||||
|
### 代码规范
|
||||||
|
- 遵循阿里巴巴Java开发手册
|
||||||
|
- 代码可读性 > 质量 > 性能 > 安全性
|
||||||
|
- 统一的命名规范：类名、方法名、变量名
|
||||||
|
- 详细的代码注释
|
||||||
|
|
||||||
|
### 提交规范
|
||||||
|
- 提交信息格式：`[模块名] 功能描述`
|
||||||
|
- 提交前进行代码检查
|
||||||
|
- 定期进行代码Review
|
||||||
|
|
||||||
|
## 安全注意事项
|
||||||
|
- 密码加密存储
|
||||||
|
- 接口权限验证
|
||||||
|
- SQL注入防护
|
||||||
|
- XSS攻击防护
|
||||||
|
- CSRF攻击防护
|
||||||
|
- 敏感信息脱敏
|
||||||
|
|
||||||
|
## 常见问题
|
||||||
|
|
||||||
|
### 1. 启动失败
|
||||||
|
- 检查数据库连接
|
||||||
|
- 检查Redis服务
|
||||||
|
- 检查端口是否被占用
|
||||||
|
|
||||||
|
### 2. 权限问题
|
||||||
|
- 检查用户角色权限配置
|
||||||
|
- 检查菜单权限设置
|
||||||
|
|
||||||
|
### 3. 性能问题
|
||||||
|
- 检查SQL语句优化
|
||||||
|
- 检查Redis缓存使用
|
||||||
|
- 检查线程池配置
|
||||||
|
|
||||||
|
## 许可证
|
||||||
|
|
||||||
|
本项目基于 Apache License 2.0 许可证开源。
|
||||||
|
|
||||||
|
## 联系方式
|
||||||
|
|
||||||
|
- Gitee: https://gitee.com/xxx/ruoyi-vue-plus
|
||||||
|
- 邮箱: xxx@example.com
|
||||||
|
|
||||||
|
## 更新日志
|
||||||
|
|
||||||
|
### v5.2.2 (2026-04-13)
|
||||||
|
- 完善多租户功能
|
||||||
|
- 优化工作流模块
|
||||||
|
- 新增表单设计器
|
||||||
|
- 修复已知bug
|
||||||
|
|
||||||
|
### v5.2.1 (2026-03-01)
|
||||||
|
- 集成SnailJob任务调度
|
||||||
|
- 新增社交登录功能
|
||||||
|
- 优化系统性能
|
||||||
|
|
||||||
|
### v5.2.0 (2026-01-01)
|
||||||
|
- 基于Spring Boot 3.0重构
|
||||||
|
- 升级Spring Cloud版本
|
||||||
|
- 优化微服务架构
|
||||||
@ -1,31 +0,0 @@
|
|||||||
# 后端
|
|
||||||
|
|
||||||
| 模块 | 主要功能 | 详细描述 | git地址 | | | |
|
|
||||||
|------------------|------------|------|-------|---|---|---|
|
|
||||||
| gateway | 全局网关 | | | | | |
|
|
||||||
| ruoyi-sso-server | sso单点登录服务 | | | | | |
|
|
||||||
| ruoyi-h5 | 在线h5微服务 | | | | | |
|
|
||||||
| ruoyi-tams | 教培微服务 | | | | | |
|
|
||||||
| ruoyi-s3 | s3 对象存储微服务 | | | | | |
|
|
||||||
| ruoyi-h5 | 在线h5后台 | | | | | |
|
|
||||||
|
|
||||||
# 前端
|
|
||||||
|
|
||||||
| 模块 | 主要功能 | 详细描述 | git地址 | | | |
|
|
||||||
|---------------|----------|------|-------|---|---|---|
|
|
||||||
| tmagic-editor | 在线h5编辑 | | | | | |
|
|
||||||
| ruoyi-h5-web | 在线h5管理界面 | | | | | |
|
|
||||||
|
|
||||||
## tmagic-editor
|
|
||||||
|
|
||||||
### 未来规划
|
|
||||||
- 参考 https://www.gaoding.com/editor/odyssey?mode=user&template_id=31593731846159481
|
|
||||||
|
|
||||||
- 支持mock 接口
|
|
||||||
- 模板模块：支持查询模板、滚动懒加载模板、分类查询模板、模板预览、模板替换当前页面
|
|
||||||
- 支持文字、组件
|
|
||||||
- 背景替换
|
|
||||||
- 支持长页面和翻页页面
|
|
||||||
- 全部支持分组和打标签（）
|
|
||||||
- 方便后面界面优化，是埋点还是怎么弄？
|
|
||||||
- 支持全局搜索
|
|
||||||
Loading…
Reference in New Issue
Block a user