一、 Screw 簡介

screw 是一個簡潔好用的數(shù)據(jù)庫表結(jié)構(gòu)文檔的生成工具 ，支持 MySQL、Oracle、PostgreSQL 等主流的關(guān)系數(shù)據(jù)庫。

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

生成的文檔有 HTML、Word、Markdown 三種格式，示例如下圖所示：

格式	示例
HTML
Word
Markdown

二、快速入門

screw 有兩種方式來生成文檔，通過 Java 代碼 或者 Maven 插件 。

下面，我們來分別快速入門下。

2.1 使用 Java 代碼的方式

創(chuàng)建 lab-70-db-doc-screw-01 示例項(xiàng)目，使用 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。

<?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 庫，簡潔好用的數(shù)據(jù)庫表結(jié)構(gòu)文檔生成器 -->
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.5</version>
        </dependency>

        <!-- 數(shù)據(jù)庫連接 -->
        <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 數(shù)據(jù)庫。

2.1.2 ScrewMain

創(chuàng)建 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: 生成數(shù)據(jù)庫文檔的java類
 * @author: 郭秀志 jbcode@126.com
 * @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\\技術(shù)文檔\\sql\\doc";
    private static final EngineFileType FILE_OUTPUT_TYPE = EngineFileType.WORD; // 可以設(shè)置 Word 或者 Markdown 格式
    private static final String DOC_FILE_NAME = "數(shù)據(jù)庫文檔V1.0.0";
    private static final String DOC_VERSION = "1.0.0";
    private static final String DOC_DESCRIPTION = "項(xiàng)目數(shù)據(jù)庫文檔，表包括：接口及運(yùn)管后臺2部分";

    public static void main(String[] args) {
        // 創(chuàng)建 screw 的配置
        Configuration config = Configuration.builder()
                .version(DOC_VERSION)  // 版本
                .description(DOC_DESCRIPTION) // 描述
                .dataSource(buildDataSource()) // 數(shù)據(jù)源
                .engineConfig(buildEngineConfig()) // 引擎配置
                .produceConfig(buildProcessConfig()) // 處理配置
                .build();

        // 執(zhí)行 screw，生成數(shù)據(jù)庫文檔
        new DocumentationExecute(config).execute();
    }

    /**
     * 創(chuàng)建數(shù)據(jù)源
     */
    private static DataSource buildDataSource() {
        // 創(chuàng)建 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"); // 設(shè)置可以獲取 tables remarks 信息
        // 創(chuàng)建數(shù)據(jù)源
        return new HikariDataSource(hikariConfig);
    }

    /**
     * 創(chuàng)建 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();
    }

    /**
     * 創(chuàng)建 screw 的處理配置，一般可忽略
     * 指定生成邏輯、當(dāng)存在指定表、指定表前綴、指定表后綴時(shí)，將生成指定表，其余表不生成、并跳過忽略表配置
     */
    private static ProcessConfig buildProcessConfig() {
        return ProcessConfig.builder()
                .designatedTableName(Collections.<String>emptyList())  // 根據(jù)名稱指定表生成
                .designatedTablePrefix(Collections.<String>emptyList()) //根據(jù)表前綴生成
                .designatedTableSuffix(Collections.<String>emptyList()) // 根據(jù)表后綴生成
                .ignoreTableName(Arrays.asList("test_user", "test_group")) // 忽略表名
                .ignoreTablePrefix(Collections.singletonList("test_")) // 忽略表前綴
                .ignoreTableSuffix(Collections.singletonList("_test")) // 忽略表后綴
                .build();
    }

}

代碼比較簡單,比較重要的變量，已經(jīng)抽取成靜態(tài) 變量，看著修改成自己項(xiàng)目的即可。

2.1.3 簡單測試

執(zhí)行 ScrewMain 程序，進(jìn)行文檔的生成。這里我們生成的是 HTML 文檔，效果如下圖所示：

HTML文檔示例

2.2 使用 Maven 插件的方式

創(chuàng)建 lab-70-db-doc-screw-02 示例項(xiàng)目，使用 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。

<?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>
                    <!-- 數(shù)據(jù)庫連接 -->
                    <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>
                    <!-- 數(shù)據(jù)庫相關(guān)配置 -->
                    <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>數(shù)據(jù)庫文檔</title> <!--標(biāo)題-->
                    <fileName>測試文檔名稱</fileName> <!--文檔名稱 為空時(shí):將采用[數(shù)據(jù)庫名稱-描述-版本號]作為文檔名稱-->
                    <description>數(shù)據(jù)庫文檔生成</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 插件的配置項(xiàng) 比較少，按需修改下 <configuration/> 即可。

2.2.2 簡單測試

執(zhí)行 screw-maven-plugin 插件，會在 doc 目錄下生成文檔。如下圖所示：

三、生成實(shí)體類

screw 的實(shí)現(xiàn)原理，是基于數(shù)據(jù)庫中的表結(jié)構(gòu) ，生成對應(yīng)的文檔。

