How lerry903/ruoyi works
Project Type and Purpose
• This is a full-stack, modular, monolithic web application built with Spring Boot.
• Purpose: a generic, extensible “后台管理系统” (back-office management system) supporting user/role/dept/menu management, logging, scheduled jobs, code generation, server monitoring, etc.
High-Level Module Analysis
• Multi-module Maven project:
• ruoyi-admin: Spring Boot web application (controllers, Thymeleaf templates, static assets)
• ruoyi-system: Domain models, MyBatis mappers, system service implementations
• ruoyi-quartz: Quartz scheduler module (job config, domain, mappers, service)
• ruoyi-generator: Code-generation module (reads DB metadata, Velocity templates, produces Java/HTML/XML/SQL)
• ruoyi-framework: Cross-cutting concerns (AOP aspects, security via Shiro, dynamic data source, global exception handling, filters)
• ruoyi-common: Shared annotations, utils, exception classes, constants, JSON support, pagination, XSS filters
• Top-level: Dockerfile, pom.xml, SQL scripts (schema/seeds), images and documentation.
Core Architectural Layers and Components
a. Presentation Layer
• Browser clients (desktop/mobile)
• Static resources: JavaScript/CSS libraries under ruoyi-admin/src/main/resources/static
• Thymeleaf templates under ruoyi-admin/src/main/resources/templates
• Swagger UI (generated API docs)
b. Web & Controller Layer
• Spring MVC controllers in ruoyi-admin/src/main/java/com/ruoyi/web/controller
• Interceptors (LoginAuthInterceptor), argument resolvers (LoginUserArgumentResolver) via ruoyi-admin → ruoyi-framework
c. Service Layer
• ruoyi-system and ruoyi-quartz implement business logic via service interfaces (ISysUserService, ISysJobService, etc.)
• ruoyi-generator service (IGenService) reads DB metadata and drives template engine
• Cross-cutting: AsyncManager, logging aspects, data-scope aspects in ruoyi-framework
d. Persistence Layer
• MyBatis mappers in ruoyi-system and ruoyi-quartz modules
• DynamicDataSource managing multiple DBs (dev/run/uat profiles) via ruoyi-framework
• Caching via Ehcache (ehcache-shiro.xml)
e. Scheduler & Batch
• Quartz jobs configured in ruoyi-quartz (ScheduleConfig, CronUtils, AbstractQuartzJob)
f. Security & Cross-Cutting
• Apache Shiro (realm, filters, session management) in ruoyi-framework
• AOP aspects: @Log, @DataScope, @DataSource switching
• Global exception handler, JSON util, XSS filter
g. Database
• MySQL (or any JDBC) using scripts in sql/ directory
• Tables for users, roles, menus, jobs, logs, etc.
Relationships and Data Flow
• Browser → HTTP request → DispatcherServlet (Spring MVC)
• Request passes through Shiro filters → Interceptors → Controller
• Controller invokes service layer → AOP aspects apply (logging, data-scope, transaction)
• Service calls MyBatis mapper → SQL → DB
• Response propagates back through same chain → view resolver (Thymeleaf) or JSON output
• Scheduled tasks run independently via Quartz scheduler bean
• Code generator module called via “在线构建器” controller, reads DB metadata, applies Velocity templates, returns downloadable code
Architectural Patterns & Design Principles
• Layered MVC architecture
• Modular monolith (clear separation of concerns into modules)
• AOP for cross-cutting concerns (logging, security, dynamic data source, exception handling)
• DAO pattern via MyBatis mappers
• Template-based code generation
• Pluggable scheduler via Quartz
• Dynamic configuration via Spring profiles (dev/run/uat) and application.yml