一、解決什么問題
數據庫文檔是我們在企業項目開發中需要交付的文檔，通常需要開發人員去手工編寫。編寫完成后，數據庫發生變更又需要手動的進行修改,從而浪費了大量的人力。並且這種文檔並沒有什么技術含量，被安排做這個工作的程序員往往自己心里會有抵觸情緒，悲觀的預期自己在團隊的位置，造成離職也是可能的。如下面的這種文檔的內容：
筆者最近在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配置目錄下。
五、效果
歡迎關注我的博客，里面有很多精品合集
- 本文轉載注明出處（必須帶連接，不能只轉文字）：字母哥博客。
覺得對您有幫助的話，幫我點贊、分享！您的支持是我不竭的創作動力！ 。另外，筆者最近一段時間輸出了如下的精品內容，期待您的關注。