乐趣区

关于java:最好用的数据库文档生成工具

jiezi

一 前言

本文介绍一些比拟风行的数据库文档生成工具，什么是数据库文档？其实在工作中进行我的项目交付的时候常常用到；简略来说数据库文档就是对整个数据库设计说明的文档，比方应用了哪个数据库，每张表的字段，类型阐明等，而后整顿成一个设计文档，这个文档多种多样，最常见的就是 word，有了数据库文档对当前的数据库保护，或者进行二次开发都很不便；

二 风行的数据库文档生成工具

2.1 screw

最近比拟火的一款数据库文档生成工具目前反对如下几种数据库，其它还在开发中

  • MySQL
  • MariaDB
  • TIDB
  • Oracle
  • SqlServer
  • PostgreSQL
  • Cache DB

文档生成反对

文档生成反对

  • html
  • word
  • markdwon

生成示例

应用形式 反对 java , 和 maven 插件, java 形式看官网文档；

<build>
<plugins>
<plugin>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-maven-plugin</artifactId>
<version>${lastVersion}</version>
<dependencies>
<!– HikariCP –>
<dependency>
<groupId>com.zaxxer</groupId>
<artifactId>HikariCP</artifactId>
<version>3.4.5</version>
</dependency>
<!–mysql driver–>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.20</version>
</dependency>
</dependencies>
<configuration>
<!–username–>
<username>root</username>
<!–password–>
<password>password</password>
<!–driver–>
<driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
<!–jdbc url–>
<jdbcUrl>jdbc:mysql://127.0.0.1:3306/xxxx</jdbcUrl>
<!– 生成文件类型 –>
<fileType>HTML</fileType>
<!– 关上文件输入目录 –>
<openOutputDir>false</openOutputDir>
<!– 生成模板 –>
<produceType>freemarker</produceType>
<!– 文档名称 为空时: 将采纳 [数据库名称 - 形容 - 版本号] 作为文档名称 –>
<fileName> 测试文档名称 </fileName>
<!– 形容 –>
<description> 数据库文档生成 </description>
<!– 版本 –>
<version>${project.version}</version>
<!– 题目 –>
<title> 数据库文档 </title>
</configuration>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>run</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

我的项目地址：https://gitee.com/leshalv/screw

2.2 DBCHM

DBCHM 反对 SqlServer/MySQL/Oracle/PostgreSQL/DB2/SQLite 数据库。

反对的导出的文件格式；

  • chm
  • word
  • excel
  • pdf
  • html
  • xml
  • markdown

成果展现

最新版本示 DBCHM.exe 软件，上手也容易；

我的项目地址：https://gitee.com/lztkdr/DBCHM

2.3 TableGo

TableGo 是基于数据库的代码主动生成工具，低代码编程技术的实现，能够零代码主动生成 SpringBoot 我的项目工程、生成 JavaBean、生成 MyBaits 的 Mapper 映射配置文件、生成数据库设计文档（Word、Excel）、生成 Swagger2 离线 API 文档、生成前后端代码、能查出数据库数据生成各种代码和文档等；

反对 MySQL、Oracle、SQL Server、PostgreSQL、MariaDB 五种数据库；

应用自定义模板性能能够依据数据库表构造信息生成你想要的任何代码，例如：Java、C#、C++、Golang、Rust、Python、Objective-C、Swift、VB、VC、SQL、HTML、JSP、JS、PHP、Vue、React、Word、Excel 等；

界面展现：

具体介绍地址：https://blog.csdn.net/vipbooks/article/details/78767469

官网地址：http://www.tablego.cn/

求关注关注吖

退出移动版