UPD：为完成毕设需要故系统学习一下若依，方便项目的二次开发，已对原博客内容进行改动！（毕竟人家是专业的）

在此感谢黑马程序员提供的视频教程！

若依介绍

  • 若依官方有很多个版本，那本文用到的是前后端分离版本（RuoYi-Vue）
版本 gitee地址 说明
前后端不分离版本 https://gitee.com/y_project/RuoYi RuoYi结合了SpringBoot和Bootstrap的前端开发框架，适合快速构建传统的Web应用程序，其中前端和后端代码在同一项目中协同工作。star数量最多，但是前端界面比较丑
前后端分离版本 https://gitee.com/y_project/RuoYi-Vue RuoYi-Vue利用SpringBoot作为后端开发框架，与Vue.js结合，实现了前后端分离的开发模式。这种架构有助于提高开发效率，前后端可以独立开发和部署，更适合现代化的Web应用开发。
微服务版本 https://gitee.com/y_project/RuoYi-Cloud RuoYi-Cloud基于Spring Cloud & Alibaba微服务架构，为构建大型分布式系统提供了完整的解决方案。它支持服务发现、配置管理、负载均衡等微服务特性，适合需要高可扩展性和高可用性的企业级应用。
移动端版本 https://gitee.com/y_project/RuoYi-App RuoYi-App采用Uniapp进行开发，结合了Vue.js的优势，可以实现跨平台的移动端应用开发。一次编写，多端运行的能力使得它成为开发iOS和Android应用的理想选择。
  • 非官方扩展
版本 项目地址 说明
RuoYi-Vue3 https://github.com/yangzongzhuan/RuoYi-Vue3 (RuoYi)官方仓库 基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统
RuoYi-Vue-Plus https://gitee.com/dromara/RuoYi-Vue-Plus 多租户后台管理系统 重写RuoYi-Vue所有功能 集成 Sa-Token、Mybatis-Plus、Flowable、SpringDoc、Hutool、OSS 定期同步

RuoYi-Vue

以下内容来自RuoYi官方文档，（可直接看环境部署部分内容）

官方推荐 课程版本
JDK >= 1.8 JDK 11
Mysql >= 5.7.0 MySQL 8
Redis >= 3.0 Redis 5（Win）
Maven >= 3.0 Maven 3.6
Node >= 12 Node 16（Vue3）

运行后端项目

初始化项目

我使用的是Windows系统+IDEA+VS Code（其他系统请自行前往官方文档查阅）

阅读本文需要一些Java开发基础，包括但不限于Spring Boot、Spring 、MyBatis、Vue等，我有些部分不会写的很详细，但都能包括到。

Git下载

克隆若依源码，仓库地址：https://gitee.com/y_project/RuoYi-Vue.git

Maven构建

使用idea打开项目后，等待环境检查（主要是Maven下载项目依赖）

image-20241130182638549

MySQL相关

导入sql

1、创建数据库create schema ry-vue;

2、执行sql文件夹下的两个sql脚本文件 quartz.sql ry_20240629.sql，完成导入

3、导入后ry-vue库内置30张表

配置信息

在ruoyi-admin模块下，编辑resources目录下的application-druid.yml，修改数据库连接

1
2
3
4
5
6
7
8
9
10
11
# 数据源配置
spring:
    datasource:
        type: com.alibaba.druid.pool.DruidDataSource
        driverClassName: com.mysql.cj.jdbc.Driver
        druid:
            # 主库数据源
            master:
                url: 数据库地址
                username: 数据库账号
                password: 数据库密码

Redis相关

启动

在redis解压目录下，执行redis-server.exe redis.windows.conf启动

配置信息

在ruoyi-admin模块下，resources目录下的application.yml，可以设置redis密码等相关信息

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# redis 配置
redis:
# 地址
host: localhost
# 端口，默认为6379
port: 6379
# 数据库索引
database: 0
# 密码
password:
# 连接超时时间
timeout: 10s
lettuce:
  pool:
    # 连接池中的最小空闲连接
    min-idle: 0
    # 连接池中的最大空闲连接
    max-idle: 8
    # 连接池的最大数据库连接数
    max-active: 8
    # #连接池最大阻塞等待时间（使用负值表示没有限制）
    max-wait: -1ms

