数据库界的 Swagger，一键自动生成 Java 实体类和数据库文档！不讲武德！

最新推荐文章于 2025-10-24 17:19:05 发布
原创 最新推荐文章于 2025-10-24 17:19:05 发布 · 4.1k 阅读 · 249 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#maven #mysql #eclipse #css #xml

本文介绍了Screw，一个用于生成数据库表结构文档和Java实体类的工具，支持MySQL等主流数据库。提供了Java代码和Maven插件两种方式快速生成HTML、Word、Markdown格式的文档。此外，还演示了如何使用Screw生成Java实体类，简化开发工作。

    点击上方“芋道源码”，选择“设为星标”

管她前浪，还是后浪？

能浪的浪，才是好浪！

每天 8:55 更新文章，每天掉亿点点头发...

源码精品专栏

 

摘要: 原创出处 http://www.iocoder.cn/Spring-Boot/DB-Doc-screw/ 「芋道源码」欢迎转载，保留摘要，谢谢！

1. 概述

闲来无事的周六，被 ???? 芳放了鸽子，只好蹲在被窝里研究会技术，安慰下自己受伤的心灵。

鸽子

相信胖友们都手写 过数据库表结构文档 ，一通无脑的 CV 大法之后，小几十页的  Word 文档就出炉了。

那么有没什么工具，可以帮我们偷懒高效的自动 生成数据库表结构文档呢？有，通过使用 screw 生成工具。

2. screw 简介

screw 是一个简洁好用的数据库表结构文档的生成工具 ，支持 MySQL、Oracle、PostgreSQL 等主流的关系数据库。

良心艿：screw 的仓库地址是 https://github.com/pingfangushi/screw，感兴趣的胖友，可以研究一波。

生成的文档有 HTML、Word、Markdown 三种格式 ，示例如下图所示：

格式图
HTML
Word
Markdown

3. 快速入门

screw 有两种方式 来生成文档，通过 Java 代码 或者 Maven 插件 。

下面，我们来分别快速入门下。

3.1 使用 Java 代码的方式

创建 lab-70-db-doc-screw-01 示例项目，使用 screw 的 Java 代码 的方式，生成文档。

示例示例

友情提示：示例代码的完整地址，可见 https://github.com/YunaiV/SpringBoot-Labs/tree/master/lab-70-db-doc/lab-70-db-doc-screw-01。

3.1.1 引入依赖

在 pom.xml 文件中，引入 screw 的依赖 screw-core。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>lab-70-db-doc</artifactId>
        <groupId>cn.iocoder.springboot.labs</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>lab-70-db-doc-screw-01</artifactId>

    <dependencies>
        <!-- screw 库，简洁好用的数据库表结构文档生成器 -->
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.5</version>
        </dependency>

        <!-- 数据库连接 -->
        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>3.4.5</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.22</version>
        </dependency>
    </dependencies>

</project>

依赖 HikariCP 和 mysql-connector-java 是为了连接 MySQL 数据库。

3.1.2 ScrewMain

创建 ScrewMain 类，使用 screw 生成文档。代码如下：

public class ScrewMain {

    private static final String DB_URL = "jdbc:mysql://400-infra.server.iocoder.cn:3306";
    private static final String DB_NAME = "mall_system";
    private static final String DB_USERNAME = "root";
    private static final String DB_PASSWORD = "3WLiVUBEwTbvAfsh";

    private static final String FILE_OUTPUT_DIR = "/Users/yunai/screw_test";
    private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.HTML; // 可以设置 Word 或者 Markdown 格式
    private static final String DOC_FILE_NAME = "数据库文档";
    private static final String DOC_VERSION = "1.0.0";
    private static final String DOC_DESCRIPTION = "文档描述";

    public static void main(String[] args) {
        // 创建 screw 的配置
        Configuration config = Configuration.builder()
                .version(DOC_VERSION)  // 版本
                .description(DOC_DESCRIPTION) // 描述
                .dataSource(buildDataSource()) // 数据源
                .engineConfig(buildEngineConfig()) // 引擎配置
                .produceConfig(buildProcessConfig()) // 处理配置
                .build();

        // 执行 screw，生成数据库文档
        new DocumentationExecute(config).execute();
    }

