RuoYi-Vue-Plus 项目使用教程

1. 项目的目录结构及介绍

RuoYi-Vue-Plus 是一个基于 Spring Boot 3.4 和 Vue3 的企业级快速开发平台，针对分布式集群与多租户场景进行了全方位升级。项目采用插件化+扩展包形式，结构解耦，易于扩展。

目录结构介绍

RuoYi-Vue-Plus/
├── ruoyi-admin/                 # 核心管理模块
│   ├── src/main/java/org/dromara/    # Java源码目录
│   │   ├── DromaraApplication.java   # 项目启动类
│   │   ├── web/controller/           # 控制器层
│   │   ├── web/service/              # 服务层
│   │   └── web/listener/             # 监听器
│   └── src/main/resources/           # 配置文件目录
│       ├── application.yml           # 主配置文件
│       ├── application-dev.yml       # 开发环境配置
│       ├── application-prod.yml      # 生产环境配置
│       ├── logback-plus.xml          # 日志配置
│       └── i18n/                     # 国际化文件
├── ruoyi-common/                 # 公共模块
│   ├── ruoyi-common-core/        # 核心工具类
│   ├── ruoyi-common-web/         # Web相关组件
│   ├── ruoyi-common-mybatis/     # Mybatis扩展
│   ├── ruoyi-common-redis/       # Redis组件
│   └── ...其他20+个公共子模块
├── ruoyi-modules/                # 业务模块
│   ├── ruoyi-system/             # 系统管理模块
│   ├── ruoyi-generator/          # 代码生成器
│   ├── ruoyi-demo/               # 示例模块
│   ├── ruoyi-job/                # 任务调度
│   └── ruoyi-workflow/           # 工作流
├── ruoyi-extend/                 # 扩展模块
│   ├── ruoyi-monitor-admin/      # 监控管理
│   └── ruoyi-snailjob-server/    # 分布式任务调度
└── script/                       # 脚本文件
    ├── docker/                   # Docker部署配置
    ├── sql/                      # 数据库脚本
    └── leave/                    # 示例数据

2. 项目的启动文件介绍

项目的启动文件是 ruoyi-admin/src/main/java/org/dromara/DromaraApplication.java，这是整个Spring Boot应用的入口点。

package org.dromara;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.metrics.buffering.BufferingApplicationStartup;

@SpringBootApplication
public class DromaraApplication {
    public static void main(String[] args) {
        SpringApplication application = new SpringApplication(DromaraApplication.class);
        application.setApplicationStartup(new BufferingApplicationStartup(2048));
        application.run(args);
        System.out.println("(♥◠‿◠)ﾉﾞ  RuoYi-Vue-Plus启动成功   ლ(´ڡ`ლ)ﾞ");
    }
}

启动类使用了 @SpringBootApplication 注解，包含了配置、自动配置和组件扫描功能。通过设置 BufferingApplicationStartup 来优化启动性能。

3. 项目的配置文件介绍

主配置文件 application.yml

项目的主要配置文件位于 ruoyi-admin/src/main/resources/application.yml，包含以下主要配置：

# 服务器配置
server:
  port: 8080
  servlet:
    context-path: /
  undertow:
    threads:
      io: 4
      worker: 32

# Spring配置
spring:
  application:
    name: ruoyi-vue-plus
  profiles:
    active: dev
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

# Mybatis配置
mybatis-plus:
  mapper-locations: classpath*:mapper/**/*Mapper.xml
  type-aliases-package: org.dromara.**.domain
  configuration:
    map-underscore-to-camel-case: true
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

# 日志配置
logging:
  config: classpath:logback-plus.xml

开发环境配置 application-dev.yml

# 数据源配置
spring:
  datasource:
    dynamic:
      primary: master
      datasource:
        master:
          url: jdbc:mysql://localhost:3306/ry-vue-plus?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
          username: root
          password: password
          driver-class-name: com.mysql.cj.jdbc.Driver

# Redis配置
  data:
    redis:
      host: localhost
      port: 6379
      password: 
      database: 0

# 文件上传配置
  servlet:
    multipart:
      max-file-size: 10MB
      max-request-size: 100MB

4. 项目特色功能

RuoYi-Vue-Plus 相比原版 RuoYi 有诸多改进：

技术架构升级：

• 采用 Spring Boot 3.4 + JDK 17/21
• Vue3 + TypeScript + ElementPlus 前端技术栈
• 基于 Sa-Token 的权限认证体系
• Mybatis-Plus ORM 框架支持

分布式支持：

• 原生多租户架构
• 分布式任务调度（SnailJob）
• Redis 分布式缓存和锁
• 多数据源动态管理

企业级功能：

• 完整的权限管理体系
• 代码生成器支持多数据源
• 工作流引擎集成
• 文件存储支持 Minio 和云存储

5. 快速开始

环境要求

• JDK 17 或 21
• MySQL 5.7+
• Redis 5+
• Maven 3.6+

启动步骤

1. 克隆项目：git clone https://gitcode.com/gh_mirrors/ru/RuoYi-Vue-Plus
2. 导入数据库脚本：script/sql/ry_vue_5.X.sql
3. 修改数据库配置：ruoyi-admin/src/main/resources/application-dev.yml
4. 启动后端服务：运行 DromaraApplication.java
5. 启动前端项目（需单独下载）

项目部署

项目支持多种部署方式：

• 传统 Jar 包部署
• Docker 容器化部署
• Kubernetes 集群部署

详细部署文档请参考项目内的部署指南。

6. 开发建议

1. 代码规范：项目严格遵守 Alibaba 代码规范
2. 模块化开发：按照业务功能划分模块开发
3. 多租户设计：充分考虑租户数据隔离
4. 性能优化：合理使用缓存和异步处理
5. 安全考虑：做好数据加密和权限控制

RuoYi-Vue-Plus 提供了完整的企业级开发解决方案，适合中大型项目的快速开发和部署。