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

于 2024-05-16 05:31:05 发布
阅读量973 收藏 14
点赞数 26
文章标签： c语言 c++ 学习
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2401_84975277/article/details/138937587
版权

img
img

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上C C++开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以戳这里获取

每天 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 实体类，避免枯燥的重复劳动。

img
img

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上C C++开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以戳这里获取

nsion` 项目中，拓展 提供了该功能。

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

[外链图片转存中…(img-ok73iXZY-1715808644244)]
[外链图片转存中…(img-nVOd2gTp-1715808644245)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上C C++开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以戳这里获取

2401_84975277
关注
  • 26
    点赞
  • 踩
  • 14
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
java实体类生成工具
04-15
是在前辈基础上进行完善的， 可以于生成一般的Java实体类，欢迎提出存在的bug 与 升级建议.
基于 screw maven 插件一键生成数据库文档
meser88的博客
01-11 1274
一、screw 是什么 screw 是一个简洁好用的数据库表结构文档的生成工具，支持 MySQL、Oracle、PostgreSQL 等主流的关系数据库。 仓库地址是：https://github.com/pingfangushi/screw screw 生成的文档有 HTML、Word、Markdown 三种格式，如下： Word： Markdown： 二、screw 快速入门 本文的内容是基于 screw 的 maven 插件（screw-maven-plugin）来生成数据...
java 根据数据库表生成实体类工具
caibi_A的博客
11-18 1774
节约写实体类的时间
解决screw Maven插件方式运行时，在编译打包时跳过执行的问题
飞一站的博客
03-20 866
解决screw Maven插件方式运行时，在编译打包时跳过执行的问题
将swagger接口中的字段 转为java实体对象映射工具类
wdd668的专栏
12-23 573
【代码】将swagger接口中的字段 转为java实体对象映射工具类。
多数据库支持、自动生成实体类和SQL语句的工具1.8版 最新版
01-26
欢迎使用哈，喜欢个可以一起讨论哈 ...3、能生成JAVA Rest、Service、和Mapper三层类，rest层包含Swagger生成。但这个生成和项目结构强相关。如不合适，大家别骂街。 有问题联系：wenda@88.com 或 104795599
Java利用Swagger2自动生成对外接口的文档
08-27
Java利用Swagger2自动生成对外接口的文档 Java利用Swagger2自动生成对外接口的文档...Swagger2是当前非常流行的API文档生成工具，使用Swagger2可以提高开发效率，减少手写文档的工作量，提高API文档的准确性和可读性。
根据数据库sql生成java代码代码生成器
05-28
3、生成的代码有注释和swagger注解，并且实体中有mybatisplus注解 4、优点：提高效率、方便快捷 5、具体操作步骤可见：使用说明.txt。 1、配置mybatisplus.json outdir需要设置成绝对路径 jdbcUrl、jdbcUser、...
Java Mybatis Generator 自动根据数据库注释添加Entity的Swagger注释
最新发布
01-02
1. Java Mybatis Generator， 自动根据数据库字段的注释，把注释的内容放到Entity的Swagger注释@ApiModel 和 @ApiModelProperty中 2. 如果碰到Mybatis xml文件格式错误，请到...
idea配置数据库，反向生成实体类demo，支持lombok，swagger2注解
10-22
idea配置数据库，反向生成实体类demo，支持lombok，swagger2注解
Swagger配置生成实体类参数的接口信息
qq_31404603的博客
03-24 7954
记录整合Springboot与Swagger的时候遇到的如下问题， 这个错误大部分时候不会影响正常使用，但也有的时候会导致无法传参测试。 此处的问题主要原因是Swagger找不到你自己定义的实体类信息。所以你需要添加一个接口让Swagger能够找到你的实体类信息，这个时候需要加一个识别的接口。 @RestController public class SwaggerController...
screw 一个简洁好用的数据库表结构文档生成工具
qq_61313896的博客
08-17 1931
screw (螺丝钉) 英:[`skruː`] ~ 简洁好用的数据库表结构文档生成工具，企业级开发过程中，一颗永不生锈的螺丝钉
Java在线代码生成工具，支持JPA、Mybatis、MybatisPlus
欢迎光临
11-28 2115
Java在线代码生成工具，支持Mybatis、MybatisPlus、JPA，自定义代码模板，
利用sql 生成 带swagger注解的实体
gu1079358530的博客
02-08 274
sql 生成 带swagger注解的实体 - 设置参数：schema数据库。-- 设置参数：表名称。
利用screw插件生成mysql数据库文档
WY001的博客
11-21 1128
1、在pom文件中加入 <plugin> <groupId>cn.smallbun.screw</groupId> <artifactId>screw-maven-plugin</artifactId> <version>1.0.5</version> <dependencies>
groovy 直接将给定的文本转换成Java中的Class<?>对象从而不需要再手动去写.java文件
u013803262的专栏
04-18 3430
package com.xxl.job.core.glue; import groovy.lang.GroovyClassLoader;import java.lang.reflect.Method;public class Test { @org.junit.Test public void testGroovyClassLoader() throws Exception {
数据库字段转Java实体类/支持lombok/支持swagger/支持mybatis/简单易用/拿来即用
桃桃桃先生
03-31 437
数据库字段转Java实体类/支持lombok/支持swagger/支持mybatis深圳的开发者数据库表字段转Java类工具类/Lombok/Swagger/MybatisPlus调用案例 (图)按照这种思路还可以写转xml/service/controller 深圳的开发者 数据库表字段转Java类 工具类/Lombok/Swagger/MybatisPlus JDBC连接数据库->根据库名->查询所有表信息->查询所有表字段信息->组装数据 import lombok.Data
idea如何快速基于数据库表生成实体类自动加上swagger注解
10-26
要快速基于数据库表生成实体类并自动加上swagger注解，可以采取以下步骤： 1. 首先，需要连接数据库，并读取数据库表的结构信息。可以使用数据库连接工具库如JDBC来连接数据库，使用相关API获取表的元数据信息。 2. 获取表的元数据后，可以通过遍历元数据来生成实体类。可以使用字符串拼接的方式，构建出实体类的代码。 3. 在生成实体类的过程中，需要根据元数据的类型和名称来决定实体类的字段类型和名称。根据元数据的类型，可以将数据库的数据类型转换为对应的Java类型。使用字符串拼接的方式，可以将字段类型、名称及其注解添加到实体类的代码中。 4. 在实体类中加入swagger注解，可以通过在生成实体类代码的过程中，根据表的元数据信息，判断是否应该添加swagger注解。根据元数据的属性，可以判断字段是否为必填项、字段的描述等。根据这些元数据属性，可以通过字符串拼接，将swagger注解的相关信息添加到实体类代码中。 5. 完成实体类的生成之后，可以将生成的实体类保存到指定的路径。可以使用IO操作将生成的代码保存为Java文件。 6. 最后，通过编译器编译生成的Java文件，将其转换为字节码文件，并加载到JVM中即可。 通过以上步骤，可以快速基于数据库表生成实体类，并自动加上swagger注解。这样可以方便地生成实体类代码，并为API文档的编写提供便利。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值