# zyf-cms

**Repository Path**: zyf_0909/zyf-cms

## Basic Information

- **Project Name**: zyf-cms
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-06
- **Last Updated**: 2026-06-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🏘️ zyfCMS — 社区内容管理系统

> **Spring Boot 3 + Vue 3 + MyBatis Plus 全栈项目 | 模块化单体架构**

---

## 一、项目简介

zyfCMS 是一个面向技术社区的**内容管理系统**，支持 Markdown 文章发布、盖楼评论、点赞收藏、用户关注、全文检索、AI 辅助创作等核心功能。项目采用**模块化单体架构**，模块间通过接口调用。

| 维度 | 说明 |
|------|------|
| **架构风格** | 模块化单体（Modular Monolith） |
| **适用场景** | 技术博客社区 / 企业内部知识库 / 垂直领域论坛 |
| **后端** | Spring Boot 3.2.6 + MyBatis Plus 3.5.7 + Spring Security 6.x + JWT |
| **前端** | Vue 3.4 + Vite 5 + Pinia 2 + Element Plus 2.7 + TypeScript 5 |
| **数据库** | MySQL 8.0 + Flyway 版本迁移 |
| **缓存** | Redis 7.x |
| **部署** | Docker Compose 一键部署（MySQL + Redis + Backend + Nginx） |

---

## 二、项目演示

### 2.1 文章列表

![](./images/home.png)

### 2.2 文章点赞评论

![](./images/comment.png)

### 2.3 消息通知

![](./images/notification.png)

### 2.4 管理员系统——数据可视化

![](./images/echarts_1.png)

![](./images/echarts_2.png)

### 2.5 个人中心

![](./images/user_center.png)

## 三、项目架构

### 3.1 系统架构

```
┌──────────────────────────────────────────────────────┐
│                  Vue 3 前端 (zyf-cms-web)              │
│            Nginx（反向代理 + 静态资源 + SPA）            │
├──────────────────────────────────────────────────────┤
│                 Controller 层（REST API）              │
│           参数校验（Jakarta Validation）+ 权限注解       │
├──────────────────────────────────────────────────────┤
│                  Service 层（业务逻辑）                 │
│        事务管理（@Transactional）+ 缓存策略 + AI 调用    │
├──────────────────────┬───────────────────────────────┤
│   MyBatis Plus (ORM) │   Redis（缓存 / 浏览量计数）     │
├──────────────────────┴───────────────────────────────┤
│              MySQL 8.0（主数据库 + Flyway 迁移）        │
└──────────────────────────────────────────────────────┘
```

### 3.2 业务架构

```
┌──────────────────────────────────────────────────┐
│                zyfCMS 业务模块                      │
├─────────────┬─────────────┬──────────────────────┤
│  用户系统    │  内容管理    │     社交互动           │
├─────────────┼─────────────┼──────────────────────┤
│ · 注册/登录  │ · Markdown  │ · 盖楼评论（path 路径树）│
│ · JWT 双Token│   编辑器    │ · 点赞/取消（幂等设计）   │
│ · 个人信息    │ · 草稿/发布  │ · 收藏夹               │
│ · 头像上传    │ · 标签分类  │ · 关注/取关             │
│ · BCrypt 加密 │ · 全文搜索  │ · 消息通知             │
├─────────────┴─────────────┼──────────────────────┤
│       管理员系统            │     AI 辅助            │
│ · 仪表盘统计（ECharts）     │ · 续写/润色/摘要/标题   │
│ · 用户管理（封禁/解禁）      │ · SSE 流式推送         │
│ · 文章管理（管理员删除）      │ · DeepSeek API 集成    │
│ · 操作日志                 │                      │
│ · PV/UV 访问统计           │                      │
└───────────────────────────┴──────────────────────┘
```

---

## 四、目录结构

