当前位置: 首页 > article >正文

若依系统的学习

若依环境

介绍

‌若依是一款快速开发平台(低代码),用于快速构建企业级后台管理系统,它提供了许多常用的功能模块和组件,包括权限管理、代码生成、工作流、消息中心等

官方地址: https://www.ruoyi.vip/

  1. 基于Spring Boot和Spring Cloud‌:采用现代化的微服务架构,利用Spring Boot和Spring Cloud提供的便捷开发和部署特性
  2. 模块化设计‌:功能模块之间解耦,易于扩展和定制
  3. 多租户支持‌:支持多租户管理,可以为不同的租户提供独立的数据和功能
  4. 代码生成器‌:提供代码生成器,可以快速生成CRUD代码,减少重复工作
  5. 完善的权限管理‌:提供灵活的权限管理功能,支持角色权限划分、数据权限控制等
  6. 友好的界面‌:提供现代化的界面设计,用户友好,易于操作。

通过若依,开发人员可以快速搭建稳健、高效的企业级应用,提高开发效率和产品质量

若依版本

若依官方针对不同开发需求提供了多个版本的框架,每个版本都有其独特的特点和适用场景

  • RuoYi(SpringBoot+Bootstrap):前后端混合开发版本,适用于小型项目
  • RuoYi-Vue(SpringBoot+Vue):前后端分离版本,适用于中型项目
  • RuoYi-Cloud(SpringCloud+Vue):微服务版本,适用于大型项目
  • RuoYi-App(SpringCloud+Uniapp):移动端版本

若依框架因其强大的功能和灵活性,吸引了众多第三方开发者基于其核心架构进行扩展和优化,从而形成了丰富的生态系统

  • 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(11)、MySQL(8) 、Redis (5)、Maven(3.6)、NodeJS(16)

技术选型:Spring Boot、Spring Security、MyBatis、Jwt、Vue3、Element-Plus

官方地址:https://gitee.com/y_project/RuoYi-Vue

扩展地址:https://gitee.com/ys-gitee/RuoYi-Vue3

后端代码

初始化项目

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

使用idea打开项目后,等待环境检查(主要是Maven下载项目依赖)

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

准备MySQL

1、创建数据库ry-vue

2、执行下图的sql脚本文件,完成导入

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

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

# 数据源配置
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密码等相关信息

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

项目运行

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

前端代码

初始化项目

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

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

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

项目运行

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

# 安装环境
npm install

# 启动服务
npm run dev

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

若依入门

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

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

功能需求

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

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

代码生成

提供课程表

