一键生成数据库文档，堪称数据库界的Swagger，有点厉害

“

本文收录在个人博客： www.chengxy-nds.top，技术资料共享，同进步

最近部门订单业务调整，收拢其他业务线的下单入口，做个统一大订单平台。需要梳理各业务线的数据表，但每个业务线库都有近百张和订单相关的表，挨个表一个一个字段的弄脑瓜子嗡嗡的。

为了不重复 CV 操作，抱着一丝希望开始在 GitHub里找，看看有没有什么工具可以用，结果就真的发现了宝藏， screw（螺丝钉），居然可以生成数据库文档，优秀啊~。

数据库文档图

一、数据库支持

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

二、配置

1、pom文件

引入 screw核心包， HikariCP数据库连接池， HikariCP号称性能最出色的数据库连接池。

   

    cn.smallbun.screwgroupId>
    screw-coreartifactId>
    1.0.3version>
dependency>



    com.zaxxergroupId>
    HikariCPartifactId>
    3.4.5version>
dependency>



    mysqlgroupId>
    mysql-connector-javaartifactId>
    8.0.20version>
dependency>
复制代码

2、配置数据源

配置数据源，设置 useInformationSchema 可以获取 tables注释信息。

   spring.datasource.url=jdbc:mysql://45.93.1.5:3306/fire?useUnicode=true&characterEncoding=UTF-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.xa.properties.useInformationSchema=true
复制代码

3、screw 核心配置

screw有两种执行方式，第一种是 pom文件配置，另一种是代码执行。

    
    
        
            org.springframework.bootgroupId>
            spring-boot-maven-pluginartifactId>
        plugin>
        
            cn.smallbun.screwgroupId>
            screw-maven-pluginartifactId>
            1.0.3version>
            
                
                
                    com.zaxxergroupId>
                    HikariCPartifactId>
                    3.4.5version>
                dependency>
                
                
                    mysqlgroupId>
                    mysql-connector-javaartifactId>
                    8.0.20version>
                dependency>
            dependencies>
            
                
                rootusername>
                
                123456password>
                
                com.mysql.cj.jdbc.DriverdriverClassName>
                
                jdbc:mysql://41.92.6.5:3306/firejdbcUrl>
                
                HTMLfileType>
                
                falseopenOutputDir>
                
                freemarkerproduceType>
                
                
                
                数据库文档生成description>
                
                ${project.version}version>