超給力，一鍵生成資料庫文件-資料庫表結構逆向工程

字母哥部落格發表於2020-08-04
資料庫

一、解決什麼問題

資料庫文件是我們在企業專案開發中需要交付的文件，通常需要開發人員去手工編寫。編寫完成後，資料庫發生變更又需要手動的進行修改,從而浪費了大量的人力。並且這種文件並沒有什麼技術含量，被安排做這個工作的程式設計師往往自己心裡會有牴觸情緒，悲觀的預期自己在團隊的位置，造成離職也是可能的。如下面的這種文件的內容：

筆者最近在github上面發現一個資料庫文件生成工具：screw（螺絲釘）。該工具能夠通過簡單地配置，快速的根據資料庫表結構進行逆向工程，將資料庫表結構及欄位逆向生成為文件。

二、特點

  • 簡潔、輕量、設計良好
  • 多資料庫支援：MySQL、MariaDB、TIDB、Oracle、 SqlServer、PostgreSQL、Cache DB
  • 多種格式文件: html、word、 markdwon
  • 靈活擴充套件：支援使用者自定義模板和展示樣式修改（freemarker模板）

三、依賴庫探究

mvn中央倉庫檢視最新版本，將如下的maven座標引入到Spring Boot專案中去：

<dependency>
    <groupId>cn.smallbun.screw</groupId>
    <artifactId>screw-core</artifactId>
    <version>1.0.3</version>
</dependency>

從maven倉庫的編譯依賴中可以看到，screw-core其實現依賴瞭如下的內容。重點關注freemarker，因為該專案是使用freemarker作為模板生成文件。

除此之外，screw使用了HikariCP作為資料庫連線池，所以：

  • 你的Spring Boot專案需要引入HikariCP資料庫連線池。
  • 根據你的資料庫型別及版本，引入正確的JDBC驅動

四、開始造作吧

以上的工作都做好之後，我們就可以來配置文件生成引數了。實現文件生成有兩種方式，一種是寫程式碼，一種是使用maven 外掛。

  • 我個人還是比較喜歡使用程式碼的當時，寫一個單元測試用例就可以了，相對獨立，使用方式也靈活。
  • 如果放在pom.xml的外掛配置裡面，讓本就很冗長的pom.xml變的更加的冗長，不喜歡。

所以maven外掛的這種方式我就不給大家演示了，直接把下面的程式碼Ctrl + C/V到你的src/test/java目錄下。簡單的修改配置，執行就可以了

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 org.junit.jupiter.api.Test;

import javax.sql.DataSource;
import java.util.ArrayList;

public class ScrewTest {
  
  @Test
  void testScrew()  {
    //資料來源
    HikariConfig hikariConfig = new HikariConfig();
    hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
    hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/database");
    hikariConfig.setUsername("db-username");
    hikariConfig.setPassword("db-password");
    //設定可以獲取tables remarks資訊
    hikariConfig.addDataSourceProperty("useInformationSchema", "true");
    hikariConfig.setMinimumIdle(2);
    hikariConfig.setMaximumPoolSize(5);
    DataSource dataSource = new HikariDataSource(hikariConfig);

    //生成配置
    EngineConfig engineConfig = EngineConfig.builder()
            //生成檔案路徑
            .fileOutputDir("d://")
            //開啟目錄
            .openOutputDir(true)
            //生成檔案型別：HTML
            .fileType(EngineFileType.HTML)
            //生成模板實現
            .produceType(EngineTemplateType.freemarker)
            .build();

    //忽略表
    ArrayList<String> ignoreTableName = new ArrayList<>();
    ignoreTableName.add("test_user");
    ignoreTableName.add("test_group");
    //忽略表字首
    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(dataSource)
            //生成配置
            .engineConfig(engineConfig)
            //生成配置
            .produceConfig(processConfig)
            .build();
    //執行生成
    new DocumentationExecute(config).execute();

  }
}

在測試用例裡面執行上面的程式碼，就會自動生成資料庫文件到fileOutputDir配置目錄下。

五、效果


歡迎關注我的部落格，裡面有很多精品合集

  • 本文轉載註明出處（必須帶連線，不能只轉文字）：字母哥部落格。

覺得對您有幫助的話，幫我點贊、分享！您的支援是我不竭的創作動力！ 。另外，筆者最近一段時間輸出瞭如下的精品內容，期待您的關注。

相關文章