一、解決什么問題
數(shù)據(jù)庫文檔是我們在企業(yè)項目開發(fā)中需要交付的文檔嗅回，通常需要開發(fā)人員去手工編寫及穗。編寫完成后，數(shù)據(jù)庫發(fā)生變更又需要手動的進行修改,從而浪費了大量的人力绵载。并且這種文檔并沒有什么技術(shù)含量埂陆，被安排做這個工作的程序員往往自己心里會有抵觸情緒，悲觀的預(yù)期自己在團隊的位置娃豹，造成離職也是可能的焚虱。如下面的這種文檔的內(nèi)容：
筆者最近在github上面發(fā)現(xiàn)一個數(shù)據(jù)庫文檔生成工具：screw（螺絲釘）。該工具能夠通過簡單地配置懂版，快速的根據(jù)數(shù)據(jù)庫表結(jié)構(gòu)進行逆向工程鹃栽，將數(shù)據(jù)庫表結(jié)構(gòu)及字段逆向生成為文檔。
二躯畴、特點
- 簡潔民鼓、輕量、設(shè)計良好
- 多數(shù)據(jù)庫支持：MySQL蓬抄、MariaDB丰嘉、TIDB、Oracle嚷缭、 SqlServer饮亏、PostgreSQL耍贾、Cache DB
- 多種格式文檔: html、word路幸、 markdwon
- 靈活擴展：支持用戶自定義模板和展示樣式修改（freemarker模板）
三荐开、依賴庫探究
mvn中央倉庫查看最新版本，將如下的maven坐標(biāo)引入到Spring Boot項目中去：
<dependency>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-core</artifactId>
<version>1.0.3</version>
</dependency>
從maven倉庫的編譯依賴中可以看到简肴，screw-core其實現(xiàn)依賴了如下的內(nèi)容誓焦。重點關(guān)注freemarker，因為該項目是使用freemarker作為模板生成文檔着帽。
除此之外杂伟，screw使用了HikariCP作為數(shù)據(jù)庫連接池，所以：
- 你的Spring Boot項目需要引入HikariCP數(shù)據(jù)庫連接池仍翰。
- 根據(jù)你的數(shù)據(jù)庫類型及版本赫粥，引入正確的JDBC驅(qū)動
四、開始造作吧
以上的工作都做好之后予借，我們就可以來配置文檔生成參數(shù)了越平。實現(xiàn)文檔生成有兩種方式，一種是寫代碼灵迫，一種是使用maven 插件秦叛。
- 我個人還是比較喜歡使用代碼的當(dāng)時，寫一個單元測試用例就可以了瀑粥，相對獨立挣跋，使用方式也靈活。
- 如果放在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() {
//數(shù)據(jù)源
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");
//設(shè)置可以獲取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)
//生成模板實現(xiàn)
.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()
//指定生成邏輯黄琼、當(dāng)存在指定表樊销、指定表前綴、指定表后綴時脏款，將生成指定表围苫，其余表不生成、并跳過忽略表配置
//根據(jù)名稱指定表生成
.designatedTableName(new ArrayList<>())
//根據(jù)表前綴生成
.designatedTablePrefix(new ArrayList<>())
//根據(jù)表后綴生成
.designatedTableSuffix(new ArrayList<>())
//忽略表名
.ignoreTableName(ignoreTableName)
//忽略表前綴
.ignoreTablePrefix(ignorePrefix)
//忽略表后綴
.ignoreTableSuffix(ignoreSuffix).build();
//配置
Configuration config = Configuration.builder()
//版本
.version("1.0.0")
//描述,文檔名稱
.description("數(shù)據(jù)庫設(shè)計文檔生成")
//數(shù)據(jù)源
.dataSource(dataSource)
//生成配置
.engineConfig(engineConfig)
//生成配置
.produceConfig(processConfig)
.build();
//執(zhí)行生成
new DocumentationExecute(config).execute();
}
}
在測試用例里面運行上面的代碼弛矛，就會自動生成數(shù)據(jù)庫文檔到fileOutputDir配置目錄下够吩。
五比然、效果
歡迎關(guān)注我的博客丈氓，里面有很多精品合集
- 本文轉(zhuǎn)載注明出處（必須帶連接，不能只轉(zhuǎn)文字）：字母哥博客。
覺得對您有幫助的話万俗，幫我點贊湾笛、分享！您的支持是我不竭的創(chuàng)作動力闰歪！ 嚎研。另外，筆者最近一段時間輸出了如下的精品內(nèi)容库倘，期待您的關(guān)注临扮。