    /**
     * 创建数据源
     */
    private static DataSource buildDataSource() {
        // 创建 HikariConfig 配置类
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl(DB_URL + "/" + DB_NAME);
        hikariConfig.setUsername(DB_USERNAME);
        hikariConfig.setPassword(DB_PASSWORD);
        hikariConfig.addDataSourceProperty("useInformationSchema", "true"); // 设置可以获取 tables remarks 信息
        // 创建数据源
        return new HikariDataSource(hikariConfig);
    }

    /**
     * 创建 screw 的引擎配置
     */
    private static EngineConfig buildEngineConfig() {
        return EngineConfig.builder()
                .fileOutputDir(FILE_OUTPUT_DIR) // 生成文件路径
                .openOutputDir(false) // 打开目录
                .fileType(FILE_OUTPUT_TYPE) // 文件类型
                .produceType(EngineTemplateType.freemarker) // 文件类型
                .fileName(DOC_FILE_NAME) // 自定义文件名称
                .build();
    }

    /**
     * 创建 screw 的处理配置，一般可忽略
     * 指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
     */
    private static ProcessConfig buildProcessConfig() {
        return ProcessConfig.builder()
                .designatedTableName(Collections.<String>emptyList())  // 根据名称指定表生成
                .designatedTablePrefix(Collections.<String>emptyList()) //根据表前缀生成
                .designatedTableSuffix(Collections.<String>emptyList()) // 根据表后缀生成
                .ignoreTableName(Arrays.asList("test_user", "test_group")) // 忽略表名
                .ignoreTablePrefix(Collections.singletonList("test_")) // 忽略表前缀
                .ignoreTableSuffix(Collections.singletonList("_test")) // 忽略表后缀
                .build();
    }

}

代码比较简单，胖友看看注释即可。

比较重要的变量，已经抽取成静态 变量，胖友看着修改哈。

3.1.3 简单测试

执行 ScrewMain 程序，进行文档的生成。这里我们生成的是 HTML 文档，效果如下图所示：

HTML 文档

3.2 使用 Maven 插件的方式

创建 lab-70-db-doc-screw-02 示例项目，使用 screw 的 Maven 插件 的方式，生成文档。

示例示例

友情提示：示例代码的完整地址，可见 https://github.com/YunaiV/SpringBoot-Labs/tree/master/lab-70-db-doc/lab-70-db-doc-screw-02。

3.2.1 引入插件

在 pom.xml 文件中，引入 screw 的插件 screw-maven-plugin。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>lab-70-db-doc</artifactId>
        <groupId>cn.iocoder.springboot.labs</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>lab-70-db-doc-screw-02</artifactId>

    <build>
        <plugins>
            <plugin>
                <groupId>cn.smallbun.screw</groupId>
                <artifactId>screw-maven-plugin</artifactId>
                <version>1.0.5</version>
                <dependencies>
                    <!-- 数据库连接 -->
                    <dependency>
                        <groupId>com.zaxxer</groupId>
                        <artifactId>HikariCP</artifactId>
                        <version>3.4.5</version>
                    </dependency>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.22</version>
                    </dependency>
                </dependencies>
                <configuration>
                    <!-- 数据库相关配置 -->
                    <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
                    <jdbcUrl>jdbc:mysql://400-infra.server.iocoder.cn:3306/mall_system</jdbcUrl>
                    <username>root</username>
                    <password>3WLiVUBEwTbvAfsh</password>
                    <!-- screw 配置 -->
                    <fileType>HTML</fileType>
                    <title>数据库文档</title> <!--标题-->
                    <fileName>测试文档名称</fileName> <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->
                    <description>数据库文档生成</description> <!--描述-->
                    <version>${project.version}</version> <!--版本-->
                    <openOutputDir>false</openOutputDir> <!--打开文件输出目录-->
                    <produceType>freemarker</produceType> <!--生成模板-->
                </configuration>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>run</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

Maven 插件的配置项 比较少，胖友按需修改下 <configuration/> 即可。

