RuoYi-Cloud-Plus 微服务通用权限管理系统技术文档

1. 安装指南

1.1 环境要求

• JDK 17或21
• Maven 3.6+
• Redis 5-7
• MySQL/Oracle/PostgreSQL/SQLServer
• Nacos 2.0+
• Node.js 14+(前端开发需要)

1.2 后端安装

1. 克隆项目代码：

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

2. 导入IDEA，等待Maven依赖下载完成
3. 创建数据库并执行初始化SQL脚本
4. 配置Nacos服务发现与配置中心
5. 修改各模块配置文件中的数据库和Redis连接信息
6. 启动顺序：Nacos → 认证中心 → 网关 → 其他服务模块

2. 项目使用说明

2.1 系统功能

• 用户管理：用户CRUD、角色分配
• 角色管理：角色CRUD、权限分配
• 菜单管理：菜单CRUD、权限配置
• 部门管理：部门树形结构管理
• 岗位管理：岗位CRUD
• 操作日志：记录用户操作行为
• 登录日志：记录用户登录信息
• 系统监控：服务状态监控

2.2 启动流程

1. 确保Nacos服务已启动
2. 启动认证中心服务(ruoyi-auth)
3. 启动网关服务(ruoyi-gateway)
4. 启动系统模块服务(ruoyi-system)
5. 访问前端页面进行系统操作

3. 项目API使用文档

3.1 认证接口

• 登录接口：POST /auth/login
• 登出接口：POST /auth/logout
• 获取用户信息：GET /auth/getUserInfo

3.2 用户管理接口

• 获取用户列表：GET /system/user/list
• 新增用户：POST /system/user
• 修改用户：PUT /system/user
• 删除用户：DELETE /system/user/{userId}

3.3 权限校验注解

// 登录校验
@SaCheckLogin
// 角色校验(AND关系)
@SaCheckRole("admin")
// 权限校验(OR关系)
@SaCheckPermission(value = {"user:add", "user:edit"}, mode = SaMode.OR)
// 二级认证
@SaCheckSafe
// 忽略校验
@SaIgnore

4. 项目安装方式

4.1 源码安装

1. 下载项目源码
2. 导入IDE开发工具
3. 配置Maven依赖
4. 修改配置文件
5. 编译打包部署

4.2 Docker部署

1. 构建Docker镜像：

   mvn clean package docker:build
   

2. 启动容器：

   docker-compose up -d
   

4.3 注意事项

1. 确保各服务端口未被占用
2. Redis和数据库连接配置正确
3. Nacos配置中心已正确配置各服务参数
4. 首次启动需执行数据库初始化脚本
5. 生产环境建议配置HTTPS和安全策略