RuoYi基础学习

1 若依搭建

前后端分离版本：RuoYi-Vue利用SpringBoot作为后端开发框架，与Vue.js结合，实现了前后端分离的开发模式。这种架构有助于提高开发效率，前后端可以独立开发和部署，更适合现代化的Web应用开发。

RuoYi-Vue3（前端升级Vue3 Element Plus Vite）
https://github.com/yangzongzhuan/RuoYi-Vue3
RuoYi-Vue-Plus（后端集成Mybatis-Plus、Hutool、OSS存储、分布式锁等组件）
https://gitee.com/dromara/RuoYi-Vue-Plus

RuoYi-Vue

RuoYi-Vue版本，采用了前后端分离的单体架构设计：
软件环境：JDK、MySQL 、Redis 、Maven、Node
技术选型：Spring Boot、Spring Security、MyBatis、Jwt、Vue3、Element-Plus

官方地址：https://gitee.com/y_project/RuoYi-Vue
扩展地址：https://gitee.com/ys-gitee/RuoYi-Vue3

2 初始化项目

后端

Git下载
通过idea克隆若依源码，仓库地址：https://gitee.com/y_project/RuoYi-Vue.git

Maven构建

导入sql
1、创建数据库create schema ry-vue;
2、执行下图的sql脚本文件，完成导入

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

配置信息

1. 在ruoyi-admin模块下，编辑resources目录下的application-druid.yml，修改数据库连接。
2. 启动Redis
3. 修改Redis配置文件

项目运行
在ruoyi-admin模块下，运行com.ruoyi.RuoYiApplication.java，出现如下图表示启动成功

前端

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

# 克隆vue3项目
git clone https://gitee.com/ys-gitee/RuoYi-Vue3.git

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

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

# 安装依赖
npm install

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

# 启动服务
npm run dev

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

3 入门案例

功能需求

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

步骤

1、准备课程表结构和数据sql文件，导入到数据库中
2、登录系统（系统工具 -> 代码生成 -> 导入课程表）
3、代码生成列表中找到课程表（可预览、编辑、同步、删除生成配置）
4、点击生成代码会得到一个ruoyi.zip
5、执行sql文件导入菜单，按照包内目录结构复制到自己的项目中即可

4 功能详解

系统管理

权限系统

例如：

• demo账号（超级管理员），可以查看所有功能菜单
• zhangsan账号（市场专员），可以查看线索管理菜单
• yueyue账号（销售专员），可以查看商机、合同等菜单

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

数据字典

若依内置的数据字典，用于维护系统中常见的静态数据。例如：性别、状态…
功能包括：字典类型管理、字典数据管理
表关系

步骤
①添加字典类型和数据
②修改代码生成信息
③下载代码，导入前端

参数设置

参数设置：对系统中的参数进行动态维护。
比如：关闭登录验证码

通知公告

RuoYi的通知公告功能提供了一个方便的方式来发布和管理通知、公告和新闻等信息。管理员可以创建、编辑和删除通知（支持富文本编辑和附件上传）。
系统将信息发送给指定的用户、部门或角色。用户可以通过系统界面或电子邮件接收通知，从而确保信息及时传达（这部分需要自己开发）。
通知公告功能有助于组织内部沟通和信息传递，提高了工作效率和信息共享。

日志管理

登录日志

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

操作日志

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

系统监控

监控相关

1. 在线用户：

• 管理员可以看到当前谁在系统里，他们什么时候登录的，从哪里登录的，属于哪个部门。
• 如果有人没权限还赖着不走，管理员可以一键让他们下线，保证系统的安全。

2. 数据监控：

• 管理员可以实时看到系统的各项指标，比如资源使用情况，数据库状态等。
• 通过图表可以直观地看出系统是否健康，如果出现问题，系统会发出警报。

3. 服务监控：

• 管理员可以监控系统中各个服务是否正常运行，以及它们的性能指标。
• 如果服务出现问题，系统会立即通知管理员，并通过仪表板展示，方便管理员快速了解情况。

4. 缓存监控：

• 管理员可以监控系统的缓存使用情况，比如缓存是否经常被用到，缓存的大小等。
• 系统还可以自动清理缓存，保持数据的新鲜度，如果缓存有问题，也会发出警报。

定时任务

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

案例

每间隔5秒，控制台输出系统时间。
实现步骤：
①创建任务类

@Component
public class MyTask {
    public void showTime() {
        System.out.println("定时任务开始执行："+new Date());
    }
}

②添加任务规则

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

③启动任务

系统工具

表单构建

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

代码生成

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

系统接口

后端结构

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

# 项目相关配置
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/*

模块依赖关系

前端结构

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）

表结构介绍

ruoyi-vue数据库设计包含了多个表结构，用于支持系统的各种功能模块。
这些表可以根据它们的功能和用途进行分类，以便在后期使用时能够快速定位和理解。以下是对这些表结构的分类和简要说明：

后端代码

controller

Controller继承了BaseController，其中BaseController详细定义如下图：

分页

分页查询统一返回对象：表格分页数据对象

增删改查

增删改查统一返回对象：操作消息提醒

实体类

所有实体类默认继承的BaseEntity基类

权限注解

@PreAuthorize 注解是 Spring Security 框架中用来做权限检查的。
它在运行方法前先验证权限，权限够就放行，不够就拦截。

流程图

跨域请求

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

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

二次开发

框架名修改器

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