RuoYi-Vue-Plus/README.md
2026-04-13 20:37:15 +08:00

6.3 KiB
Raw Blame History

RuoYi-Vue-Plus

项目介绍

RuoYi-Vue-Plus是一个基于Spring Boot、Spring Cloud和Vue的企业级后台管理系统提供了完整的微服务架构解决方案。本项目在RuoYi-Vue的基础上进行了功能扩展和性能优化旨在为企业级应用提供更加稳定、高效、安全的开发框架。

技术栈

后端技术

  • Spring Boot 3.x
  • Spring Cloud
  • MyBatis-Plus
  • MySQL 8
  • Redis
  • Docker
  • Sa-Token认证授权
  • SnailJob任务调度

前端技术

  • Vue 3
  • Element Plus
  • Vite

功能特性

核心功能

  • 用户管理:用户注册、登录、权限管理
  • 角色管理:角色权限分配
  • 部门管理:组织架构管理
  • 菜单管理:动态菜单配置
  • 字典管理:系统参数配置
  • 日志管理:操作日志、登录日志
  • 系统监控:服务器监控、数据库监控

扩展功能

  • 工作流管理:流程定义、流程实例、任务管理
  • 表单管理:动态表单设计与配置
  • 多租户支持SaaS模式部署
  • 短信服务:集成短信发送功能
  • 邮件服务:集成邮件发送功能
  • OSS服务对象存储集成
  • 社交登录:支持第三方登录
  • 小程序登录:支持微信小程序登录
  • API文档自动生成API文档

快速开始

环境要求

  • JDK 17+
  • MySQL 8+
  • Redis 7+
  • Node.js 16+
  • Maven 3.6+
  • Docker可选

本地开发

1. 克隆项目

git clone https://gitee.com/xxx/ruoyi-vue-plus.git
cd ruoyi-vue-plus

2. 配置数据库

  • 创建数据库 ruoyi-vue-plus
  • 导入 sql 目录下的初始化脚本

3. 配置Redis

  • 启动Redis服务
  • 修改 application.yml 中的Redis配置

4. 编译打包

# 编译后端
mvn clean install -DskipTests

# 编译前端
cd ruoyi-ui
npm install
npm run build

5. 启动服务

# 启动后端服务
java -jar ruoyi-admin/target/ruoyi-admin.jar

# 启动前端服务(开发模式)
cd ruoyi-ui
npm run dev

Docker部署

1. 构建镜像

docker-compose build

2. 启动服务

docker-compose up -d

目录结构

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

  • 租户管理:租户信息、状态管理
  • 租户套餐:租户权限套餐配置
  • 租户菜单:租户菜单权限配置

配置说明

数据源配置

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配置

spring:
  redis:
    host: localhost
    port: 6379
    password: 
    database: 0

微服务配置

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 许可证开源。

联系方式

更新日志

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版本
  • 优化微服务架构