# xwh-cms-cloud

**Repository Path**: githaohao/xwh-cms-cloud

## Basic Information

- **Project Name**: xwh-cms-cloud
- **Description**: 打造全栈通用架构方案
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-16
- **Last Updated**: 2025-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CMS - 企业级微服务后台管理系统

[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.2.5-brightgreen.svg)](https://spring.io/projects/spring-boot)
[![Spring Cloud](https://img.shields.io/badge/Spring%20Cloud-2023.0.1-blue.svg)](https://spring.io/projects/spring-cloud)
[![Spring Cloud Alibaba](https://img.shields.io/badge/Spring%20Cloud%20Alibaba-2023.0.1.0-orange.svg)](https://github.com/alibaba/spring-cloud-alibaba)
[![Vue](https://img.shields.io/badge/Vue-3.2.31-green.svg)](https://vuejs.org/)
[![Java](https://img.shields.io/badge/Java-17-red.svg)](https://www.oracle.com/java/)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

## 📖 项目简介

CMS 是一个基于 Spring Cloud Alibaba 微服务架构的企业级后台管理系统，采用前后端分离开发模式。项目集成了最新的技术栈，提供完整的权限管理、数据字典、文件管理、文章管理等功能模块，支持多租户、动态路由、接口权限控制等特性。

## ✨ 主要特性

- 🏗️ **微服务架构**：基于 Spring Cloud Alibaba 构建的分布式微服务系统
- 🔐 **权限控制**：基于 RBAC 模型的细粒度权限控制，支持菜单权限和数据权限
- 🚀 **最新技术栈**：使用 Spring Boot 3.x、Vue 3.x、TypeScript 等最新技术
- 📊 **多租户支持**：内置多租户架构，支持数据隔离
- 🎯 **动态路由**：前端菜单动态路由，支持在线配置
- 🛡️ **接口安全**：支持接口限流、JWT 认证、统一异常处理
- 📱 **响应式设计**：基于 Element Plus 的现代化 UI 界面
- 🔧 **开发友好**：完善的代码生成、API 文档、日志管理

## 🛠️ 技术栈

### 后端技术

| 技术 | 版本 | 说明 |
|------|------|------|
| Spring Boot | 3.2.5 | 基础框架 |
| Spring Cloud | 2023.0.1 | 微服务框架 |
| Spring Cloud Alibaba | 2023.0.1.0 | 微服务生态 |
| Nacos | - | 服务注册与配置中心 |
| Sentinel | - | 流量控制与熔断降级 |
| Spring Gateway | - | API 网关 |
| MyBatis Plus | 3.5.7 | ORM 框架 |
| MySQL | 8.x | 数据库 |
| Redis | - | 缓存中间件 |
| JWT | - | 身份认证 |
| Knife4j | 4.4.0 | API 文档 |
| FastJSON | 2.0.25 | JSON 处理 |
| Hutool | - | 工具类库 |

### 前端技术

| 技术 | 版本 | 说明 |
|------|------|------|
| Vue | 3.2.31 | 前端框架 |
| TypeScript | 4.6.2 | 类型支持 |
| Element Plus | 2.1.4 | UI 组件库 |
| Vue Router | 4.x | 路由管理 |
| Vuex | 4.0.2 | 状态管理 |
| Vite | 2.8.6 | 构建工具 |
| Axios | 1.7.4 | HTTP 客户端 |
| ECharts | 5.3.1 | 图表库 |

## 🏗️ 项目结构

```
cms-xwh-cloud/
├── XwhBoot/                    # 核心模块 - 基础配置和工具类
├── cms-system/                 # 系统管理模块 - 用户权限管理
├── cms-gateway/                # 网关模块 - API 网关服务
├── cms-article/                # 文章模块 - 内容管理系统
├── cms-article-web/           # 文章前端展示
├── cms-admin-web/             # 后台管理前端
├── cms-file/                  # 文件管理模块
├── cms-wechat/                # 微信相关模块
├── cms-monitor/               # 系统监控模块
├── cms-demo/                  # 示例演示模块
└── pom.xml                    # 父级 Maven 配置
```

## 🚀 快速开始

### 环境要求

- JDK 17+
- Maven 3.6+
- Node.js 16+
- MySQL 8.0+
- Redis 6.0+
- Nacos 2.x

### 后端启动

1. **克隆项目**
```bash
git clone https://github.com/your-repo/cms-xwh-cloud.git
cd cms-xwh-cloud
```

2. **配置数据库**
```sql
-- 创建数据库
CREATE DATABASE cms_system DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
```

3. **配置 Nacos**
- 启动 Nacos 服务
- 导入配置文件到 Nacos 配置中心

4. **启动微服务**
```bash
# 编译项目
mvn clean install

# 启动网关
cd cms-gateway && mvn spring-boot:run

# 启动系统服务
cd cms-system && mvn spring-boot:run

# 启动文章服务
cd cms-article && mvn spring-boot:run
```

### 前端启动

```bash
# 进入前端目录
cd cms-admin-web

# 安装依赖（推荐使用 pnpm）
pnpm install

# 启动开发服务器
pnpm dev
```

## 📚 功能模块

### 系统管理
- **用户管理**：用户信息维护、状态管理
- **角色管理**：角色权限分配、数据权限控制
- **菜单管理**：动态菜单配置、权限控制
- **部门管理**：组织架构管理
- **字典管理**：系统字典维护

### 内容管理
- **文章管理**：文章发布、编辑、审核
- **分类管理**：文章分类管理
- **标签管理**：文章标签维护
- **文件管理**：文件上传、存储管理

### 系统监控
- **在线用户**：当前在线用户监控
- **系统日志**：操作日志记录
- **登录日志**：用户登录记录
- **服务监控**：微服务状态监控

## 🔧 开发说明

### 代码结构

```
src/
├── main/
│   ├── java/
│   │   └── com/xwh/
│   │       ├── core/           # 核心配置
│   │       ├── controller/     # 控制器层
│   │       ├── service/        # 服务层
│   │       ├── entity/         # 实体类
│   │       └── mapper/         # 数据访问层
│   └── resources/
│       ├── application.yml     # 配置文件
│       └── mapper/             # MyBatis 映射文件
```

### 开发规范

- 遵循阿里巴巴 Java 开发手册
- 使用 RESTful API 设计风格
- 统一异常处理和返回格式
- 完善的日志记录和监控

## 📷 系统截图

### 登录页面
![登录页面](docs/images/login.png)

### 主控制台
![主控制台](docs/images/dashboard.png)

### 用户管理
![用户管理](docs/images/user-management.png)

### 权限配置
![权限配置](docs/images/permission.png)

## 🤝 贡献指南

1. Fork 项目
2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 创建 Pull Request

## 📄 开源协议

本项目基于 [MIT](LICENSE) 协议开源，详情请参阅 LICENSE 文件。

## 📞 联系我们

- 作者：xiangwenhao
- 邮箱：[your-email@example.com]
- 项目地址：[https://github.com/your-repo/cms-xwh-cloud]

## ⭐ Star History

如果这个项目对你有帮助，请给一个 ⭐ Star 支持一下！

---

**注意：** 由于项目正在持续开发中，部分功能和文档可能会有更新，请以最新版本为准。