3 Star 16 Fork 6

大话家 / database_doc

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

一、前言

在日常的开发工作中,偶尔会遇到项目收尾时,需要后端开发人员提供数据库设计文档的情况。
我把相关的文档规范、排版样式等,整理成了博客,方便你快速地知道如何编写一篇数据库设计文档。
参考文章链接: https://blog.csdn.net/qq_41057885/article/details/114436170
然而,即使你知道如何编写数据库设计文档,它的编写工作依然十分繁琐、重复。在浪费了大量的时间在此事后,我决定编写一个程序,把我从繁琐、重复的工作中解放出来。

1.1 项目目标

通过程序连接数据库(MySQL、MongoDB),个性化生成数据库设计文档。

1.2 项目说明

本项目的代码逻辑是通过对word文档标签进行操作,来达到修改word内容的目的,然后再将数据表的相关信息动态插入其中。
因此,本项目的重点就在于对word标签的操作,只有理解了word标签,才能理解本项目的代码逻辑。

二、MongoDB导出说明

2.1 关于MongoDB集合字段导出说明

MongoDB集合的字段是不固定,其导出可以有两种方案。
1.导出集合最大公约数字段集。
2.导出集合中所有出现过的字段。
对于超大数据集(生产环境)来说,遍历以获取所有的字段的方案是不现实的。在不遍历的前提下,不管是哪种方案,都无法获取最真实的字段集,都只能尽可能接近真实值。
本程序为了方便只是获取集合的第一条数据来获取字段名称及字段类型。 Tip:这是一个数学问题,即如何从一个大集合中筛选出一个小集合,且使小集合能尽可能多地含有大集合的特征。(盼望大佬们赐教)

2.2 导出文档的留白

此外,由于非关系型数据库的特点,MongoDB导出的文档就会有很多留白。实际上,这里的导出也就帮助用户整理好了格式,填充了字段名称、字段类型以及一些常规的信息,其他的均需要用户自己修改或补充。

2.3 mongoDB字段的父子(包含)关系

为了在导出的word中体现字段间的关系,需要通过一些方式来体现。
对于同级关系,两个字段左对齐显示。 对于包含关系,则给子字段加一个前缀“∟”,子字段的子字段则加两个前缀“∟”,例如:“∟∟name”,依此类推。

2.4 MongoDB中的数据类型

MongoDB字段数据类型对应Java的数据类型有如下: yml配置
java.util.ArrayList
java.lang.Boolean
org.bson.types.CodeWithScope
java.util.Date
org.bson.types.Decimal128
java.lang.Double
java.lang.Integer
java.lang.Long
org.bson.types.MaxKey
org.bson.types.MinKey
null
java.util.LinkedHashMap
java.lang.String
org.bson.types.Symbol
org.bson.BsonTimestamp
org.bson.types.ObjectId

三、使用说明

2.1 下载默认配置

1、替换数据库,启动项目

找到application.yml配置文件,修改如图所示的配置
MySQL数据库配置: yml配置 MongoDB数据库配置: yml配置

2、启动项目

项目默认端口为8888

3、浏览器访问接口

接口地址 说明
http://127.0.0.1:8888/download/mysql 下载MySQL的word到本地
http://127.0.0.1:8888/download/mongo 下载MongoDB的word到本地
http://127.0.0.1:8888/download/getMysql 返回MySQL文件流,浏览器直接下载
http://127.0.0.1:8888/download/getMongo 返回MongoDB文件流,浏览器直接下载

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

五、其他

本项目补充了MongoDB的数据库导出,部分页面有改动,不过问题不大。
如果你有任何好的意见或建议,可以联系我(如果我还做程序员的话🤡️)。
🖐telephone / wx:18370815482

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

根据数据库表生成数据库Word文档。基本原理:通过对word标签的操作(替换、拼接、循环)来动态修改doc文件的内容。 展开 收起
Java 等 2 种语言
MulanPSL-2.0
取消

发行版 (3)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/dahuajia/database_doc.git
git@gitee.com:dahuajia/database_doc.git
dahuajia
database_doc
database_doc
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891