RuoYi-Vue-Plus 技术文档

RuoYi-Vue-Plus 技术文档

【免费下载链接】RuoYi-Vue-Plus 多租户后台管理系统 重写RuoYi-Vue所有功能 集成 Sa-Token、Mybatis-Plus、Warm-Flow工作流、SpringDoc、Hutool、OSS 定期同步 项目地址: https://gitcode.com/dromara/RuoYi-Vue-Plus

1. 安装指南

环境要求

• JDK 17 或 21
• Redis 5-7
• MySQL/Oracle/PostgreSQL/SQLServer 等关系型数据库
• Maven 3.6+
• Node.js 14+ (前端开发需要)

后端安装步骤

1. 克隆项目仓库

   git clone https://gitee.com/dromara/RuoYi-Vue-Plus.git
   

2. 导入项目到IDE（推荐IntelliJ IDEA）

3. 配置数据库

   • 创建数据库并执行初始化SQL脚本
   • 修改application.yml中的数据库连接配置

4. 配置Redis

   • 修改application.yml中的Redis连接信息

5. 启动项目

   • 运行RuoYiApplication主类

2. 项目使用说明

系统功能

• 用户管理：用户CRUD、角色分配
• 角色管理：角色CRUD、权限分配
• 菜单管理：动态菜单配置
• 部门管理：组织架构管理
• 岗位管理：职位信息管理
• 字典管理：系统字典配置
• 参数管理：系统参数配置
• 通知公告：系统公告发布
• 操作日志：用户操作记录
• 登录日志：用户登录记录
• 在线用户：当前在线用户管理
• 定时任务：分布式任务调度
• 代码生成：自动生成前后端代码
• 系统接口：基于SpringDoc的API文档

特色功能

• 多租户支持
• 数据权限控制
• 数据脱敏处理
• 接口传输加密
• 分布式锁
• 分布式幂等控制
• 多数据源管理

3. 项目API使用文档

通用API规范

• 请求方式：RESTful风格
• 响应格式：

  {
    "code": 200,
    "msg": "操作成功",
    "data": {}
  }
  

认证接口

@PostMapping("/login")
public R<LoginUser> login(@RequestBody LoginBody loginBody) {
    // 登录逻辑
}

@PostMapping("/logout")
public R<Void> logout() {
    // 登出逻辑
}

数据权限示例

@DataScope(deptAlias = "d", userAlias = "u")
public List<SysUser> selectUserList(SysUser user) {
    return userMapper.selectUserList(user);
}

缓存注解示例

@Cacheable(key = "'user:' + #userId", expire = 60, idle = 30)
public User getUserById(Long userId) {
    return userMapper.selectById(userId);
}

4. 项目安装方式

开发环境安装

1. 后端开发环境

   • 安装JDK 17+
   • 配置Maven仓库
   • 导入项目到IDE

2. 前端开发环境

   • 安装Node.js
   • 安装yarn或npm
   • 运行yarn install安装依赖
   • 运行yarn dev启动开发服务器

生产环境部署

1. 后端部署

   • 打包：mvn clean package -DskipTests
   • 运行：java -jar ruoyi-admin.jar

2. 前端部署

   • 构建：yarn build
   • 部署生成的dist目录到Nginx或Web服务器

Docker部署

# 构建镜像
docker build -t ruoyi-vue-plus .

# 运行容器
docker run -d -p 8080:8080 --name ruoyi ruoyi-vue-plus

注意事项

1. 首次启动会自动初始化数据库表结构和基础数据
2. 默认管理员账号：admin/admin123
3. 生产环境请修改默认密码和密钥配置
4. 多租户模式下需要额外配置租户数据源

【免费下载链接】RuoYi-Vue-Plus 多租户后台管理系统 重写RuoYi-Vue所有功能 集成 Sa-Token、Mybatis-Plus、Warm-Flow工作流、SpringDoc、Hutool、OSS 定期同步 项目地址: https://gitcode.com/dromara/RuoYi-Vue-Plus