# plus-doc

**Repository Path**: hutao-xwx/plus-doc

## Basic Information

- **Project Name**: plus-doc
- **Description**: RuoYi-Vue-Plus 与 RuoYi-Cloud-Plus 文档
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 278
- **Created**: 2025-11-21
- **Last Updated**: 2025-11-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RuoYi-Cloud-Plus 文档

## 项目简介

RuoYi-Cloud-Plus 是一个基于 Spring Cloud Alibaba 的微服务快速开发框架，旨在为企业级开发者提供高效、稳定的微服务解决方案。该框架重写了 RuoYi-Cloud，提供了全方位的升级和改进，支持现代微服务架构的最佳实践。

## 主要特性

- **微服务架构**：基于 Spring Cloud Alibaba，支持 Nacos、Sentinel、Seata 等组件，提供服务注册发现、配置管理、服务熔断等功能。
- **多租户支持**：内置多租户管理功能，适用于 SaaS 场景。
- **权限控制**：支持基于角色的权限管理和数据权限控制。
- **代码生成**：提供代码生成工具，支持快速生成前后端代码。
- **分布式事务**：集成 Seata，支持分布式事务处理。
- **可观测性**：支持 SkyWalking、Prometheus + Grafana 等监控方案。
- **扩展性强**：支持多数据源、缓存、消息队列（如 RocketMQ、Kafka）等扩展功能。

## 项目结构

```
ruoyi-cloud-plus/
├── changlog.md                // 更新日志
├── framework/                 // 核心框架文档
│   ├── architecture_diagram.md // 架构图
│   ├── association/            // 关联文档（国际化、文档管理等）
│   ├── basic/                  // 基础功能文档（权限、数据权限、用户管理等）
│   ├── explain/                // 使用说明（事务、主键、单元测试等）
│   ├── extend/                 // 扩展功能文档（缓存、数据加密、多数据源等）
│   └── tree.md                 // 项目结构说明
├── extend-function/           // 扩展功能文档（ELK、ES、Kafka、Nacos 等）
├── quickstart/                // 快速入门指南
│   ├── deploy.md              // 应用部署指南
│   ├── idea_environment.md    // IDEA 环境配置
│   ├── init.md                // 项目初始化
│   └── snail_job_init.md      // SnailJob 任务调度中心配置
├── questions/                 // 常见问题解答
└── home.md                    // 平台简介
```

## 快速开始

### 环境准备

- JDK 17+
- Maven 3.8+
- Nacos 2.0+
- Redis 6.0+
- MySQL 8.0+

### 项目初始化

1. 克隆项目：

   ```bash
   git clone https://gitee.com/dromara/RuoYi-Cloud-Plus.git
   ```

2. 导入 SQL 脚本：

   ```bash
   cd RuoYi-Cloud-Plus
   # 执行数据库初始化脚本
   ```

3. 启动 Nacos：

   ```bash
   # 使用内置 Nacos 或自建
   ```

4. 启动 Seata：

   ```bash
   # 使用内置 Seata 或自建
   ```

5. 启动服务：

   ```bash
   mvn clean install
   cd ruoyi-cloud-plus
   mvn spring-boot:run
   ```

### 访问地址

默认访问地址：`http://localhost:80`

## 文档导航

- [微服务架构设计](framework/architecture_diagram.md)
- [多租户管理](framework/basic/tenant.md)
- [权限控制](framework/basic/permissions_control.md)
- [数据权限](framework/basic/permissions.md)
- [代码生成](framework/basic/code_generate.md)
- [分布式事务](framework/explain/transaction.md)
- [监控与可观测性](extend-function/prometheus_grafana.md)
- [扩展功能](extend-function/elk.md)

## 贡献代码

我们欢迎社区贡献！请参考以下文档了解如何参与贡献：

- [参与贡献的方式](common/contribution.md)
- [如何提交 PR 贡献代码](common/pr.md)

## 常见问题

- [无法读取 Nacos 配置](questions/nacos_read_fail.md)
- [Redis 报错 Permission denied](questions/permission_denied.md)
- [如何使用 Tomcat](questions/use_tomcat.md)
- [国产数据库对接](questions/domestic_databases.md)

## 联系我们

- **作者博客**: [狮子领域 程序圈](https://lionli.blog.csdn.net/?type=blog)
- **微信公众号**: 狮子领域 程序圈
- **Gitee 仓库**: [RuoYi-Cloud-Plus](https://gitee.com/dromara/RuoYi-Cloud-Plus)

## 捐赠支持

如果您觉得该项目对您有帮助，欢迎捐赠支持作者继续维护和改进。

![捐赠二维码](https://foruda.gitee.com/images/1725259663554875162/bd86a165_1766278.png)

## Dromara 全家福

社区仓库地址: [dromara 开源社区](https://gitee.com/organizations/dromara/projects)

---

感谢您的关注与支持！我们期待您的参与和反馈。