一、 Screw 简介

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

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

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

格式	示例
HTML
Word
Markdown

二、快速入门

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

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

2.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。

2.1.1 引入依赖

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



    
        lab-70-db-doc
        cn.iocoder.springboot.labs
        1.0-SNAPSHOT
    
    4.0.0

    lab-70-db-doc-screw-01

    
        
        
            cn.smallbun.screw
            screw-core
            1.0.5
        

        
        
            com.zaxxer
            HikariCP
            3.4.5
        
        
            mysql
            mysql-connector-java
            8.0.22

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

2.1.2 ScrewMain

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

import cn.smallbun.screw.core.Configuration;
import cn.smallbun.screw.core.engine.EngineConfig;
import cn.smallbun.screw.core.engine.EngineFileType;
import cn.smallbun.screw.core.engine.EngineTemplateType;
import cn.smallbun.screw.core.execute.DocumentationExecute;
import cn.smallbun.screw.core.process.ProcessConfig;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;

import javax.sql.DataSource;
import java.util.Arrays;
import java.util.Collections;
/**
 * @ClassName:  ScrewMain
 * @Description: 生成数据库文档的java类
 * @author: 郭秀志 [email protected]
 * @date:   2020/12/17 16:38
 * @Copyright:
 */
public class ScrewMain {

    private static final String DB_URL = "jdbc:mysql://10.23.7.220:3306";
    private static final String DB_NAME = "pay";
    private static final String DB_USERNAME = "root";
    private static final String DB_PASSWORD = "123.guo.com";

    private static final String FILE_OUTPUT_DIR = "D:\\work\\deepvision\\NPay\\技术文档\\sql\\doc";
    private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD; // 可以设置 Word 或者 Markdown 格式
    private static final String DOC_FILE_NAME = "数据库文档V1.0.0";
    private static final String DOC_VERSION = "1.0.0";
    private static final String DOC_DESCRIPTION = "项目数据库文档，表包括：接口及运管后台2部分";

    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.emptyList())  // 根据名称指定表生成
                .designatedTablePrefix(Collections.emptyList()) //根据表前缀生成
                .designatedTableSuffix(Collections.emptyList()) // 根据表后缀生成
                .ignoreTableName(Arrays.asList("test_user", "test_group")) // 忽略表名
                .ignoreTablePrefix(Collections.singletonList("test_")) // 忽略表前缀
                .ignoreTableSuffix(Collections.singletonList("_test")) // 忽略表后缀
                .build();
    }

}

代码比较简单,比较重要的变量，已经抽取成静态变量，看着修改成自己项目的即可。

2.1.3 简单测试

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

HTML文档示例

2.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。

2.2.1 引入插件

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



    
        lab-70-db-doc
        cn.iocoder.springboot.labs
        1.0-SNAPSHOT
    
    4.0.0

    lab-70-db-doc-screw-02

    
        
            
                cn.smallbun.screw
                screw-maven-plugin
                1.0.5
                
                    
                    
                        com.zaxxer
                        HikariCP
                        3.4.5
                    
                    
                        mysql
                        mysql-connector-java
                        8.0.22
                    
                
                
                    
                    com.mysql.cj.jdbc.Driver
                    jdbc:mysql://400-infra.server.iocoder.cn:3306/mall_system
                    root
                    3WLiVUBEwTbvAfsh
                    
                    HTML
                    数据库文档 
                    测试文档名称 
                    数据库文档生成 
                    ${project.version} 
                    false 
                    freemarker 
                
                
                    
                        compile
                        
                            run

Maven 插件的配置项 比较少，按需修改下即可。

2.2.2 简单测试

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

三、生成实体类

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。

3.1 引入依赖

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



    
        lab-70-db-doc
        cn.iocoder.springboot.labs
        1.0-SNAPSHOT
    
    4.0.0

    lab-70-db-doc-screw-03

    
        
        
            cn.smallbun.screw
            screw-core
            1.0.5
        
        
            cn.smallbun.screw
            screw-extension
            1.0.5
        

        
        
            com.zaxxer
            HikariCP
            3.4.5
        
        
            mysql
            mysql-connector-java
            8.0.22

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

3.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.emptyList())  // 根据名称指定表生成
                .designatedTablePrefix(Collections.emptyList()) //根据表前缀生成
                .designatedTableSuffix(Collections.emptyList()) // 根据表后缀生成
                .ignoreTableName(Arrays.asList("test_user", "test_group")) // 忽略表名
                .ignoreTablePrefix(Collections.singletonList("test_")) // 忽略表前缀
                .ignoreTableSuffix(Collections.singletonList("_test")) // 忽略表后缀
                .build();
    }

}

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

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

3.3 简单测试

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

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

生成 Java 实体类和数据库文档

一、 Screw 简介

二、快速入门

2.1 使用 Java 代码的方式

2.1.1 引入依赖

2.1.2 ScrewMain

2.1.3 简单测试

2.2 使用 Maven 插件的方式

2.2.1 引入插件

2.2.2 简单测试

三、生成实体类

3.1 引入依赖

3.2 ScrewMain

3.3 简单测试

你可能感兴趣的:(生成 Java 实体类和数据库文档)

生成 Java 实体类和数据库文档

一、 Screw 简介

二、 快速入门

2.1 使用 Java 代码的方式

2.1.1 引入依赖

2.1.2 ScrewMain

2.1.3 简单测试

2.2 使用 Maven 插件的方式

2.2.1 引入插件

2.2.2 简单测试

三、 生成实体类

3.1 引入依赖

3.2 ScrewMain

3.3 简单测试

你可能感兴趣的:(生成 Java 实体类和数据库文档)

二、快速入门

三、生成实体类