SpringBoot整合screw實現(xiàn)自動生成數(shù)據(jù)庫設(shè)計文檔
前言
最近因為工作的需要,讓我寫數(shù)據(jù)庫設(shè)計文檔,可是我最煩文檔類的工作了,之前寫過一篇文章(在下文補(bǔ)充內(nèi)容中),使用的navicat工作,不過導(dǎo)出的格式是excel不符合格式,還得自己整理,現(xiàn)在用screw 工具包,整合到springboot的項目中便可以自動生成數(shù)據(jù)庫設(shè)計文檔,非常方便,下面就分享一下教程
提示:以下是本篇文章正文內(nèi)容,下面案例可供參考
一、screw 是什么
screw是一個一鍵式生成數(shù)據(jù)庫文檔的開源工具包,目前screw可以生成word、md和html格式類的文檔,支持freemarker和velocity兩種模板引擎。數(shù)據(jù)源支持HikariDataSource,DruidDataSource可能會發(fā)生類型轉(zhuǎn)換報錯。
二、使用步驟
1.引入庫
pom文件中引入jar依賴
<!-- 數(shù)據(jù)庫設(shè)計文檔生成工具-->
<dependency>
<groupId>cn.smallbun.screw</groupId>
<artifactId>screw-core</artifactId>
<version>1.0.5</version>
</dependency>
2.代碼示例
代碼如下(下面用的是postgres數(shù)據(jù)庫):
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.ArrayList;
import java.util.List;
public class DatabaseDesignDocUtil {
public static void main(String[] args) {
documentGeneration();
}
/**
* 文檔生成
*/
public static void documentGeneration() {
//數(shù)據(jù)源
HikariConfig hikariConfig = new HikariConfig();
hikariConfig.setDriverClassName("org.postgresql.Driver");
hikariConfig.setJdbcUrl("jdbc:postgresql://39.164.52.80:5432/work_face");
hikariConfig.setUsername("postgres");
hikariConfig.setPassword("POSTGRES");
//設(shè)置可以獲取tables remarks信息
hikariConfig.addDataSourceProperty("useInformationSchema", "true");
hikariConfig.setMinimumIdle(2);
hikariConfig.setMaximumPoolSize(5);
DataSource dataSource = new HikariDataSource(hikariConfig);
//生成配置
EngineConfig engineConfig = EngineConfig.builder()
//生成文件路徑
.fileOutputDir("C:\\Users\\tarzan\\Desktop\\doc")
//打開目錄
.openOutputDir(true)
//文件類型
.fileType(EngineFileType.WORD)
//生成模板實現(xiàn)
.produceType(EngineTemplateType.freemarker)
//自定義文件名稱
.fileName("智能工作面數(shù)據(jù)庫設(shè)計文檔").build();
//忽略表
List<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();
}
}
需要改成mysql等別的數(shù)據(jù)庫的,請在代碼中改下驅(qū)動配置和連接配置。
三、使用方法
idea等編輯器里,運(yùn)行main的主方法即可。
控制臺輸出示例

生成文檔展示

補(bǔ)充
mysql數(shù)據(jù)庫設(shè)計文檔-導(dǎo)出字段設(shè)計
打開navicat,新建查詢窗口

查詢sql
SELECT TABLE_NAME 表名, COLUMN_NAME 字段名稱, COLUMN_TYPE 字段類型, IF ( IS_NULLABLE = 'YES', '是', '否' ) 是否可為空, IF ( COLUMN_KEY = 'PRI', '是', '否' ) 是否主鍵, COLUMN_COMMENT 字段注釋 FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_SCHEMA = '數(shù)據(jù)庫名稱' -- 數(shù)據(jù)表名,可以不填寫,查詢?nèi)勘斫Y(jié)構(gòu) AND TABLE_NAME = '表名'
查詢結(jié)果

開始導(dǎo)出-圖文描述


點(diǎn)擊下一步,修改導(dǎo)出文件名稱后,再點(diǎn)擊下一步

勾選包含列的標(biāo)題,點(diǎn)擊下一步

點(diǎn)擊開始,進(jìn)行導(dǎo)出

導(dǎo)出完畢,打開導(dǎo)出的excel查看結(jié)果

到這里我們所需要的數(shù)據(jù)庫表結(jié)構(gòu)設(shè)計已經(jīng)出來了,
盡情的修改完善吧,如果需要更多的數(shù)據(jù)和字段定義記住這個表
INFORMATION_SCHEMA
你所需要的表結(jié)構(gòu)都在下面這個表中。感興趣的朋友可以查驗一番。
COLUMNS
到此這篇關(guān)于SpringBoot整合screw實現(xiàn)自動生成數(shù)據(jù)庫設(shè)計文檔的文章就介紹到這了,更多相關(guān)SpringBoot screw自動生成數(shù)據(jù)庫設(shè)計文檔內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Spring實戰(zhàn)之使用@POSTConstruct和@PreDestroy定制生命周期行為操作示例
這篇文章主要介紹了Spring實戰(zhàn)之使用@POSTConstruct和@PreDestroy定制生命周期行為操作,結(jié)合實例形式詳細(xì)分析了Spring使用@POSTConstruct和@PreDestroy定制生命周期相關(guān)接口定義、配置與功能實現(xiàn)技巧,需要的朋友可以參考下2019-12-12
Springboot定時任務(wù)Scheduled重復(fù)執(zhí)行操作
這篇文章主要介紹了Springboot定時任務(wù)Scheduled重復(fù)執(zhí)行操作,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-09-09
C#使用MySQLConnectorNet和MySQLDriverCS操作MySQL的方法
這篇文章主要介紹了C#使用MySQLConnectorNet和MySQLDriverCS操作MySQL的方法,相比普通方法能夠在Windows下簡化很多操作步驟,需要的朋友可以參考下2016-04-04
Spring Boot 約定大于配置之如何實現(xiàn)自定義配置
本文介紹了SpringBoot的“約定大于配置”理念以及如何實現(xiàn)自定義配置,通過實現(xiàn)接口和添加@Configuration注解,開發(fā)者可以靈活地擴(kuò)展和定制SpringBoot的默認(rèn)行為,感興趣的朋友一起看看吧2025-03-03
Springboot?內(nèi)部服務(wù)調(diào)用方式
這篇文章主要介紹了Springboot?內(nèi)部服務(wù)調(diào)用方式,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-03-03
Java打印出所有的水仙花數(shù)的實現(xiàn)代碼
這篇文章主要介紹了Java打印出所有的水仙花數(shù)的實現(xiàn)代碼,需要的朋友可以參考下2017-02-02
Spring Cloud根據(jù)服務(wù)名獲取服務(wù)的ip端口問題
這篇文章主要介紹了Spring Cloud根據(jù)服務(wù)名獲取服務(wù)的ip端口,本篇示例我就以Nacos注冊中心為例了,下面是我注冊的兩個服務(wù),需要的朋友可以參考下2022-09-09

