你还在手写数据库文档？推荐一款数据库文档生成工具screw

😄 19年之后由于某些原因断更了三年，23年重新扬帆起航，推出更多优质博文，希望大家多多支持～
🌷 古之立大事者，不惟有超世之才，亦必有坚忍不拔之志
🎐 个人CSND主页——Micro麦可乐的博客
🐥《Docker实操教程》专栏以最新的Centos版本为基础进行Docker实操教程，入门到实战
🌺《RabbitMQ》专栏主要介绍使用JAVA开发RabbitMQ的系列教程，从基础知识到项目实战
🌸《设计模式》专栏以实际的生活场景为案例进行讲解，让大家对设计模式有一个更清晰的理解
💕《Jenkins实战》专栏主要介绍Jenkins+Docker的实战教程，让你快速掌握项目CI/CD，是2024年最新的实战教程
🌞《Spring Boot》专栏主要介绍我们日常工作项目中经常应用到的功能以及技巧，代码样例完整
如果文章能够给大家带来一定的帮助！欢迎关注、评论互动～

前言

在我们日常开发过程中，一个项目可能是多个人协同开发，甚至是采用了不同团队不同的开发语言共同构建，相信你也遇到了团队成员会问到关于数据库表结构的问题，如：比如：“这个字段的数据类型是什么？”、“这个表和其他表是怎么关联的？”、“这个字段的命名有什么特殊含义吗？”等等，这些问题影响了整个团队的开发效率。

包括开发过程我们也需要调整数据结构满足功能开发需求，中途也会对文档进行修改调整，那么这个时候就需要一份详细的数据库表结构文档。文档中需要说明每个表的名称、字段名称、数据类型、约束条件、关联关系、必要的注释和说明等信息。那么有没有一款工具可以快速帮我们生成？答案是肯定的，就是今天要介绍的堪称数据库界swagger的工具 - screw（螺丝钉）

什么是screw

🚀 screw (螺丝钉) 英:[skruː] ~ 简洁好用的数据库表结构文档生成工具。目前gitee上已经 4.3K Star

开源地址：https://gitee.com/leshalv/screw

screw特点

• 简洁、轻量、设计良好
• 多数据库支持
• 多种格式文档
• 灵活扩展
• 支持自定义模板

screw目前对数据库的支持：

• MySQL
• MariaDB
• TIDB
• Oracle
• SqlServer
• PostgreSQL
• Cache DB（2016）

开始使用

在Spring项目中，screw 目前使用有两种方式：

❶ 代码配置文档生成

首先在我们配置我们的pom.xml文件，引入相关依赖，默认你已经有了数据库相关依赖

<!-- screw -->
<dependency>
    <groupId>cn.smallbun.screw</groupId>
    <artifactId>screw-core</artifactId>
    <version>1.0.5</version>
</dependency>
<!-- HikariCP -->
<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
    <version>4.0.3</version>
</dependency>

特别说明：
该工具目前是不支持druid数据源DruidDataSource的，需要引入HikariCP来实现

编写我们的测试代码，相关参数看代码注释即可：

    @Test
    public void testGeneration(){
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/generation-test?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8");
        hikariConfig.setUsername("root");
        hikariConfig.setPassword("123456");
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        HikariDataSource dataSource = new HikariDataSource(hikariConfig);
    	//生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径
                .fileOutputDir("/Users/apple/Downloads")
                //打开目录
                .openOutputDir(true)
                //文件类型
                .fileType(EngineFileType.HTML)
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .fileName("自定义文件名称").build();

        //忽略表
        ArrayList<String> ignoreTableName = new ArrayList<>();
        ignoreTableName.add("sys_config");
        ignoreTableName.add("sys_user");
        //忽略表前缀
        ArrayList<String> ignorePrefix = new ArrayList<>();
        ignorePrefix.add("test_");
        //忽略表后缀
        ArrayList<String> ignoreSuffix = new ArrayList<>();
        ignoreSuffix.add("_test");
        ProcessConfig processConfig = ProcessConfig.builder()
                //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
                //根据名称指定表生成
                .designatedTableName(new ArrayList<>())
                //根据表前缀生成
                .designatedTablePrefix(new ArrayList<>())
                //根据表后缀生成
                .designatedTableSuffix(new ArrayList<>())
                //忽略表名
                .ignoreTableName(ignoreTableName)
                //忽略表前缀
                .ignoreTablePrefix(ignorePrefix)
                //忽略表后缀
                .ignoreTableSuffix(ignoreSuffix).build();
        //配置
        Configuration config = Configuration.builder()
                //版本
                .version("1.0.0")
                //描述
                .description("数据库设计文档生成")
                //数据源
                .dataSource(druidDataSource)
                //生成配置
                .engineConfig(engineConfig)
                //生成配置
                .produceConfig(processConfig)
                .build();
        //执行生成
        new DocumentationExecute(config).execute();
    }

运行单元测试，查看生成的效果

❷ 通过Maven插件生成

配置我们的pom.xml plugins 标签中加入以下插件配置

<plugin>
    <groupId>cn.smallbun.screw</groupId>
    <artifactId>screw-maven-plugin</artifactId>
    <version>1.0.5</version>
    <dependencies>
        <!-- HikariCP -->
        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>4.0.3</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>MD</fileType>
        <!--文件输出目录-->
        <fileOutputDir>/Users/apple/Downloads</fileOutputDir>
        <!--打开文件输出目录-->
        <openOutputDir>false</openOutputDir>
        <!--生成模板-->
        <produceType>freemarker</produceType>
        <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->
        <fileName>测试文档名称</fileName>
        <!--描述-->
        <description>数据库文档生成</description>
        <!--版本-->
        <version>1.0.0</version>
        <!--标题-->
        <title>数据库文档MD格式</title>
    </configuration>
    <executions>
        <execution>
            <phase>compile</phase>
            <goals>
                <goal>run</goal>
            </goals>
        </execution>
    </executions>
</plugin>

配置完以后在 maven project -> screw run 运行即可

查看MD格式效果

结语

通过本文相信大家已经熟悉了screw的使用方法，一个详细、清晰的文档不仅能够帮助团队成员更好地理解系统的基础架构和数据结构，还能够提高团队的开发效率和质量。

希望本文对您有所帮助，如果您有任何疑问或建议，请随时留言讨论。如果觉得本文对你有所帮助，希望 一键三连 给博主一点点鼓励！

---