3.2.2 简单测试

执行 screw-maven-plugin 插件，会在 doc 目录下生成文档。如下图所示：

执行 Maven 插件

4. 生成实体类

screw 的实现原理，是基于数据库中的表结构 ，生成对应的文档。

那么，是否可以自动 生成 Java 实体类呢？答案是可以的，在 screw-extension 项目中，拓展 提供了该功能。

这样，日常开发中，在我们完成数据库的建表 之后，可以直接生成对应的 Java 实体类，避免枯燥的重复劳动。

下面，我们来快速入门下。创建 lab-70-db-doc-screw-03 示例项目，使用 screw 的 Java 代码 的方式，生成 Java 实体类。

示例示例

友情提示：示例代码的完整地址，可见 https://github.com/YunaiV/SpringBoot-Labs/tree/master/lab-70-db-doc/lab-70-db-doc-screw-03。

4.1 引入依赖

在 pom.xml 文件中，额外 引入 screw 的依赖 screw-extension。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>lab-70-db-doc</artifactId>
        <groupId>cn.iocoder.springboot.labs</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>lab-70-db-doc-screw-03</artifactId>

    <dependencies>
        <!-- screw 库，简洁好用的数据库表结构文档生成器 -->
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.5</version>
        </dependency>
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-extension</artifactId>
            <version>1.0.5</version>
        </dependency>

        <!-- 数据库连接 -->
        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>3.4.5</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.22</version>
        </dependency>
    </dependencies>

</project>

友情提示：由于 screw-extension 项目处于初步开发阶段，暂时未将该依赖推到 Maven 中央仓库，所以需要自己克隆项目，进行编译打包到本地。

4.2 ScrewMain

创建 ScrewMain 类，使用 screw 生成 Java 实体类。代码如下：

public class ScrewMain {

    private static final String DB_URL = "jdbc:mysql://400-infra.server.iocoder.cn:3306";
    private static final String DB_NAME = "mall_system";
    private static final String DB_USERNAME = "root";
    private static final String DB_PASSWORD = "3WLiVUBEwTbvAfsh";

    private static final String FILE_OUTPUT_DIR = "/Users/yunai/screw_test";
    private static final String JAVA_CLASS_PACKAGE = "cn.iocoder.dataobject";

    public static void main(String[] args) {
        // 创建 screw 的配置
        PojoConfiguration config = PojoConfiguration.builder()
                .path(FILE_OUTPUT_DIR) // 生成 POJO 相关的目录
                .packageName(JAVA_CLASS_PACKAGE) // 包名
                .nameStrategy(new HumpNameStrategy()) // 包名策略
                .useLombok(false) // 是否使用 Lombok
                .dataSource(buildDataSource()) // 数据源
                .processConfig(buildProcessConfig()) // 处理配置
                .build();

        // 执行 screw，生成 POJO 实体类
        new PojoExecute(config).execute();
    }

    /**
     * 创建数据源
     */
    private static DataSource buildDataSource() {
        // 创建 HikariConfig 配置类
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl(DB_URL + "/" + DB_NAME);
        hikariConfig.setUsername(DB_USERNAME);
        hikariConfig.setPassword(DB_PASSWORD);
        hikariConfig.addDataSourceProperty("useInformationSchema", "true"); // 设置可以获取 tables remarks 信息
        // 创建数据源
        return new HikariDataSource(hikariConfig);
    }

    /**
     * 创建 screw 的处理配置，一般可忽略
     * 指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
     */
    private static ProcessConfig buildProcessConfig() {
        return ProcessConfig.builder()
                .designatedTableName(Collections.<String>emptyList())  // 根据名称指定表生成
                .designatedTablePrefix(Collections.<String>emptyList()) //根据表前缀生成
                .designatedTableSuffix(Collections.<String>emptyList()) // 根据表后缀生成
                .ignoreTableName(Arrays.asList("test_user", "test_group")) // 忽略表名
                .ignoreTablePrefix(Collections.singletonList("test_")) // 忽略表前缀
                .ignoreTableSuffix(Collections.singletonList("_test")) // 忽略表后缀
                .build();
    }

}

