若依（RuoYi）框架新手使用指南

若依（RuoYi）是一款基于 Spring Boot + Vue 的前后端分离企业级开发框架，集成了权限管理、代码生成、监控日志等核心功能，适用于快速构建中后台管理系统。以下是详细的使用指南，涵盖 环境搭建→核心功能→扩展开发 的全流程。

一、环境准备与项目初始化

基础环境
- 后端：JDK 17+（推荐OpenJDK）、MySQL 8.0+、Redis 5.0+、Maven 3.6+
- 前端：Node.js 20+、npm 9+（建议使用淘宝镜像加速依赖安装）

项目下载

# 后端项目（Spring Boot）
git clone https://gitee.com/y_project/RuoYi-Vue.git
# 前端项目（Vue3）
git clone https://gitee.com/ys-gitee/RuoYi-Vue3.git

数据库配置
- 创建数据库 ry-vue，执行项目 sql/ 目录下的 quartz.sql 和 ry_xxxx.sql 脚本。
- 修改后端配置文件 ruoyi-admin/src/main/resources/application-druid.yml，填写本地MySQL账号密码
Redis配置
- 启动Redis服务（默认端口6379），若端口冲突可通过 netstat -ano | findstr :6379 检查占用进程。
- 修改 application.yml 中的Redis连接信息（默认无密码

二、项目启动与登录验证

后端启动
- 在IDE（如IntelliJ IDEA）中运行 RuoYiApplication.java，控制台显示 若依启动成功 即表示后端启动完成

前端启动

cd ruoyi-ui  # 进入前端目录
npm install --registry=https://registry.npm.taobao.org  # 安装依赖
npm run dev  # 启动开发服务器，默认访问地址 http://localhost:80

登录验证：使用默认账号 admin/admin123 登录系统。

三、核心功能使用详解

权限管理（RBAC模型）
- 角色分配：在 系统管理 → 角色管理 中创建角色，绑定菜单、按钮权限。
- 数据隔离：通过 @DataScope 注解实现部门级数据权限控制，例如仅允许用户查看本部门数据
代码生成器
- 步骤：
  1. 在MySQL中创建业务表（需包含注释字段）。
  2. 系统工具 → 代码生成 → 导入表，选择表并设置模块名、包路径。
  3. 生成ZIP包，解压后复制到 ruoyi-admin 和 ruoyi-ui 对应目录，重启项目即可自动注册菜单
- 模板定制：修改 ruoyi-generator 模块中的 .vm 文件，自定义代码生成逻辑
监控与日志
- 服务监控：查看系统CPU、内存、JVM状态。
- 操作日志：记录用户操作记录，支持按时间、IP、账号筛选

四、进阶开发与扩展

模块化扩展
- 添加新模块：在 ruoyi-admin 下新建子模块（如 ruoyi-order），并在 pom.xml 中配置依赖，实现业务隔离
- 多数据源：修改 application.yml 配置多个数据源，通过 @DS("slave") 注解切换数据源
前端定制
- 主题修改：在 src/assets/styles 中调整CSS变量（如主题色、字体）。
- 路由配置：在 src/router/index.js 中添加新路由，关联Vue组件

API开发示例

// 示例：用户查询接口（带分页）
@RestController
@RequestMapping("/system/user")
public class SysUserController {@Autowiredprivate ISysUserService userService;@RequiresPermissions("system:user:list")  // 权限控制@GetMapping("/list")public TableDataInfo list(SysUser user) {startPage();  // 分页处理List<SysUser> list = userService.selectUserList(user);return getDataTable(list);  // 返回标准化分页数据}
}

五、部署与运维

后端打包

mvn clean package -DskipTests  # 生成 ruoyi-admin.jar
nohup java -jar ruoyi-admin.jar &  # Linux后台运行

前端构建

npm run build:prod  # 生成静态文件到 dist 目录
# 部署到Nginx或Tomcat

六、常见问题与优化

启动报错
- Redis连接失败：检查Redis服务是否启动，配置文件密码是否匹配
- 端口冲突：修改 application.yml 中的 server.port 或前端 vue.config.js 中的代理端口
性能优化
- 缓存加速：高频查询接口添加 @Cacheable 注解，利用Redis缓存数据。
- SQL优化：通过 ruoyi-admin 的Druid监控分析慢查询