那么，是否可以自動生成 Java 實(shí)體類呢？答案是可以的，在 screw-extension 項(xiàng)目中，拓展提供了該功能。

這樣，日常開發(fā)中，在我們完成數(shù)據(jù)庫的建表之后，可以直接生成對應(yīng)的 Java 實(shí)體類，避免枯燥的重復(fù)勞動。

下面，我們來快速入門下。創(chuàng)建 lab-70-db-doc-screw-03 示例項(xiàng)目，使用 screw 的 Java 代碼 的方式，生成 Java 實(shí)體類。

示例示例

友情提示：示例代碼的完整地址，可見 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。

<?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 庫，簡潔好用的數(shù)據(jù)庫表結(jié)構(gòu)文檔生成器 -->
        <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>

        <!-- 數(shù)據(jù)庫連接 -->
        <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 項(xiàng)目處于初步開發(fā)階段，暫時(shí)未將該依賴推到 Maven 中央倉庫，所以需要自己克隆項(xiàng)目，進(jìn)行編譯打包到本地。

3.2 ScrewMain

創(chuàng)建 ScrewMain 類，使用 screw 生成 Java 實(shí)體類。代碼如下：

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) {
        // 創(chuàng)建 screw 的配置
        PojoConfiguration config = PojoConfiguration.builder()
                .path(FILE_OUTPUT_DIR) // 生成 POJO 相關(guān)的目錄
                .packageName(JAVA_CLASS_PACKAGE) // 包名
                .nameStrategy(new HumpNameStrategy()) // 包名策略
                .useLombok(false) // 是否使用 Lombok
                .dataSource(buildDataSource()) // 數(shù)據(jù)源
                .processConfig(buildProcessConfig()) // 處理配置
                .build();

        // 執(zhí)行 screw，生成 POJO 實(shí)體類
        new PojoExecute(config).execute();
    }

    /**
     * 創(chuàng)建數(shù)據(jù)源
     */
    private static DataSource buildDataSource() {
        // 創(chuàng)建 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"); // 設(shè)置可以獲取 tables remarks 信息
        // 創(chuàng)建數(shù)據(jù)源
        return new HikariDataSource(hikariConfig);
    }

    /**
     * 創(chuàng)建 screw 的處理配置，一般可忽略
     * 指定生成邏輯、當(dāng)存在指定表、指定表前綴、指定表后綴時(shí)，將生成指定表，其余表不生成、并跳過忽略表配置
     */
    private static ProcessConfig buildProcessConfig() {
        return ProcessConfig.builder()
                .designatedTableName(Collections.<String>emptyList())  // 根據(jù)名稱指定表生成
                .designatedTablePrefix(Collections.<String>emptyList()) //根據(jù)表前綴生成
                .designatedTableSuffix(Collections.<String>emptyList()) // 根據(jù)表后綴生成
                .ignoreTableName(Arrays.asList("test_user", "test_group")) // 忽略表名
                .ignoreTablePrefix(Collections.singletonList("test_")) // 忽略表前綴
                .ignoreTableSuffix(Collections.singletonList("_test")) // 忽略表后綴
                .build();
    }

}

代碼比較簡單，胖友看看注釋即可。不同于上面的快速入門，這里我們使用 PojoConfiguration 作為配置類，使用 PojoExecute 作為執(zhí)行器。

比較重要的變量，已經(jīng)抽取成靜態(tài) 變量，胖友看著修改哈。

3.3 簡單測試

執(zhí)行 ScrewMain 程序，進(jìn)行 Java 實(shí)體類的生成。效果如下圖所示：

Java 實(shí)體類
生成的 Java 實(shí)體類的成員屬性 還不太正確，需要等待作者進(jìn)行下修復(fù)。

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九欧美,1769亚洲,黄色成人av

生成 Java 實(shí)體類和數(shù)據(jù)庫文檔

生成 Java 實(shí)體類和數(shù)據(jù)庫文檔

一、 Screw 簡介

二、快速入門

2.1 使用 Java 代碼的方式

2.1.1 引入依賴

2.1.2 ScrewMain

2.1.3 簡單測試

2.2 使用 Maven 插件的方式

2.2.1 引入插件

2.2.2 簡單測試

三、生成實(shí)體類

3.1 引入依賴

3.2 ScrewMain

3.3 簡單測試

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九 欧美,1769亚洲,黄色成人av

生成 Java 實(shí)體類和數(shù)據(jù)庫文檔

一、 Screw 簡介

二、 快速入門

2.1 使用 Java 代碼的方式

2.1.1 引入依賴

2.1.2 ScrewMain

2.1.3 簡單測試

2.2 使用 Maven 插件的方式

2.2.1 引入插件

2.2.2 簡單測試

三、 生成實(shí)體類

3.1 引入依賴

3.2 ScrewMain

3.3 簡單測試

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容

色偷偷精品伊人,欧洲久久精品,欧美综合婷婷骚逼,国产AV主播,国产最新探花在线,九色在线视频一区,伊人大交九欧美,1769亚洲,黄色成人av

一、 Screw 簡介

二、快速入門

三、生成實(shí)體類