代码比较简单，胖友看看注释即可。不同于上面的快速入门，这里我们使用 PojoConfiguration 作为配置类，使用 PojoExecute 作为执行器。

比较重要的变量，已经抽取成静态 变量，胖友看着修改哈。

4.3 简单测试

执行 ScrewMain 程序，进行 Java 实体类的生成。效果如下图所示：

Java 实体类

生成的 Java 实体类的成员属性 还不太正确，需要等待作者进行下修复。

666. 彩蛋

至此，我们已经完成 screw 的学习，一起来简单总结下：

  • screw 支持生成数据库表结构文档 ，通过 Java 代码或者 Maven 插件的方式。

  • screw 支持生成 Java 实体类 ，通过 screw-extension 提供。

初略喵了下 screw 的代码，总体代码量在 5000+ 行，核心代码在 2000 行左右。项目分层干净，代码注释完成，胖友可以选择阅读了解下。这样，我们可以根据我们实际项目的需要，进行二次开发 。

End~继续抠脚。

我是艿艿，一个每天徘徊在煞笔 与牛啤 的死胖子。

我

欢迎加入我的知识星球，一起探讨架构，交流源码。加入方式，长按下方二维码噢：

已在知识星球更新源码解析如下：

最近更新《芋道 SpringBoot 2.X 入门》系列，已经 20 余篇，覆盖了 MyBatis、Redis、MongoDB、ES、分库分表、读写分离、SpringMVC、Webflux、权限、WebSocket、Dubbo、RabbitMQ、RocketMQ、Kafka、性能测试等等内容。

提供近 3W 行代码的 SpringBoot 示例，以及超 4W 行代码的电商微服务项目。

获取方式：点“在看”，关注公众号并回复 666 领取，更多内容陆续奉上。

兄弟，艿一口，点个赞！????

