# onlineDocs-backend

**Repository Path**: qiaoweiye/online-docs-backend

## Basic Information

- **Project Name**: onlineDocs-backend
- **Description**: 在线文档编辑平台，支持多人实时协作编辑文档。
功能：
实时同步：确保所有用户的编辑操作能够实时同步。
权限管理：不同用户可以有不同的编辑权限。
历史版本：记录文档的编辑历史，支持版本回溯。
模板库：提供多种文档模板供用户选择。
AI 帮写：输入提示词AI帮写文档内容
添加下载功能：三种不同格式文件
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-06-17
- **Last Updated**: 2025-10-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 在线文档协作系统（OnlineDocs）

## 项目介绍

在线文档系统是一个基于SpringBoot开发的协同文档编辑平台，支持多人实时协作编辑、文档版本管理、权限控制等功能，为团队协作提供高效的文档管理解决方案。

## 功能特点(页面展示）
![输入图片说明](https://foruda.gitee.com/images/1750938093955751865/f1fa6a61_15166222.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1750938102032966737/6f14c038_15166222.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1750938114276787150/6a86129c_15166222.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1750938139755389269/ff1f89ba_15166222.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1750938146641199863/121fa111_15166222.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1750938156395356392/fbb6d225_15166222.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1750938165738111615/8145d5c5_15166222.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1750938172070356508/2dc431fb_15166222.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1750938178472114686/cd925460_15166222.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1750938186674331230/64a1ee65_15166222.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1750938208219819581/8225ea4a_15166222.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1750938224899141888/0c7669e1_15166222.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1750938231199096430/a2d6e170_15166222.png "屏幕截图")

### 用户管理
- 用户注册与登录
- 用户信息管理
- 基于角色的权限控制

### 文档管理
- 文档创建、编辑、删除
- 文档分类与搜索
- 文档状态管理（草稿/已发布）
- 文档封面设置

### 文档版本管理
- 版本历史记录
- 版本对比功能
- 版本回滚支持
- 最新版本快速获取

### 文档协作
- 基于WebSocket的实时协作编辑
- 文档权限分配（查看者/编辑者/管理员）
- 协作冲突解决机制

### 文档模板
- 预设文档模板
- 自定义模板创建与管理
- 模板分类

## 技术栈

### 后端技术
- **基础框架**：Spring Boot 2.7.2
- **ORM框架**：MyBatis-Plus 3.5.2
- **数据库**：MySQL
- **缓存**：Redis
- **实时通信**：WebSocket
- **API文档**：Knife4j (Swagger增强)
- **AI能力**：火山引擎DeepSeek

## 项目结构

```
onlineDocs-backend/
├── src/
│   ├── main/
│   │   ├── java/com/yqw/onlineDocs/
│   │   │   ├── aop/             # 切面相关代码
│   │   │   ├── common/          # 通用类
│   │   │   ├── config/          # 配置类
│   │   │   ├── constant/        # 常量定义
│   │   │   ├── controller/      # 控制器
│   │   │   ├── exception/       # 异常处理
│   │   │   ├── manager/         # 业务管理层
│   │   │   ├── mapper/          # MyBatis映射器
│   │   │   ├── model/           # 数据模型
│   │   │   │   ├── dto/         # 数据传输对象
│   │   │   │   ├── entity/      # 实体类
│   │   │   │   └── vo/          # 视图对象
│   │   │   ├── service/         # 服务层
│   │   │   └── utils/           # 工具类
│   │   └── resources/           # 资源文件
│   └── test/                    # 测试代码
├── sql/                         # SQL脚本
└── pom.xml                      # 项目依赖
```

## 数据库设计

系统包含以下主要数据表：

- **user**：用户信息表
- **document**：文档表
- **document_user**：文档权限关联表
- **document_version**：文档版本历史表
- **document_template**：文档模板表

## 快速开始

### 环境要求
- JDK 17+
- Maven 3.6+
- MySQL 5.7+

### 本地开发环境搭建

1. 克隆代码
```bash
git clone https://gitee.com/your-username/onlineDocs.git
cd onlineDocs/onlineDocs-backend
```

2. 创建数据库
```sql
create database online_docs;
```

3. 执行SQL脚本
```bash
mysql -u your_username -p online_docs < sql/create_doc_tables.sql
```

4. 修改配置文件

复制`application.yml`为`application-local.yml`，并根据本地环境修改数据库、Redis等配置。

5. 编译运行
```bash
mvn clean package -DskipTests
java -jar target/onlineDocs-0.0.1-SNAPSHOT.jar --spring.profiles.active=local
```

### Docker部署

```bash
# 构建镜像
docker build -t online-docs:latest .

# 运行容器
docker run -d -p 8080:8080 --name online-docs online-docs:latest
```

## 性能指标

根据性能测试结果，系统具有以下性能特点：

- 支持30+用户/秒的注册请求
- 支持25+文档/秒的创建请求
- 查询操作吞吐量可达180+请求/秒
- 大文档处理能力约为0.67MB/s