项目运行

在ruoyi-admin模块下，运行com.ruoyi.RuoYiApplication.java，出现如下控制台样式表示启动成功

1
2
3
4
5
6
7
8
9
10
(♥◠‿◠)ﾉﾞ  若依启动成功   ლ(´ڡ`ლ)ﾞ  
 .-------.       ____     __        
 |  _ _   \      \   \   /  /    
 | ( ' )  |       \  _. /  '       
 |(_ o _) /        _( )_ .'         
 | (_,_).' __  ___(_ o _)'          
 |  |\ \  |  ||   |(_,_)'         
 |  | \ `'   /|   `-'  /           
 |  |  \    /  \      /           
 ''-'   `'-'    `-..-'

后端运行成功可以通过([http://localhost:8080 )访问，但是不会出现静态页面，可以继续参考下面步骤部署前端，然后通过前端地址来访问。

1
欢迎使用RuoYi后台管理框架，当前版本：v3.8.8，请通过前端地址访问。

运行前端项目

初始化项目

进入开发目录下，使用vscode命令code 打开项目

1
2
3
4
5
# 克隆vue3项目
git clone https://gitee.com/ys-gitee/RuoYi-Vue3.git

# 通过vscode打开项目
code ./RuoYi-Vue3

项目运行

在vscode终端中输入以下命令：

1
2
3
4
5
6
7
8
# 安装依赖
npm install

# 建议不要直接使用 cnpm 安装依赖，会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题
npm install --registry=https://registry.npmmirror.com

# 启动服务
npm run dev
1
2
3
4
5
6
VITE v5.0.4  ready in 1715 ms

➜  Local:   http://localhost:80/
➜  Network: http://192.168.150.1:80/
➜  Network: http://192.168.43.82:80/
➜  press h + enter to show help

打开浏览器，输入：([http://localhost:80) 默认账户/密码 admin/admin123）若能正确展示登录页面，并能成功登录，菜单及页面展示正常，则表明环境搭建成功

入门案例

在若依项目成功搭建之后，深入了解其代码生成器功能是掌握框架的重要一环。

接下来，我们将利用若依框架的代码生成器实现CRM系统中的课程管理功能，这将使我们能够实际体验并掌握如何在项目中有效使用这一工具。

因为本项目是前后端完全分离的，所以需要前后端都单独启动好，才能进行访问。

功能需求

实现CRM系统中的课程管理功能，涵盖增加、删除、修改和查询课程信息的完整前后端代码。

原型地址：https://app.mockplus.cn/run/prototype/_lwaPYSV9Ue6/byFT7QUzmCqJ/2AadzZnerRIDo?cps=collapse&isShare=true

步骤分析

1、准备课程表结构和数据sql文件，导入到数据库中

2、登录系统（系统工具 -> 代码生成 -> 导入课程表）

3、代码生成列表中找到课程表（可预览、编辑、同步、删除生成配置）

4、点击生成代码会得到一个ruoyi.zip

5、执行sql文件导入菜单，按照包内目录结构复制到自己的项目中即可

代码生成

提供课程表

准备课程表结构和数据sql文件课程管理.sql，导入到数据库中

系统导入

登录系统（系统工具 -> 代码生成 -> 导入课程表）

image-20241201143342212

配置代码

代码生成列表中找到课程表（可预览、编辑、同步、删除生成配置）

image-20241130180659570

点击生成

  • 点击生成代码，得到一个ruoyi.zip

  • 解压后得到：后端代码、前端代码、菜单sql

image-20240407171214375

代码导入

导入课程菜单

执行sql脚本，导入菜单数据

image-20240407172732924

导入后端代码

将生成的后端代码和mapper文件，导入ruoyi-admin模块中

image-20240515194048039

注意：如果导入后的代码重启后没生效，可以通过maven先clean再启动

导入前端代码

将生成的前端代码，导入ruoyi-ui模块中

image-20240515194033701

访问测试

代码生成器默认生成的课程管理模块在系统工具菜单下，打开测试CRUD功能

image-20240515194309391

功能详解

系统管理

权限系统

RBAC

lRBAC（基于角色的访问控制）是一种广泛使用的访问控制模型，通过角色来分配和管理用户的菜单权限。

image-20241130183440379

表关系

image-20240515194525518

image-20240515194550233

数据字典

介绍

若依内置的数据字典，用于维护系统中常见的静态数据。例如：性别、状态…

image-20240515194849692

功能包括：字典类型管理、字典数据管理

image-20240515194953367

表关系

image-20240515195031748

案例

将课程管理的学科字段改为数据字典维护。

image-20240515211609621

实现步骤：

①添加字典类型和数据

image-20240515195114801

②修改代码生成信息

image-20240515195134472

③下载代码，导入前端

参数设置

参数设置：对系统中的参数进行动态维护。

image-20240515195404229

关闭登录验证码

image-20240515195419521

通知公告

RuoYi的通知公告功能提供了一个方便的方式来发布和管理通知、公告和新闻等信息。管理员可以创建、编辑和删除通知（支持富文本编辑和附件上传）。

系统将信息发送给指定的用户、部门或角色。用户可以通过系统界面或电子邮件接收通知，从而确保信息及时传达（这部分需要自己开发）。

通知公告功能有助于组织内部沟通和信息传递，提高了工作效率和信息共享。

日志管理

登录日志

  • 记录用户的登录信息，包括登录时间和地点（IP地址）。
  • 帮助管理员监控登录行为，及时发现任何可疑的登录尝试。
  • 同样提供搜索和筛选功能，方便查找特定用户的登录历史。

操作日志

  • 记录用户在系统中的所有操作，如查看、修改数据等。
  • 帮助管理员检查谁做了什么，以及何时做的，确保数据准确无误。
  • 可以快速搜索和找到特定的操作记录，便于管理和审查。

系统监控

监控相关

若依提供了一些列强大的监控工具，能够帮助开发者和运维快速了解应用程序的性能状态。

  1. 在线用户：
    • 管理员可以看到当前谁在系统里，他们什么时候登录的，从哪里登录的，属于哪个部门。
    • 如果有人没权限还赖着不走，管理员可以一键让他们下线，保证系统的安全。
  2. 数据监控：
    • 管理员可以实时看到系统的各项指标，比如资源使用情况，数据库状态等。
    • 通过图表可以直观地看出系统是否健康，如果出现问题，系统会发出警报。
  3. 服务监控：
    • 管理员可以监控系统中各个服务是否正常运行，以及它们的性能指标。
    • 如果服务出现问题，系统会立即通知管理员，并通过仪表板展示，方便管理员快速了解情况。
  4. 缓存监控：
    • 管理员可以监控系统的缓存使用情况，比如缓存是否经常被用到，缓存的大小等。
    • 系统还可以自动清理缓存，保持数据的新鲜度，如果缓存有问题，也会发出警报。

定时任务

介绍

若依为定时任务功能提供方便友好的web界面，实现动态管理任务。

案例

  • 每间隔5秒，控制台输出系统时间。

实现步骤：

①创建任务类
image-20240515200554019

②添加任务规则

image-20240515200608310

  • 任务名称：自定义，如：定时查询任务状态
  • 任务分组：根据字典sys_job_group配置，可自行进行配置
  • 调用目标字符串：设置后台任务方法名称参数
  • 执行表达式：可查询官方cron表达式介绍
  • 执行策略：定时任务自定义执行策略
  • 并发执行：是否需要多个任务间同时执行

③启动任务

image-20240515212230091

系统工具

表单构建

介绍

  • 允许用户通过拖放等可视化操作创建表单，比如用来收集数据的表格或调查问卷。
  • 可以自定义表单的各个部分，比如添加不同的输入项和设置验证规则，无需编写代码。
  • 提供了导出数据、导入数据、分享表单和设置权限的功能，方便数据管理和共享。

案例

通过表单构建工具，单独制作一个添加课程的表单页面。

image-20240515212304226

实现步骤：

①制作表单并导出
image-20240515201358208

②复制到前端工程
image-20240515201427300

③创建动态菜单

image-20240515201440877

代码生成

  • 自动化工具，可以快速生成项目中常用的代码，如数据库操作类、后端控制器、前端页面等。
  • 支持根据数据库的表结构反向生成代码，减少手动编写的工作量。
  • 提供三种生成模板：单表、 树表、主子表（一对多），可以生成适用于Spring Boot、MyBatis等流行框架的代码，提高开发效率和代码质量。
  • 树表是一种展示层级数据的表格，能展开折叠，清晰呈现父子关系，便于管理。

代码生成器是个好工具，用好了能提高CRUD效率

附上：代码生成的手册

系统接口

  • Swagger，能够自动生成 API 的同步在线文档，并提供Web界面进行接口调用和测试。

项目结构

后端结构

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
com.ruoyi
├── ruoyi-admin      // 后台服务模块
│       └── web                           // 内置功能的表现层
│       └── RuoYiApplication              // 若依项目启动类    
├── ruoyi-common     // 通用工具模块
│       └── annotation                    // 自定义注解
│       └── config                        // 全局配置
│       └── constant                      // 通用常量
│       └── core                          // 核心控制
│       └── enums                         // 通用枚举
│       └── exception                     // 通用异常
│       └── filter                        // 过滤器处理
│       └── utils                         // 通用类处理
│       └── xss                           // 自定义xss校验
├── ruoyi-framework  // 框架核心模块
│       └── aspectj                       // AOP配置
│       └── config                        // 系统配置
│       └── datasource                    // 多数据源配置 
│       └── interceptor                   // 拦截器
│       └── manager                       // 异步处理
│       └── security                      // 权限控制
│       └── web                           // 前端控制
├── ruoyi-generator  // 代码生成模块（可移除）              
├── ruoyi-quartz     // 定时任务模块（可移除）          
├── ruoyi-system     // 系统代码模块
│       └── domain                        // 系统代码的实体类
│       └── mapper                        // 系统代码的持久层
│       └── service                       // 系统代码的业务层

项目中配置

项目中的配置文件都在ruoyi-admin模块下

  • i18n：国际化处理
  • META-INF：存储了项目的元信息（描述数据的数据），无需修改
  • mybatis：mybatis相关的配置信息
  • application.yml：项目中的核心配置
  • application-druid.yml：数据库连接配置
  • banner.txt：默认的banner图标信息，项目启动，控制台打印显示
  • logback.xml：日志配置

最主要的两个配置文件：application.yml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# 项目相关配置
ruoyi:
  # 名称
  name: RuoYi
  # 版本
  version: 3.8.7
  # 版权年份
  copyrightYear: 2024
  # 文件路径 示例（ Windows配置D:/ruoyi/uploadPath，Linux配置 /home/ruoyi/uploadPath）
  profile: D:/ruoyi/uploadPath
  # 获取ip地址开关
  addressEnabled: false
  # 验证码类型 math 数字计算 char 字符验证
  captchaType: math

# 开发环境配置
server:
  # 服务器的HTTP端口，默认为8080
  port: 8080
  servlet:
    # 应用的访问路径
    context-path: /
  tomcat:
    # tomcat的URI编码
    uri-encoding: UTF-8
    # 连接数满后的排队数，默认为100
    accept-count: 1000
    threads:
      # tomcat最大线程数，默认为200
      max: 800
      # Tomcat启动初始化的线程数，默认值10
      min-spare: 100

# 日志配置
logging:
  level:
    com.ruoyi: debug
    org.springframework: warn

# 用户配置
user:
  password:
    # 密码最大错误次数
    maxRetryCount: 5
    # 密码锁定时间（默认10分钟）
    lockTime: 10

# Spring配置
spring:
  # 资源信息
  messages:
    # 国际化资源文件路径
    basename: i18n/messages
  profiles:
    active: druid
  # 文件上传
  servlet:
    multipart:
      # 单个文件大小
      max-file-size: 10MB
      # 设置总上传的文件大小
      max-request-size: 20MB
  # 服务模块
  devtools:
    restart:
      # 热部署开关
      enabled: true
  # redis 配置
  redis:
    # 地址
    host: localhost
    # 端口，默认为6379
    port: 6379
    # 数据库索引
    database: 0
    # 密码
    password: 123456
    # 连接超时时间
    timeout: 10s
    lettuce:
      pool:
        # 连接池中的最小空闲连接
        min-idle: 0
        # 连接池中的最大空闲连接
        max-idle: 8
        # 连接池的最大数据库连接数
        max-active: 8
        # #连接池最大阻塞等待时间（使用负值表示没有限制）
        max-wait: -1ms

# token配置
token:
  # 令牌自定义标识
  header: Authorization
  # 令牌密钥
  secret: abcdefghijklmnopqrstuvwxyz
  # 令牌有效期（默认30分钟）
  expireTime: 30

# MyBatis配置
mybatis:
  # 搜索指定包别名
  typeAliasesPackage: com.ruoyi.**.domain
  # 配置mapper的扫描，找到所有的mapper.xml映射文件
  mapperLocations: classpath*:mapper/**/*Mapper.xml
  # 加载全局的配置文件
  configLocation: classpath:mybatis/mybatis-config.xml

# PageHelper分页插件
pagehelper:
  helperDialect: mysql
  supportMethodsArguments: true
  params: count=countSql

# Swagger配置
swagger:
  # 是否开启swagger
  enabled: true
  # 请求前缀
  pathMapping: /dev-api

# 防止XSS攻击
xss:
  # 过滤开关
  enabled: true
  # 排除链接（多个用逗号分隔）
  excludes: /system/notice
  # 匹配链接
  urlPatterns: /system/*,/monitor/*,/tool/*

模块依赖关系

各个模块之间的依赖关系：

image-20240515202002135

前端结构

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
ruoyi-vue3
├── bin                        // 执行脚本
├── html                       // IE低版本提示页
├── node_modules               // 第三方依赖库
├── public                     // 公共资源
│   ├── favicon.ico            // favicon图标
├── src                        // 源代码
│   ├── api                    // 所有请求
│   ├── assets                 // 静态资源
│   ├── components             // 全局公用组件
│   ├── directive              // 全局指令
│   ├── layout                 // 布局
│   ├── plugins                // 通用插件
│   ├── router                 // 路由配置
│   ├── store                  // 状态管理
│   ├── utils                  // 全局公用方法
│   ├── views                  // 视图组件
│   ├── App.vue                // 入口组件
│   ├── main.js                // 入口文件
│   ├── permission.js          // 权限管理
│   └── settings.js            // 系统配置
├── vite                       // 构建工具
├── .env.development           // 开发环境配置
├── .env.production            // 生产环境配置
├── .env.staging               // 测试环境配置
├── .gitignore                 // git 忽略项
├── index.html                 // 入口页面
├── package.json               // 项目配置文件（相当于pom.xml）
└── vue.config.js              // Vue项目的配置信息（相当于application.yml）

image-20240515202411640

表结构介绍

ruoyi-vue数据库设计包含了多个表结构，用于支持系统的各种功能模块。

这些表可以根据它们的功能和用途进行分类，以便在后期使用时能够快速定位和理解。以下是对这些表结构的分类和简要说明：

image-20240515202517972

前后端交互流程

查询课程管理列表

接口文档

image-20240515203815442

跨域

在前端开发中，跨域是一个常见的问题，特别是在使用Vue框架进行开发时。跨域是指在浏览器中发送的AJAX请求的目标地址与当前页面的地址不在同一个域下，这会导致浏览器的同源策略产生限制，从而阻止了跨域请求的发送。然而，我们可以通过代理服务器来解决这个问题。

image-20240515203903598

代理服务器是位于客户端和目标服务器之间的一台服务器，它接收客户端发送的请求，并将请求转发给目标服务器。通过在代理服务器上进行请求转发，可以绕过浏览器的同源策略限制，从而实现跨域请求。

在vue.config.js文件中添加以下内容：

image-20240515203936120

二次开发

模块定制

若依框架修改器

若依框架修改器是一个可以一键修改RuoYi框架包名、项目名等的工具。

地址：https://gitee.com/lpf_project/RuoYi-MT/releases

参考