DROP TABLE IF EXISTS `tb_course`;
CREATE TABLE `tb_course` (
  `id` bigint NOT NULL AUTO_INCREMENT COMMENT '课程id',
  `code` varchar(32) CHARACTER SET utf8mb3 COLLATE utf8mb3_bin DEFAULT NULL COMMENT '课程编码',
  `subject` varchar(32) CHARACTER SET utf8mb3 COLLATE utf8mb3_bin DEFAULT NULL COMMENT '课程学科',
  `name` varchar(64) CHARACTER SET utf8mb3 COLLATE utf8mb3_bin DEFAULT NULL COMMENT '课程名称',
  `price` int DEFAULT NULL COMMENT '价格(元)',
  `applicable_person` varchar(32) CHARACTER SET utf8mb3 COLLATE utf8mb3_bin DEFAULT NULL COMMENT '适用人群',
  `info` varchar(255) CHARACTER SET utf8mb3 COLLATE utf8mb3_bin DEFAULT NULL COMMENT '课程介绍',
  `create_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `update_time` timestamp NULL DEFAULT NULL COMMENT '更新时间',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8mb3 COLLATE=utf8mb3_bin COMMENT='课程管理';

INSERT INTO `tb_course` VALUES 
    (1,'cp123456','javaEE','JavaSE基础',199,'小白学员','JavaSE基础','2024-04-20 09:57:35','2024-04-20 09:57:35'),	
    (2,'cp123457','javaEE','JavaWeb',188,'初级开发者','JavaWeb','2024-04-20 09:57:35','2024-04-20 09:57:35'),
    (3,'cp123458','Python+大数据','Python入门',555,'小白学员','Python入门','2024-04-20 09:57:35','2024-04-20 09:57:35'),
    (4,'cp123459','Python+大数据','PythonWeb',88,'初级开发者','PythonWeb','2024-04-20 09:57:35','2024-04-20 09:57:35'),
    (5,'cp123460','鸿蒙应用开发','鸿蒙入门',99,'小白学员','鸿蒙入门','2024-04-20 09:57:35','2024-04-20 09:57:35'),
    (6,'cp123461','鸿蒙应用开发','鸿蒙商城实战',59,'初级开发者','鸿蒙商城实战','2024-04-20 09:57:35','2024-04-20 09:57:35');

系统导入

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

配置代码

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

image-20240515194239631

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

点击生成

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

image-20240407171714267

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

image-20240407171214375

代码导入

导入课程菜单

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

导入后端代码

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

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

导入前端代码

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

访问测试

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

代码位置

新建一个模块 ruoyi-crm

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

将代码复制到crm模块中

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

在父工程的pom.xml中锁定crm模块的版本

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

在admin模块中引入crm模块

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

功能详解

我们将对若依的通用功能进行详解。本章内容分为三个重点部分:

系统管理

权限系统

若依提供了企业级通用权限系统,可以给不同的人设置不同的权限,然后每个人登录系统后可以看到不同的页面按钮

如果要实现这样的权限控制,需要依靠一个RBAC(基于角色的访问控制)模型,通过角色来分配和管理用户的菜单权限

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

此权限模型下设计的核心数据表有五张,分别是用户表–中间表–角色表–中间表–权限表

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

select sm.* from sys_user  su
    left join sys_user_role sur on su.user_id = sur.user_id
    left join sys_role sr on sur.role_id = sr.role_id
    left join sys_role_menu srm on sr.role_id = srm.role_id
    left join sys_menu sm on srm.menu_id = sm.menu_id
where su.user_id = 2

接下来,我们可以尝试自己来创建一个角色,然后来关联人员和权限

基础数据

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

活动管理

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

课程管理

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

角色

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

用户

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

数据字典

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

设计到表有两张

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

接下来我们将课程管理的学科字段改为数据字典维护

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

实现步骤:

①添加字典类型和数据

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

②修改代码生成信息

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

③下载代码,导入前端

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

参数设置

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

关闭登录验证码

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

通知公告

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

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

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

日志管理

登录日志

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

操作日志

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

系统监控

监控相关

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

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

定时任务

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

①创建任务类

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

②添加任务规则

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

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

③启动任务

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

系统工具

表单构建

表单构建允许用户通过拖放等可视化操作创建表单,比如用来收集数据的表格或调查问卷。

可以自定义表单的各个部分,比如添加不同的输入项和设置验证规则,无需编写代码。

提供了导出数据、导入数据、分享表单和设置权限的功能,方便数据管理和共享。

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

实现步骤:

①制作表单并导出

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

②复制到前端工程

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

③创建动态菜单

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

代码生成

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

代码生成配置主表实现细节:

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

系统接口

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

核心的注解,主要包含以下几个:

注解位置说明
@ApiModel类(通常是实体类)描述实体类的作用
@ApiModelProperty属性描述实体类的属性
@Api加载Controller类上,表示对类的说明
@ApiOperation方法说明方法的用途、作用
@ApiImplicitParams方法表示一组参数说明
@ApiImplicitParam方法用在@ApiImplicitParams注解中,指定一个请求参数的各个方面的属性

项目结构

在功能的讲解过程中,涉及的前后端项目的结构和配置文件,我们还比较陌生,为了更好的使用若依进行项目开发,所以接下来,我们开始进入项目结构这部分内容的学习

后端结构

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数据库设计包含了多个表结构,用于支持系统的各种功能模块

这些表可以根据它们的功能和用途进行分类,以便在后期使用时能够快速定位和理解

以下是对这些表结构的分类和简要说明

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

源码阅读

本章我们将围绕入门案例生成的课程管理进行讲解,包含前后端代码的分析,以及前后端代码交互的流程,通过这部分的学习,不仅能让我们掌握若依的基础业务逻辑,在此基础上还能为我们日后的定制开发提供强有力的支撑。

前端代码分析

找到src/views/course/course/index.vue文件,护理项目的前端代码已经添加了详细的注释,如下:

<template>
  <div class="app-container">

    <!-- 搜索表单 start -->
    <el-form :model="queryParams" ref="queryRef" :inline="true" v-show="showSearch" label-width="68px">   
      <el-form-item label="课程编码" prop="code">
        <el-input
          v-model="queryParams.code"
          placeholder="请输入课程编码"
          clearable
          @keyup.enter="handleQuery"
        />
      </el-form-item>
      <el-form-item label="课程学科" prop="subject">
        <el-select v-model="queryParams.subject" placeholder="请选择课程学科" clearable>
          <el-option
            v-for="dict in course_subject"
            :key="dict.value"
            :label="dict.label"
            :value="dict.value"
          />
        </el-select>
      </el-form-item>
      <el-form-item label="课程名称" prop="name">
        <el-input
          v-model="queryParams.name"
          placeholder="请输入课程名称"
          clearable
          @keyup.enter="handleQuery"
        />
      </el-form-item>
      <el-form-item label="适用人群" prop="applicablePerson">
        <el-input
          v-model="queryParams.applicablePerson"
          placeholder="请输入适用人群"
          clearable
          @keyup.enter="handleQuery"
        />
      </el-form-item>
      <el-form-item>
        <el-button type="primary" icon="Search" @click="handleQuery">搜索</el-button>
        <el-button icon="Refresh" @click="resetQuery">重置</el-button>
      </el-form-item>
    </el-form>
    <!-- 搜索表单 end -->

    <!-- 按钮区域 start -->
    <el-row :gutter="10" class="mb8">
      <el-col :span="1.5">
        <el-button
          type="primary"
          plain
          icon="Plus"
          @click="handleAdd"
          v-hasPermi="['course:course:add']"
        >新增</el-button>
      </el-col>
      <el-col :span="1.5">
        <el-button
          type="success"
          plain
          icon="Edit"
          :disabled="single"
          @click="handleUpdate"
          v-hasPermi="['course:course:edit']"
        >修改</el-button>
      </el-col>
      <el-col :span="1.5">
        <el-button
          type="danger"
          plain
          icon="Delete"
          :disabled="multiple"
          @click="handleDelete"
          v-hasPermi="['course:course:remove']"
        >删除</el-button>
      </el-col>
      <el-col :span="1.5">
        <el-button
          type="warning"
          plain
          icon="Download"
          @click="handleExport"
          v-hasPermi="['course:course:export']"
        >导出</el-button>
      </el-col>
      <right-toolbar v-model:showSearch="showSearch" @queryTable="getList"></right-toolbar>
    </el-row>
    <!-- 按钮区域end -->

    <!-- 数据展示表格 start -->
    <el-table v-loading="loading" :data="courseList" @selection-change="handleSelectionChange"> 
      <el-table-column type="selection" width="55" align="center" />
      <el-table-column label="课程id" align="center" prop="id" />
      <el-table-column label="课程编码" align="center" prop="code" />
      <el-table-column label="课程学科" align="center" prop="subject">
        <template #default="scope">
          <dict-tag :options="course_subject" :value="scope.row.subject"/>
        </template>
      </el-table-column>
      <el-table-column label="课程名称" align="center" prop="name" />
      <el-table-column label="价格" align="center" prop="price" />
      <el-table-column label="适用人群" align="center" prop="applicablePerson" />
      <el-table-column label="课程介绍" align="center" prop="info" />
      <el-table-column label="操作" align="center" class-name="small-padding fixed-width">
        <template #default="scope">
          <el-button link type="primary" icon="Edit" @click="handleUpdate(scope.row)" v-hasPermi="['course:course:edit']">修改</el-button>
          <el-button link type="primary" icon="Delete" @click="handleDelete(scope.row)" v-hasPermi="['course:course:remove']">删除</el-button>
        </template>
      </el-table-column>
    </el-table>
    <!-- 数据展示表格 end -->
    
    <!-- 分页区域 start -->
    <pagination
      v-show="total>0"
      :total="total"
      v-model:page="queryParams.pageNum"
      v-model:limit="queryParams.pageSize"
      @pagination="getList"
    />
    <!-- 分页区域 end -->

    <!-- 添加或修改课程管理对话框 -->
    <el-dialog :title="title" v-model="open" width="500px" append-to-body>
      <el-form ref="courseRef" :model="form" :rules="rules" label-width="80px">
        <el-form-item label="课程编码" prop="code">
          <el-input v-model="form.code" placeholder="请输入课程编码" />
        </el-form-item>
        <el-form-item label="课程学科" prop="subject">
          <el-select v-model="form.subject" placeholder="请选择课程学科">
            <el-option
              v-for="dict in course_subject"
              :key="dict.value"
              :label="dict.label"
              :value="dict.value"
            ></el-option>
          </el-select>
        </el-form-item>
        <el-form-item label="课程名称" prop="name">
          <el-input v-model="form.name" placeholder="请输入课程名称" />
        </el-form-item>
        <el-form-item label="价格" prop="price">
          <el-input v-model="form.price" placeholder="请输入价格" />
        </el-form-item>
        <el-form-item label="适用人群" prop="applicablePerson">
          <el-input v-model="form.applicablePerson" placeholder="请输入适用人群" />
        </el-form-item>
        <el-form-item label="课程介绍" prop="info">
          <el-input v-model="form.info" placeholder="请输入课程介绍" />
        </el-form-item>
      </el-form>
      <template #footer>
        <div class="dialog-footer">
          <el-button type="primary" @click="submitForm">确 定</el-button>
          <el-button @click="cancel">取 消</el-button>
        </div>
      </template>
    </el-dialog>
  </div>
</template>

<script setup name="Course">



// 引入后端api接口
import { listCourse, getCourse, delCourse, addCourse, updateCourse } from "@/api/course/course";
// 获取当前实例代理对象,用于访问组件数据、方法
const { proxy } = getCurrentInstance();
// 获取课程学科的数据字典
const { course_subject } = proxy.useDict('course_subject');
// 列表数据
const courseList = ref([]);
// 是否显示弹框
const open = ref(false);
// 是否显示加载状态
const loading = ref(true);
// 是否显示搜索栏
const showSearch = ref(true);
// 复选框,被选中id的数组
const ids = ref([]);
// 复选框,是否单选,用于高亮修改、删除按钮
const single = ref(true);
// 复选框,是否多选,仅高亮删除按钮
const multiple = ref(true);
// 总(记录)条数
const total = ref(0);
// 用于区分新增、修改对话框标题
const title = ref("");
// 定义reactive响应式对象
const data = reactive({
  // 新增或修改表单数据
  form: {},
  // 搜索条件参数
  queryParams: {
    pageNum: 1,
    pageSize: 10,
    code: null,
    subject: null,
    name: null,
    applicablePerson: null,
  },
  // 表单校验规则
  rules: {
    code: [
      { required: true, message: "课程编码不能为空", trigger: "blur" }
    ],
    subject: [
      { required: true, message: "课程学科不能为空", trigger: "change" }
    ],
    name: [
      { required: true, message: "课程名称不能为空", trigger: "blur" }
    ],
    price: [
      { required: true, message: "价格不能为空", trigger: "blur" }
    ],
    applicablePerson: [
      { required: true, message: "适用人群不能为空", trigger: "blur" }
    ],
    info: [
      { required: true, message: "课程介绍不能为空", trigger: "blur" }
    ],
  }
});
// 将data对象的三个属性,转换为ref响应式对象
const { queryParams, form, rules } = toRefs(data);

/** 查询课程管理列表 */
function getList() {
  loading.value = true;
  listCourse(queryParams.value).then(response => {
    courseList.value = response.rows;
    total.value = response.total;
    loading.value = false;
  });
}

// 取消按钮
function cancel() {
  open.value = false;
  reset();
}

// 表单重置
function reset() {
  form.value = {
    id: null,
    code: null,
    subject: null,
    name: null,
    price: null,
    applicablePerson: null,
    info: null,
    createTime: null,
    updateTime: null
  };
  proxy.resetForm("courseRef");
}

/** 搜索按钮操作 */
function handleQuery() {
  queryParams.value.pageNum = 1;
  getList();
}

/** 重置按钮操作 */
function resetQuery() {
  proxy.resetForm("queryRef");
  handleQuery();
}

// 多选框选中数据
function handleSelectionChange(selection) {
  ids.value = selection.map(item => item.id);
  single.value = selection.length != 1;
  multiple.value = !selection.length;
}

/** 新增按钮操作 */
function handleAdd() {
  reset();
  open.value = true;
  title.value = "添加课程管理";
}

/** 修改按钮操作 */
function handleUpdate(row) {
  reset();
  const _id = row.id || ids.value
  getCourse(_id).then(response => {
    form.value = response.data;
    open.value = true;
    title.value = "修改课程管理";
  });
}

/** 提交按钮 */
function submitForm() {
  proxy.$refs["courseRef"].validate(valid => {
    if (valid) {
      if (form.value.id != null) {
        updateCourse(form.value).then(response => {
          proxy.$modal.msgSuccess("修改成功");
          open.value = false;
          getList();
        });
      } else {
        addCourse(form.value).then(response => {
          proxy.$modal.msgSuccess("新增成功");
          open.value = false;
          getList();
        });
      }
    }
  });
}

/** 删除按钮操作 */
function handleDelete(row) {
  const _ids = row.id || ids.value;
  proxy.$modal.confirm('是否确认删除课程管理编号为"' + _ids + '"的数据项?').then(function() {
    return delCourse(_ids);
  }).then(() => {
    getList();
    proxy.$modal.msgSuccess("删除成功");
  }).catch(() => {});
}

/** 导出按钮操作 */
function handleExport() {
  proxy.download('course/course/export', { 
    ...queryParams.value
  }, `course_${new Date().getTime()}.xlsx`)
}

// 页面加载时执行-查询课程管理列表
getList();
</script>

后端代码分析

CourseController

ruoyi-admin模块下找到这个类:com.ruoyi.web.controller.course.CourseController里面有5个对应的方法接口,详细代码如下:

package com.sky.course.controller;

import com.sky.common.annotation.Log;
import com.sky.common.core.controller.BaseController;
import com.sky.common.core.domain.AjaxResult;
import com.sky.common.core.page.TableDataInfo;
import com.sky.common.enums.BusinessType;
import com.sky.common.utils.poi.ExcelUtil;
import com.sky.course.domain.Course;
import com.sky.course.service.ICourseService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.*;

import javax.servlet.http.HttpServletResponse;
import java.util.List;

/**
 * 课程管理Controller
 *
 * @author itheima
 */
@RestController
@RequestMapping("/course/course")
public class CourseController extends BaseController
{
    @Autowired
    private ICourseService courseService;

    /**
     * 查询课程管理列表
     */
    @PreAuthorize("@ss.hasPermi('course:course:list')")
    @GetMapping("/list")
    public TableDataInfo list(Course course)
    {
        //1. 开启分页
        startPage();
        //2. 查询课程列表
        List<Course> list = courseService.selectCourseList(course);
        //3. 返回表格分页数据对象
        return getDataTable(list);
    }

    /**
     * 导出课程管理列表
     */
    @PreAuthorize("@ss.hasPermi('course:course:export')")
    @Log(title = "课程管理", businessType = BusinessType.EXPORT)
    @PostMapping("/export")
    public void export(HttpServletResponse response, Course course)
    {
        List<Course> list = courseService.selectCourseList(course);
        ExcelUtil<Course> util = new ExcelUtil<Course>(Course.class);
        util.exportExcel(response, list, "课程管理数据");
    }

    /**
     * 获取课程管理详细信息
     */
    @PreAuthorize("@ss.hasPermi('course:course:query')")
    @GetMapping(value = "/{id}")
    public AjaxResult getInfo(@PathVariable("id") Long id)
    {
        return success(courseService.selectCourseById(id));
    }

    /**
     * 新增课程管理
     */
    @PreAuthorize("@ss.hasPermi('course:course:add')")
    @Log(title = "课程管理", businessType = BusinessType.INSERT)
    @PostMapping
    public AjaxResult add(@RequestBody Course course)
    {
        return toAjax(courseService.insertCourse(course));
    }

    /**
     * 修改课程管理
     */
    @PreAuthorize("@ss.hasPermi('course:course:edit')")
    @Log(title = "课程管理", businessType = BusinessType.UPDATE)
    @PutMapping
    public AjaxResult edit(@RequestBody Course course)
    {
        return toAjax(courseService.updateCourse(course));
    }

    /**
     * 删除课程管理
     */
    @PreAuthorize("@ss.hasPermi('course:course:remove')")
    @Log(title = "课程管理", businessType = BusinessType.DELETE)
	@DeleteMapping("/{ids}")
    public AjaxResult remove(@PathVariable Long[] ids)
    {
        return toAjax(courseService.deleteCourseByIds(ids));
    }
}

BaseController

Controller继承了BaseController,其中BaseController详细定义如下图:

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

TableDataInfo

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

AjaxResult

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

BaseEntity

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

权限注解

@PreAuthorize 注解是 Spring Security 框架中用来做权限检查的。

它在运行方法前先验证权限,权限够就放行,不够就拦截。

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

权限控制流程图

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传 外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

前后端交互

接口文档

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

跨域

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

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

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

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

外观调整

接下来我们将利用这些知识,实现外卖管理系统的业务功能开发

修改包名

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

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

资料中已提供,将项目打成压缩包,直接修改即可:

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

页面调整

如果使用若依框架项目做为脚手架,那么我们肯定需要在页面显示中,符合自己公司或者项目的标识才行,需要更换的地方很多,我们依次来解决它

  • 浏览器标签页logo标识、标题
  • 系统页面中的logo标识、标题
  • 去除源码地址 & 文档地址
  • 主题风格和菜单图标
  • 登录名称及背景图

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

浏览器标签页icon、标题

找到资料中的logo图标,替换前端项目中的public文件夹,删除原有的favicon.ico,把新拷贝过来的logo更名为favicon.ico即可

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

找到根目录下的index.html文件,把title更换为自己想要的内容即可

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

系统页面中的logo、标题

找到资料中的logo文件,替换 src/assets/logo/logo.png文件

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

若依的系统页面标题引用的是开发环境的配置,我们只需要修改开发的环境的VITE_APP_TITLE属性即可

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

去除源码 & 文档

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

主题和自定义图标

在目前的前端项目中,已经提供了非常便利的操作方式,可以切换主题的风格

操作:点击右上角的头像,可以找到**布局设置,**如下操作

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

在前端代码中也有对应的操作,更好主题风格文件位置:src/setting.js

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

更换主题颜色文件位置:src/store/modules/settings.js

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

访问阿里巴巴矢量图库,搜索图标:https://www.iconfont.cn/search/index?searchType=icon&q=%E8%8F%9C%E5%93%81%E7%AE%A1%E7%90%86

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

将下载好的图标复制到src/assets/icons/svg目录下,就可以给指定菜单设置图标了

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

登录页面中标题、背景图

登录名称和背景图,我们可以直接找到登录的组件进行修改即可

组件位置:src/views/login.vue

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

学习视频

[外链图片转存中…(img-vsvObBRP-1725457905124)]

[外链图片转存中…(img-cTgNevvZ-1725457905124)]

浏览器标签页icon、标题

找到资料中的logo图标,替换前端项目中的public文件夹,删除原有的favicon.ico,把新拷贝过来的logo更名为favicon.ico即可

[外链图片转存中…(img-oYx4vARj-1725457905124)]

找到根目录下的index.html文件,把title更换为自己想要的内容即可

[外链图片转存中…(img-9mzBcIjN-1725457905125)]

系统页面中的logo、标题

找到资料中的logo文件,替换 src/assets/logo/logo.png文件

[外链图片转存中…(img-gTyM4tOz-1725457905125)]

若依的系统页面标题引用的是开发环境的配置,我们只需要修改开发的环境的VITE_APP_TITLE属性即可

[外链图片转存中…(img-q14lOoms-1725457905125)]

去除源码 & 文档

[外链图片转存中…(img-PUZEeBSy-1725457905125)]

主题和自定义图标

在目前的前端项目中,已经提供了非常便利的操作方式,可以切换主题的风格

操作:点击右上角的头像,可以找到**布局设置,**如下操作

[外链图片转存中…(img-m8Vevl8r-1725457905126)]

在前端代码中也有对应的操作,更好主题风格文件位置:src/setting.js

[外链图片转存中…(img-839By1Iz-1725457905126)]

更换主题颜色文件位置:src/store/modules/settings.js

[外链图片转存中…(img-NV5CvPpZ-1725457905126)]

访问阿里巴巴矢量图库,搜索图标:https://www.iconfont.cn/search/index?searchType=icon&q=%E8%8F%9C%E5%93%81%E7%AE%A1%E7%90%86

[外链图片转存中…(img-5siznVAc-1725457905126)]

将下载好的图标复制到src/assets/icons/svg目录下,就可以给指定菜单设置图标了

[外链图片转存中…(img-qHOB8I8G-1725457905126)]

登录页面中标题、背景图

登录名称和背景图,我们可以直接找到登录的组件进行修改即可

组件位置:src/views/login.vue

[外链图片转存中…(img-ZetGKsLr-1725457905127)]

[外链图片转存中…(img-N6UzG2Fl-1725457905127)]

学习视频

https://www.bilibili.com/video/BV1pf421B71v


http://www.kler.cn/a/291180.html

相关文章:

  • vue 基础学习
  • React Native 集成原生Android功能
  • 【踩坑记录】C编程变量未初始化导致的程序异常
  • Scala项目(图书管理系统)
  • 实现一个简单的哈希表
  • Spring Boot 应用开发入门(一)
  • 我与Linux的爱恋:Linux的基本指令
  • C++11新增特性:列表初始化(std::initializer_list) decltype、auto、nullptr、范围for
  • RISC-V最先进CPU微架构分析
  • Flutter修改Android包名
  • 3.js - modelPosition.z = sin((modelPosition.x+uTime)*10.0)*0.05;
  • # Windows下配置Redis以服务方式启动
  • 创新大赛国赛路演:如何准备一份打动人心的路演稿
  • 数学建模笔记
  • 8月29日wpf
  • vue原理分析(四)Vue实例挂载到app上面
  • C++系列-STL容器的应用举例
  • AI自动生成PPT哪个软件好?如何自动生成专业级PPT?
  • 浙大数据结构:01-复杂度1 最大子列和问题
  • 解决el-table中使用el-input无法聚焦问题
  • OpenAI transcription API bad request
  • ubuntu20.04 colmap安装
  • 假期学习-- iOS runloop了解和使用
  • 【STM32】寄存器点灯
  • 比特币客户端和API
  • 日程安排组件DHTMLX Scheduler v7.1 - 支持RFC-5545格式