# database-document-springboot

**Repository Path**: liuchanghua/database-document-springboot

## Basic Information

- **Project Name**: database-document-springboot
- **Description**: 一个现代化的数据库文档自动生成工具，支持多种数据源，一键生成专业的数据库文档。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 8
- **Forks**: 6
- **Created**: 2025-10-24
- **Last Updated**: 2025-11-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 📊 数据库文档生成器

一个现代化的数据库文档自动生成工具，支持多种数据源，一键生成专业的数据库文档。

## ✨ 项目特色

### 🎯 核心功能
- **🔗 多数据源支持** - MySQL、PostgreSQL及SQL文件导入
- **📚 多格式导出** - HTML、Markdown、Word专业文档
- **🎨 精美主题** - 现代化UI设计，专业文档样式
- **⚡ 智能解析** - 自动分析表结构、关系、索引

### 🚀 技术亮点
- **Spring Boot 3** - 现代化Java后端架构
- **Vue 3 + TypeScript** - 响应式前端界面
- **MyBatis Plus** - 高效数据持久层
- **Apache POI** - 专业Word文档生成
- **JWT认证** - 安全的用户认证体系

## 📸 功能演示

### 1. 数据库连接模式
![数据库连接](./images/1.png)
- 支持在线连接数据库
- 实时解析表结构
- 安全加密连接信息

### 2. SQL文件导入
![SQL导入](./images/2.png)
- 直接上传SQL文件
- 智能解析CREATE TABLE语句
- 支持复杂SQL语法

### 3. 多格式导出

#### 3.1 导出 HTML 文档
![导出html](./images/3.png)

#### 3.2 导出 Markdown 文档
![导出Markdown](./images/4.png)
![导出Markdown](./images/5.png)

## 🛠 技术栈

### 后端技术
```xml
<技术栈>
    ├── Spring Boot 3.5.6      - 核心框架
    ├── MyBatis Plus 3.5.7     - ORM增强
    ├── MySQL 8.0              - 数据存储
    ├── JWT                    - 安全认证
    ├── Apache POI             - Office文档
    ├── FreeMarker             - 模板引擎
    └── JSqlParser             - SQL解析
</技术栈>
```

### 前端技术
```javascript
{
    "框架": "Vue 3 + TypeScript",
    "UI库": "Element Plus",
    "状态管理": "Pinia",
    "路由": "Vue Router 4",
    "构建工具": "Vite",
    "HTTP客户端": "Axios"
}
```

## 📁 项目结构

```
database-document-springboot/
├── sql/                  # SQL文件
├── src/main/java/com/document/
│   ├── config/           # 配置类
│   ├── controller/       # 控制器层
│   ├── service/          # 业务逻辑层
│   ├── mapper/           # 数据访问层
│   ├── entity/           # 实体类
│   ├── dto/              # 数据传输对象
│   └── common/           # 通用组件
│   └── filter/           # 过滤器
│   └── handler           # 异常处理
│   └── vo                # 视图对象
├── src/main/resources/
│   └── application.yml   # 应用配置
└── database-document-vue3/
    ├── src/views/        # 页面组件
    ├── src/components/   # 业务组件
    ├── src/stores/       # 状态管理
    ├── src/api/          # 接口管理
    ├── src/types/        # TypeScript类型
    ├── src/router/       # 路由配置
    └── src/styles/       # 样式文件
```

## 🚀 快速开始

### 环境要求
- JDK 17+
- MySQL 8.0+
- Maven 3.6+
- Node.js 20+

### 后端启动
```bash
# 克隆项目
git clone https://gitee.com/liuchanghua/database-document-springboot.git

# 导入sql

# 连接数据库，启动即可
```

### 前端启动

```bash
# 克隆项目
git clone https://gitee.com/liuchanghua/database-document-vue3.git

# 安装依赖
npm install

# 启动开发服务器
npm run dev
```

## 📖 使用指南

### 1. 数据库连接模式
```sql
-- 输入数据库连接信息
主机: localhost
端口: 3306
数据库: your_database
用户名: root
密码: ******
```

### 2. SQL文件模式
```sql
-- 上传SQL文件
CREATE TABLE users (
    id BIGINT PRIMARY KEY AUTO_INCREMENT,
    username VARCHAR(50) NOT NULL,
    email VARCHAR(100)
) COMMENT '用户表';
```

### 3. 生成文档
```bash
# 导出格式选择
✅ HTML    
✅ Markdown 
```

## 🎯 应用场景

### 🏢 企业开发
- **新员工培训** - 快速了解数据库结构
- **技术文档** - 规范的API文档
- **项目交付** - 完整的数据库设计文档

### 👥 团队协作
- **前后端协作** - 统一的数据字典
- **Code Review** - 数据库变更记录
- **知识传承** - 完整的项目文档

### 📊 项目管理
- **数据库设计** - 可视化表关系
- **版本管理** - 数据库变更追踪
- **质量检查** - 规范的数据库设计

## 💝 支持项目

如果这个项目对你有帮助，欢迎支持作者的持续开发：

### 📱 微信公众号
**扫码关注获取更多技术干货和更新通知**
<div align="center">
  <img src="./images/wechat-qr.jpg" alt="微信公众号" width="200" style="border-radius: 8px;"/>
</div>


## 📄 许可证

本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情

## 🙏 致谢

感谢以下开源项目：
- [Spring Boot](https://spring.io/projects/spring-boot)
- [Vue.js](https://vuejs.org/)
- [Element Plus](https://element-plus.org/)
- [Apache POI](https://poi.apache.org/)

---

## 📞 联系与支持

**技术交流 & 项目合作**

个人微信：lch_ybgdbl

- 赞助支持：请作者喝杯咖啡，激励持续更新

<div align="center">
  <table>
    <tr>
      <td align="center">
        <strong>微信</strong><br/>
        <img src="./images/6.jpg" alt="微信" width="150" style="border-radius: 8px;"/>
      </td>
      <td align="center">
        <strong>支付宝</strong><br/>
        <img src="./images/7.jpg" alt="支付宝" width="150" style="border-radius: 8px;"/>
      </td>
    </tr>
  </table>
</div>

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

---

<div align="center">
  <sub>开源不易，感谢您的支持！</sub>
</div>