一、RuoYi-Vue3项目模块化架构与二次开发实战

1. RuoYi-Vue3模块化架构深度解析第一次接触RuoYi-Vue3时最让我惊艳的就是它清晰的模块化设计。这个基于Spring BootVue3的前后端分离框架通过六大核心模块的巧妙组合既保证了功能完整性又为二次开发留足了空间。就像搭积木一样每个模块都有明确的职责边界开发者可以快速定位功能代码所在位置。先来看最关键的ruoyi-admin模块它是整个系统的门户。我习惯把它比作酒店的前台所有外部请求都要经过这里处理。实测下来这个模块主要做三件事提供RESTful接口、处理权限校验、管理全局异常。有趣的是它虽然身处顶层但具体业务逻辑都委托给了其他模块这种设计让系统层次特别清晰。ruoyi-framework则是整个项目的骨架。记得我第一次修改JWT token有效期时就是在这里找到的安全配置类。这个模块打包了Spring Security、Redis缓存、AOP日志等基础能力相当于给项目装上了标准件。有个小技巧当需要扩展认证方式比如加个短信登录时优先考虑在这里新增组件。最实用的要数ruoyi-common它就像开发者的工具箱。上周我还用其中的Excel工具类快速实现了报表导出功能。这个模块的亮点在于完全独立——不依赖其他任何模块甚至可以直接复制到别的项目中使用。建议二次开发时先看看这里有没有现成的轮子能省下不少重复编码时间。2. 模块依赖关系与POM配置实战模块间的依赖关系是理解RuoYi架构的关键。通过分析父POM的modules标签我发现整个项目采用经典的倒金字塔结构!-- 父pom.xml片段 -- modules moduleruoyi-admin/module moduleruoyi-framework/module moduleruoyi-system/module moduleruoyi-quartz/module moduleruoyi-generator/module moduleruoyi-common/module /modules实际开发中遇到过这样的场景需要在定时任务里调用系统服务。这时就必须在ruoyi-quartz的pom中添加对ruoyi-system的依赖!-- ruoyi-quartz/pom.xml -- dependencies dependency groupIdcom.ruoyi/groupId artifactIdruoyi-system/artifactId /dependency /dependencies有个容易踩的坑是版本号管理。RuoYi在父POM中使用dependencyManagement统一管控版本比如properties ruoyi.version3.9.0/ruoyi.version druid.version1.2.8/druid.version /properties dependencyManagement dependencies dependency groupIdcom.ruoyi/groupId artifactIdruoyi-framework/artifactId version${ruoyi.version}/version /dependency /dependencies /dependencyManagement这意味着子模块引用时不需要指定版本号但如果你私自修改某个依赖版本很可能会引发兼容性问题。我建议非必要不覆盖父POM的版本定义。3. 创建新模块的完整流程最近给客户做会员管理系统时我决定将积分功能独立成ruoyi-points模块。整个过程比想象中简单第一步在IDEA中右键项目 - New - Module选择Maven架构。关键是要正确设置父项目!-- ruoyi-points/pom.xml -- parent groupIdcom.ruoyi/groupId artifactIdruoyi/artifactId version${ruoyi.version}/version /parent第二步在父POM的modules中添加新模块。这里有个细节模块声明的顺序会影响编译顺序建议把自定义模块放在官方模块之后。第三步配置模块依赖。比如我的积分模块需要用到系统用户数据就需要dependencies !-- 基础框架 -- dependency groupIdcom.ruoyi/groupId artifactIdruoyi-framework/artifactId /dependency !-- 系统服务 -- dependency groupIdcom.ruoyi/groupId artifactIdruoyi-system/artifactId /dependency /dependencies最后别忘了在ruoyi-admin中引入新模块否则前端无法访问到新增的API!-- ruoyi-admin/pom.xml -- dependency groupIdcom.ruoyi/groupId artifactIdruoyi-points/artifactId /dependency实测发现模块化开发最大的优势是热部署效率。修改ruoyi-points的代码后只需重新编译该模块不用重启整个应用调试效率提升明显。4. 多环境配置技巧接手过几个RuoYi的部署项目后我总结出一套环境配置的最佳实践。核心是通过application-{profile}.ymlMaven Profile实现灵活切换# application.yml spring: profiles: active: profiles.active # 动态注入对应的Maven配置profiles profile iddev/id properties profiles.activedev/profiles.active /properties activation activeByDefaulttrue/activeByDefault /activation /profile profile idprod/id properties profiles.activeprod/profiles.active /properties /profile /profiles生产环境打包时使用命令mvn clean package -Pprod对于文件存储路径这种环境差异项可以用variable占位符ruoyi: profile: ruoyi.profile然后在Maven Profile中定义具体值profile idprod/id properties ruoyi.profile/data/upload/ruoyi.profile /properties /profile最近遇到个典型问题开发环境用Windows路径(F:\upload)生产环境用Linux路径(/data/upload)。通过这种配置方式完美解决再也不用每次部署都手动改配置文件了。5. 二次开发中的避坑指南在多个RuoYi项目中摸爬滚打后我整理出这些实用经验数据库兼容性当需要适配国产数据库时建议在ruoyi-framework模块中扩展方言配置。比如金仓数据库需要这样修改// 自定义方言类 public class KingbaseDialect extends PostgreSQLDialect { Override public String getSequenceNextValString(String sequenceName) { return select nextval( sequenceName ); } } // 配置类修改 Bean public JpaVendorAdapter jpaVendorAdapter() { HibernateJpaVendorAdapter adapter new HibernateJpaVendorAdapter(); adapter.setDatabasePlatform(KingbaseDialect.class.getName()); return adapter; }代码生成器优化ruoyi-generator模块的模板文件在src/main/resources/vm下。我通常会做这些定制修改domain.java.vm增加Swagger注解调整mapper.xml.vm优化查询字段顺序在controller.java.vm中加入操作日志注解前端联调技巧Vue3版本采用TypeScript组合式API建议在api/目录下为每个后端模块创建对应的TS文件。例如积分模块对应points.ts// src/api/points.ts import request from /utils/request export function listPoints(params: any) { return request({ url: /points/list, method: get, params }) }性能监控可以在ruoyi-admin中添加Spring Boot Actuator端点配合Prometheus实现监控!-- 添加依赖 -- dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-actuator/artifactId /dependency dependency groupIdio.micrometer/groupId artifactIdmicrometer-registry-prometheus/artifactId /dependency# application.yml management: endpoints: web: exposure: include: health,info,prometheus metrics: tags: application: ${spring.application.name}