简洁好用的数据库表结构文档生成工具screw
river106的博客
06-10 3406
日常的开发工作中，经常会和数据库打交道，在某些场景可能会需要数据库表结构的文档，今天分享个简洁好用的数据库表结构文档生成工具screw。
《小鑫发现》之SCREW数据库文档生成插件
iOLO的博客
12-24 463
介绍 平时很多时候，在交付时，需要交付数据库设计文档。评审时候也需要查看数据库设计文档。平时开发时，经常会修改数据库表，然后还要修改数据库设计文档，一旦忘了，就会变得很麻烦，挨个排查，耽误时间。所以这次介绍一款插件，直接生成数据库设计文档，并且支持MD，word，html等格式，而且还是开源，可以自己改造，里面是模板化的freemarker。 这就是第一期的《小鑫发现》之SCREW数据库文档生成 构建 这里使用MAVEN插件的方式进行生成。 新建一个Springboot的项目，为啥是Springboot的呢
一键生成数据库文档：Screw工具详解
最新发布
zxx15332445017的博客
10-24 436
一键生成数据库文档，通过简单的代码配置即可自动生成包含表结构、列信息等元数据的可视化文档
使用Screw一键生成数据库设计文档，解决数据库表太多不利于浏览
Eternity_he的博客
08-10 2645
使用Screw一键生成数据库设计文档
swagger-codegen生成java客户端代码（其他语言类似）
热门推荐
走过的足迹
11-17 2万+
前后端分离的时候，需要建立契约，Swagger可达到该目的（略）。 建立Rest接口后，通过swagger-codegen项目可以自动生成对应的客户端代码（c++、php、java、js、node等等）， 关于swagger-codegen项目的使用，发现中文文档较少，追根述源后，发现其中相当一部分同出一辙。 亲自摸索使用后，记录一下步骤，利己利人。 swagger-codegen项目地址
自动生成Java实体类
04-14
JDBC读取数据库元数据,生成JAVA实体类
Screw数据库文档生成,DataWay接口自动配置,JApiDocs接口文档生成，Swagger在线接口文档生成
09-04
SCREM可以自定义配置生成和不生成数据库文档的表 2. 集成Dataway接口配置工具 Dataway 是基于 DataQL 服务聚合能力，为应用提供的一个接口配置工具，使得使用者无需开发任何代码就配置一个满足需求的接口。整个接口...
Java利用Swagger2自动生成对外接口的文档
08-27
Java利用Swagger2自动生成对外接口的文档 Java利用Swagger2自动生成对外接口的文档...Swagger2是当前非常流行的API文档生成工具，使用Swagger2可以提高开发效率，减少手写文档的工作量，提高API文档的准确性和可读性。
基于Swagger文档自动生成Kotlin实体类和Retrofit接口的JavaScript转换工具_支持从YAML格式的SwaggerAPI文档中提取数据结构_自动转换为Kot.zip
08-14
它的工作原理是利用Swagger规范的API文档，自动生成后端服务中常用的Kotlin实体类和Retrofit接口。Swagger是一种广泛使用的API设计和文档规范，它以一种易于理解和机器阅读的格式详细描述了API，使得API的设计和使用...
精选资源
多数据库支持、自动生成实体类和SQL语句的工具1.8版 最新版
01-26
欢迎使用哈，喜欢个可以一起讨论哈 ...3、能生成JAVA Rest、Service、和Mapper三层类，rest层包含Swagger生成。但这个生成和项目结构强相关。如不合适，大家别骂街。 有问题联系：wenda@88.com 或 104795599
idea配置数据库，反向生成实体类demo，支持lombok，swagger2注解
10-22
idea配置数据库，反向生成实体类demo，支持lombok，swagger2注解
Java数据库实体类自动生成
12-06
可以直接从数据库查取数据并生成字段，现只支持mysql，傻瓜式操作，大大加快了实体类的编写速度，非常有用切非常耐用。
JavaMysql实体类自动生成
07-14
JavaMysql实体类自动生成 省去了每次都要写实体类的麻烦
JavaBean实体类 配置文件 代码一键自动生成工具
10-25
各位客官看清楚了，这个是工具，免费先给各位使用下，绝对原创，源码请转到这里下载： http://download.youkuaiyun.com/detail/happingchann/8079477 ******原创非转载****** ******支持解析Powerdesiger物理逻辑图****** ******非JAVA源码****** 代码一键自动生成工具 可生成Action、JavaBean实体类、Dao及实现类、service及实现类、spring.xml、struts.xml、mybatis.xml *该工具目前支持3种数据源的生成方式，分别是：JDBC、.table、PDM *JDBC：选择JDBC是只需要配置数据源就行了，别的不要动 *.table后缀文件：是金蝶BOS中的一个字段属性映射文件 *PDM：Powerdesigner物理逻辑图，选择PDM时会读取物理逻辑图中的所有表，从里面选择需要生成的目标表就行了 *config文件夹中提供测试的.table文件和PDM文件
自动生成java实体类
07-22
只要输入mysql数据库里面的表名运行文件就可以生成相应的实体和sql语句,包含动态sql语句.
使用Swagger生成JAVA Mock Server（Springboot）代码
二一点
11-14 1万+
Swagger为我们提供了非常多的工具，其中最强的还要算这个代码的生成工具。在前后端分离的大环境下，前后端之间订立的接口显得尤为重要，接口在订立之后变动的可能性已经很小，这就要求我们提前去设计接口，也就是我们为前端提供的API。 但是我们发现，在开发过程中订立的接口寿命其实很短，这是一件非常严重的事情。因此Swagger为我们提供了另外一种比较优雅的方式：就是你先订立接口，然后再去用生成的接口，
个人学习系列 - Spring Boot整合screw实现数据库文档自动生成
xiuaiba的博客
09-22 627
有时候数据库文档需要整理，可是只能手动的复制粘贴，心中一万只草泥马奔腾而过。。。 screw 简洁好用的数据库表结构文档生成工具。 1. 创建项目 1.1 pom.xml <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </de.
基于数据库表自动生成Java实体类与MyBatis映射文件
为此，“Java自动生成数据库表实体类和MyBatis接口以及XML文件”这一技术方案应运而生，成为提升开发自动化程度、加快项目迭代速度的重要手段。 该技术的核心目标是通过读取数据库元数据（如表结构、字段名、数据...
评论 13
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值