# dev-docs

**Repository Path**: vben-combination/dev-docs

## Basic Information

- **Project Name**: dev-docs
- **Description**: 文档仓库
- **Primary Language**: 其他
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-31
- **Last Updated**: 2026-10-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Vben Combination 项目知识库

> 基于 Vue Vben Admin 5.0 + Spring Boot 3 的企业级管理系统模板

## 文档导航

### 📋 [01-项目概览](./01-项目概览/README.md)
项目背景、定位、核心特性、技术选型理由。适合**初次了解项目**的开发者。

### 🏗️ [02-架构设计](./02-架构设计/)
- [总体架构](./02-架构设计/总体架构.md) — 系统整体架构图、前后端交互方式、部署架构
- [后端架构](./02-架构设计/后端架构.md) — Maven 模块划分、分层架构、依赖关系
- [前端架构](./02-架构设计/前端架构.md) — Monorepo 结构、组件体系、数据流
- [★ 微服务改单体改造方案](./02-架构设计/微服务改单体改造方案.md) — 决策记录：为何采用「模块级拆分 + 部署级单体」（改名与单模块合并未执行）
- [★ 多租户改造方案](./02-架构设计/多租户改造方案.md) — 将模板改造为多租户 SaaS 的完整方案（共享库 + 行级隔离）

### ☕ [03-后端开发](./03-后端开发/)
- [项目结构](./03-后端开发/项目结构.md) — 完整目录树、模块职责说明
- [技术栈详解](./03-后端开发/技术栈详解.md) — 所有依赖框架及版本说明
- [数据库设计](./03-后端开发/数据库设计.md) — 数据表结构、ORM 策略、关联关系
- [认证授权](./03-后端开发/认证授权.md) — Sa-Token 认证流程、RBAC 权限模型、数据权限
- [API 开发规范](./03-后端开发/API开发规范.md) — Controller/Service 编写规范、统一响应格式
- [★ 后端开发规范](./03-后端开发/开发规范.md) — 命名、注解、分层、代码模板等详细规范
- [工作流引擎](./03-后端开发/工作流引擎.md) — Warm-Flow 工作流使用指南
- [通知系统](./03-后端开发/通知系统.md) — 站内信通知架构、SSE 实时推送、跨实例投递

### 🎨 [04-前端开发](./04-前端开发/)
- [项目结构](./04-前端开发/项目结构.md) — 完整目录树、文件说明
- [路由与菜单](./04-前端开发/路由与菜单.md) — 路由配置、动态菜单生成、路由守卫
- [权限控制](./04-前端开发/权限控制.md) — 前后端混合权限模式、按钮级权限
- [主题样式](./04-前端开发/主题样式.md) — 主题切换、样式架构、Design Tokens
- [国际化](./04-前端开发/国际化.md) — i18n 方案、语言包结构
- [API 请求层](./04-前端开发/API请求层.md) — 请求客户端、拦截器、签名机制、Store 缓存策略
- [★ 前端开发规范](./04-前端开发/开发规范.md) — 组件、API、Store、样式等详细规范

### 📖 [05-开发指南](./05-开发指南/)
- [环境搭建](./05-开发指南/环境搭建.md) — 从零搭建开发环境
- [团队协作规范](./05-开发指南/团队协作规范.md) — Git 提交规范、代码检查与格式化、评审关注点（编码规范见 03/04 两篇《开发规范》）
- [常见场景](./05-开发指南/常见场景.md) — 新增页面、新增接口、新增字典等实操指南
- [部署指南](./05-开发指南/部署指南.md) — 构建打包、环境配置、Docker 部署
- [★ 已知问题与设计取舍](./05-开发指南/已知问题与设计取舍.md) — 尚未处置的问题、刻意保持现状的设计取舍、通用工程约束

### 📡 [06-接口文档](./06-接口文档/)
- [API 接口清单](./06-接口文档/API接口清单.md) — 所有后端 API 接口列表

---

## 技术栈速览

| 层级 | 技术 | 版本 |
|------|------|------|
| **前端框架** | Vue 3 + TypeScript | Vue ^3.5.40 / TS ^6.0.3 |
| **UI 组件库** | Ant Design Vue Next | 最新 |
| **构建工具** | Vite + pnpm (Monorepo) | - |
| **状态管理** | Pinia | 最新 |
| **后端框架** | Spring Boot 3 | 基于 continew-starter 2.15.0-sb3 |
| **Java** | JDK 21 | - |
| **ORM** | MyBatis-Plus + 动态数据源 | 3.x |
| **认证** | Sa-Token (Redis) | 1.x |
| **数据库** | MySQL | 8.x |
| **缓存** | Redis + Redisson | 7.x |
| **工作流** | Warm-Flow | 1.8.9 |
| **文件存储** | X-File-Storage (S3/RustFS/本地) | 2.x |

## 快速开始

```bash
# 前端
cd vue-vben-admin
pnpm install
pnpm dev          # 访问 http://localhost:5999

# 后端
cd vben-backend-cloud
mvn clean install -DskipTests
# 启动 vben-backend-system-server (需先配置 MySQL + Redis)
```

## 项目仓库

- 前端: [vbenjs/vue-vben-admin](https://github.com/vbenjs/vue-vben-admin)
- 后端: 基于 continew-starter 定制开发