# database_doc
**Repository Path**: elfbobo_admin_admin/database_doc
## Basic Information
- **Project Name**: database_doc
- **Description**: 根据数据库表生成数据库Word文档。基本原理：通过对word标签的操作（替换、拼接、循环）来动态修改doc文件的内容。
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 8
- **Created**: 2023-05-31
- **Last Updated**: 2023-05-31
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# 一、前言
在日常的开发工作中，偶尔会遇到项目收尾时，需要后端开发人员提供数据库设计文档的情况。
我把相关的文档规范、排版样式等，整理成了博客，方便你快速地知道如何编写一篇数据库设计文档。
参考文章链接： https://blog.csdn.net/qq_41057885/article/details/114436170
然而，即使你知道如何编写数据库设计文档，它的编写工作依然十分繁琐、重复。在浪费了大量的时间在此事后，我决定编写一个程序，把我从繁琐、重复的工作中解放出来。
## 1.1 项目目标
通过连接MySQL数据库，个性化生成数据库设计文档。
## 1.2 项目说明
本项目的代码逻辑是通过对word文档标签进行操作，来达到修改word内容的目的，然后再将数据表的相关信息动态插入其中。
因此，本项目的重点就在于对word标签的操作，只有理解了word标签，才能理解本项目的代码逻辑。
# 二、使用说明
## 2.1 下载默认配置
#### 1、替换数据库，启动项目
找到application.yml配置文件，修改如图所示的配置
#### 2、启动项目
项目默认端口为8888
#### 3、浏览器访问接口
| 接口地址 | 说明 |
|-----------------------------------------------------------|---------------------------|
| http://127.0.0.1:8888/download/word | 下载word到本地，文件名默认 |
| http://127.0.0.1:8888/download/word2?fileName=XXX.doc | 下载word到本地，文件名为XXX.doc |
| http://127.0.0.1:8888/download/getWord | 返回文件流，浏览器直接下载，文件名默认 |
| http://127.0.0.1:8888/download/word2?fileName=XXX.doc | 返回文件流，浏览器直接下载，文件名为XXX.doc |
#### 4、补充
word默认的下载地址为：./src/main/resources/static/word/
注意：以上4种方式下载的文件，都是采用默认格式，默认字段（序号、字段名、类型(长度)、主键、描述）。
如果你需要更多的字段和其他样式，可以使用***自定义配置页面***
## 2.2 自定义配置页面
项目启动后，浏览器访问 http://127.0.0.1:8888/form/index 即可进入配置页面，选择你需要的配置（表头字段、表格样式）即可下载相应的word文档。
多选框后面的输入框为字段别名，例如当你选中了第一行（序号），但你希望生成的文档叫序列号，即可在后面的输入框输入序列号即可。
#### 效果
# 三、视频教程
B站视频地址：
【database_doc项目的用法及实现逻辑说明】 https://www.bilibili.com/video/BV1MM411K7ko
# 四、其他
如果你有任何好的意见或建议，可以联系我（如果我还做程序员的话🤡️）。
🖐telephone / wx：18370815482