```
zyf-cms/
├── README.md
├── CLAUDE.md                              # AI 协作规范
│
├── docker/                                # Docker 部署
│   ├── docker-compose.yml                 # 4 服务编排（MySQL/Redis/Backend/Nginx）
│   ├── .env.example
│   ├── backend/Dockerfile                 # 后端多阶段构建（Maven → JRE 21）
│   └── frontend/
│       ├── Dockerfile                     # 前端多阶段构建（Node → Nginx）
│       └── default.conf                   # Nginx 配置（反向代理 + SPA）
│
├── zyf-cms-server/                        # Maven 根工程
│   ├── pom.xml                            # 根 POM（依赖管理与版本控制）
│   ├── zyf-common/                        # 公共模块（无数据库依赖）
│   │   └── src/.../common/
│   │       ├── constant/   Constants.java
│   │       ├── exception/  BusinessException + GlobalExceptionHandler
│   │       ├── result/     R.java         # 统一响应体
│   │       └── enums/      ArticleStatusEnum
│   └── zyf-api/                           # 主应用（全部业务+配置）
│       └── src/main/
│           ├── java/com/zyf/
│           │   ├── ZyfCmsApplication.java
│           │   ├── config/                # Security / JWT / MyBatisPlus / Redis / Knife4j
│           │   ├── controller/            # system/ article/ comment/ search/ + UploadController
│           │   ├── entity/                # system/ article/ comment/
│           │   ├── mapper/                # system/ article/ comment/
│           │   ├── service/               # system/ article/ comment/ search/ ai/ + impl/
│           │   └── dto/                   # system/ article/ comment/ (DTO + VO)
│           └── resources/
│               ├── application.yml        # 公共配置
│               ├── application-dev.yml    # 开发环境
│               ├── application-prod.yml   # 生产环境（环境变量占位符）
│               └── db/migration/          # Flyway 迁移（V1~V3）
│
└── zyf-cms-web/                           # Vue 3 前端
    ├── vite.config.ts                     # 构建配置 + /api 代理
    └── src/
        ├── main.ts                        # 入口（注册 v-md-editor 等插件）
        ├── api/     request.ts, auth.ts, article.ts, comment.ts, user.ts ...
        ├── store/   user.ts               # Pinia 状态管理（token 持久化）
        ├── router/  index.ts              # 懒加载路由 + beforeEach 鉴权守卫
        ├── views/
        │   ├── Layout.vue                 # 主布局
        │   ├── auth/        Login.vue
        │   ├── admin/       Dashboard / ArticleManagement / UserManagement
        │   ├── article/     ArticleList / ArticleEditor / ArticleDetail / SearchResult
        │   ├── notification/ NotificationList
        │   └── user/        UserCenter / Profile
        └── components/ CommentTree.vue    # 递归评论树组件
```

---

## 五、技术选型

| 层级 | 技术 | 版本 | 说明 |
|------|------|------|------|
| **框架** | Spring Boot | 3.2.6 | 基础框架，Java 17 编译 |
| **ORM** | MyBatis Plus | 3.5.7 | Lambda 条件构造、分页插件、自动填充、逻辑删除 |
| **安全** | Spring Security + jjwt | 6.x / 0.12.6 | 无状态 JWT 认证（Access + Refresh 双 Token） |
| **数据库** | MySQL | 8.0 | InnoDB，utf8mb4，含 FULLTEXT 全文索引 |
| **迁移** | Flyway | 10.x | 自动版本管理，3 个迁移文件 |
| **缓存** | Redis | 7.x | 浏览量计数 |
| **API 文档** | Knife4j（OpenAPI 3） | 4.5.0 | 自动生成 + 在线调试 |
| **工具库** | Lombok + Hutool + MapStruct | — | 代码简化 + 工具集 + 对象映射 |
| **AI 集成** | DeepSeek API（SSE 流式） | — | JDK HttpClient 调用，异步流式推送 |
| **前端** | Vue 3 + Vite 5 + Pinia 2 | 3.4 / 5.x / 2.x | Composition API + TypeScript |
| **UI** | Element Plus | 2.7.x | 组件库 |
| **图表** | ECharts | 5.x | 管理后台统计图表 |
| **部署** | Docker Compose | 3.9 | MySQL + Redis + Backend + Nginx 四服务编排 |

---

## 六、部署流程

### 方式一：Docker Compose 一键部署（推荐）

```bash
cd docker
cp .env.example .env          # 按需修改 JWT_SECRET 等配置
docker-compose up -d --build  # 构建并启动全部服务
```

启动后访问：

| 服务 | 地址 |
|------|------|
| 前端页面 | http://localhost |
| API 文档 | http://localhost/swagger-ui.html |

**默认管理员：** `admin` / `admin123`

### 方式二：手动启动（开发调试）

前置条件：JDK 21、Maven 3.9+、Node.js 22+、MySQL 8.0、Redis 7.x

```bash
# 1. 启动中间件（或使用已有实例）
docker run -d --name zyf-mysql -p 3306:3306 \
  -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=zyf_cms mysql:8.0
docker run -d --name zyf-redis -p 6379:6379 redis:7-alpine

# 2. 启动后端（8080 端口，Flyway 自动建表迁移）
cd zyf-cms-server
mvn clean install -DskipTests
cd zyf-api
mvn spring-boot:run -Dspring-boot.run.profiles=dev

# 3. 启动前端（5173 端口，Vite 代理 /api → 8080）
cd zyf-cms-web
npm install
npm run dev
```

### Docker 服务拓扑

```
用户浏览器 :80
    │
    ▼
Nginx (Alpine)
    ├── /           → 前端静态文件（SPA 回退）
    ├── /api/*      → backend:8080（反向代理）
    ├── /uploads/*  → 共享卷（静态文件直接返回）
    └── /swagger-ui.html → backend:8080
         │
         ▼
    Backend (Spring Boot 3 + JDK 21)
         ├── MySQL:3306（Flyway 自动迁移）
         └── Redis:6379（缓存）
```