【限时免费】 RuoYi-Cloud-Vue3 微服务架构技术文档

一、平台简介

RuoYi-Cloud-Vue3 是基于 Vue3 + Element Plus + Vite 技术栈的前端框架，配套后端采用 Spring Boot/Spring Cloud & Alibaba 的分布式微服务架构权限管理系统。该系统提供完整的权限架构和丰富的功能模块，适合快速构建企业级Web应用程序。

二、安装指南

1. 环境准备

• Node.js 14.x 或更高版本
• Yarn 1.x 或更高版本
• JDK 1.8 或更高版本（后端运行需要）
• MySQL 5.7 或更高版本（后端数据库）
• Redis 5.x 或更高版本（缓存服务）

2. 前端安装

# 克隆项目
git clone https://github.com/yangzongzhuan/RuoYi-Cloud-Vue3.git

# 进入项目目录
cd RuoYi-Cloud-Vue3

# 安装依赖（使用国内镜像源）
yarn --registry=https://registry.npmmirror.com

# 启动开发服务器
yarn dev

启动成功后，前端默认访问地址为：http://localhost:80

三、项目使用说明

1. 系统模块结构

com.ruoyi     
├── ruoyi-ui              // 前端框架 [80]
├── ruoyi-gateway         // 网关模块 [8080]
├── ruoyi-auth            // 认证中心 [9200]
├── ruoyi-api             // 接口模块
├── ruoyi-common          // 通用模块
├── ruoyi-modules         // 业务模块
├── ruoyi-visual          // 图形化管理模块

2. 主要功能模块

1. 用户管理：系统用户配置
2. 部门管理：组织机构树形管理
3. 菜单管理：系统菜单和权限配置
4. 角色管理：权限分配和数据范围设置
5. 字典管理：系统固定数据维护
6. 参数管理：系统动态参数配置
7. 代码生成：前后端代码一键生成
8. 系统监控：服务状态和性能监控
9. 定时任务：任务调度管理

3. 登录说明

默认管理员账号：

• 用户名：admin
• 密码：admin123

四、API使用文档

1. API基础信息

• 基础路径：/api
• 认证方式：Bearer Token
• 响应格式：JSON

2. 常用API示例

用户登录

POST /auth/login
Content-Type: application/json

{
  "username": "admin",
  "password": "admin123"
}

响应示例：

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

获取用户信息

GET /system/user/getInfo
Authorization: Bearer {token}

响应示例：

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "user": {
      "userId": 1,
      "userName": "admin",
      "nickName": "管理员"
    },
    "roles": ["admin"],
    "permissions": ["*:*:*"]
  }
}

五、项目安装方式

1. 后端安装

1. 克隆后端仓库：

   git clone https://gitee.com/y_project/RuoYi-Cloud.git
   

   或Oracle版本：

   git clone https://github.com/yangzongzhuan/RuoYi-Cloud-Oracle.git
   

2. 导入IDE（推荐IntelliJ IDEA）

3. 创建数据库并导入SQL脚本

4. 配置Redis连接信息

5. 启动各微服务模块

2. 生产环境构建

前端生产环境构建命令：

# 测试环境构建
yarn build:stage

# 生产环境构建
yarn build:prod

构建完成后，将dist目录下的文件部署到Web服务器（如Nginx）

3. Docker部署（可选）

项目支持Docker容器化部署，具体配置参考项目中的Dockerfile和docker-compose.yml文件

六、注意事项

1. 开发环境与生产环境配置需分开管理
2. 首次使用前需初始化数据库
3. 多模块间依赖关系需按顺序启动
4. 微服务架构需要确保各服务注册到Nacos等注册中心

本系统提供了完整的权限管理解决方案和丰富的功能模块，开发者可根据实际需求进行二次开发或模块扩展。