RuoYi-Cloud-Plus Documentation

The ruoyi-gateway service is a Servlet MVC implementation of spring-cloud-gateway.

Performance Note: To achieve optimal performance, it is highly recommended to run this service using JDK 21 with Virtual Threads enabled. Running this service on JDK 17 may result in significantly lower performance compared to the original Spring Cloud Gateway implementation.

The ruoyi-test-mq module provides testing implementations for the following message queue technologies:

• RabbitMQ: Supports normal messages and delay queues.
• RocketMQ: Supports normal messages, transactional messages, and delay messages.
• Kafka: Supports normal messages.

The framework leverages MyBatis-Plus to reduce manual SQL writing and enhance data management:

• CRUD: Perform almost all operations using pure Java objects.
• Plugins: Includes built-in support for Multi-tenancy, Pagination, and Optimistic Locking.
• Data Permissions: Uses a MyBatis-Plus plugin to perform seamless, transparent SQL filtering based on Mapper annotations (supporting custom logic beyond just department/role).
• Pagination: Uses an extended MyBatis-Plus pagination plugin that supports object-oriented pagination, multiple parameter types, and complex multi-field sorting.

RuoYi-Cloud-Plus provides several automated data handling mechanisms using annotations:

• Data Masking: Uses annotations + Jackson serialization to mask sensitive data (e.g., ID cards, phone numbers, emails, bank cards) based on different module strategies.
• Data Encryption/Decryption: Uses annotations + MyBatis interceptors to automatically encrypt/decrypt data during storage and retrieval. Supported strategies include BASE64, AES, RSA, SM2, and SM4.
• Data Translation: Uses annotations + Jackson serialization to dynamically translate data during serialization using mapping or custom interface-based logic.

The framework uses dynamic-datasource to manage heterogeneous databases.

• Configuration: Manage different database types via yml configuration.
• Dynamic Switching: Supports switching data sources at runtime using SpEL expressions based on request headers or other parameters.
• Transactions: Supports distributed transactions across different types of databases via dynamic-datasource.
• UI Management: Allows adding data sources through a frontend interface.

RuoYi-Cloud-Plus uses Sa-Token for lightweight, low-coupling authentication and authorization. It supports various validation types via annotations, including:

• Login validation
• Role validation
• Permission validation
• Two-level authentication
• HttpBasic validation
• Ignore validation

Unlike standard RuoYi, Sa-Token supports complex logical expressions for role and permission checks, such as AND, OR, or combinations like Permission OR Role.

When using the Docker-based RabbitMQ setup, you must grant read and write permissions to the data directory to ensure RabbitMQ can persist data. If permissions are not set correctly, the service will fail to write data.

Execute the following command on the host machine to grant full permissions to the directory:

chmod 777 /docker/rabbitmq/data

You can generate monitoring dashboards in Grafana by importing the JSON configuration files located in this directory. The available dashboards cover Spring Boot statistics, JVM metrics, and Nacos metrics.

Available Dashboards

To ensure the RocketMQ Broker can write data successfully, you must grant read and write permissions to the store directory. If permissions are not set correctly, the broker will fail to write data.

Execute the following command on the host machine to grant full permissions to the directory:

chmod 777 /docker/rocketmq/broker1/store