2021-05-12 14:32:11
SpringBoot整合screw實現資料庫檔案自動生成的範例程式碼
2020-09-22 15:00:23
有時候資料庫檔案需要整理,可是隻能手動的複製貼上,心中一萬隻草泥馬奔騰而過。。。
screw
簡潔好用的資料庫表結構檔案生成工具。
1. 建立專案
1.1 pom.xml
<dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.30</version> </dependency> <dependency> <groupId>cn.smallbun.screw</groupId> <artifactId>screw-core</artifactId> <version>1.0.5</version> </dependency>
1.2 新建工具類DocumentConfig.java
/** * 檔案生成 */ static void documentGeneration() { //資料來源 HikariConfig hikariConfig = new HikariConfig(); hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver"); hikariConfig.setJdbcUrl("jdbc:mysql://IP地址:3306/資料庫名稱"); hikariConfig.setUsername("使用者名稱"); hikariConfig.setPassword("密碼"); //設定可以獲取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) //檔案型別 .fileType(EngineFileType.HTML) //生成模板實現 .produceType(EngineTemplateType.freemarker) //自定義檔名稱 .fileName("test資料庫").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(); }
1.3 執行該方法
1.4 第二種生成設定
1.4.1 先在application.yml裡面設定資料庫連線資訊:
spring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://IP地址:3306/資料庫名稱 username: 使用者名稱 password: 密碼 xa: properties: useInformationSchema: true
1.4.2 新建test方法
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 org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.context.ApplicationContext; import javax.sql.DataSource; import java.util.ArrayList; import java.util.Arrays; import java.util.List; @SpringBootTest public class ScrewApplicationTests { @Autowired ApplicationContext applicationContext; @Test void contextLoads() { DataSource dataSourceMysql = applicationContext.getBean(DataSource.class); // 生成檔案設定 EngineConfig engineConfig = EngineConfig.builder() // 生成檔案路徑,自己mac原生的地址,這裡需要自己更換下路徑 .fileOutputDir("D:") // 開啟目錄 .openOutputDir(false) // 檔案型別 .fileType(EngineFileType.HTML) // 生成模板實現 .produceType(EngineTemplateType.freemarker).build(); // 生成檔案設定(包含以下自定義版本號、描述等設定連線) Configuration config = Configuration.builder() .version("1.0.0") .description("生成檔案資訊描述") .dataSource(dataSourceMysql) .engineConfig(engineConfig) .produceConfig(getProcessConfig()) .build(); // 執行生成 new DocumentationExecute(config).execute(); } /** * 設定想要生成的表+ 設定想要忽略的表 * @return 生成表設定 */ public static ProcessConfig getProcessConfig(){ // 忽略表名 List<String> ignoreTableName = Arrays.asList("aa","test_group"); // 忽略表字首,如忽略a開頭的資料庫表 List<String> ignorePrefix = Arrays.asList("a","t"); // 忽略表字尾 List<String> ignoreSuffix = Arrays.asList("_test","czb_"); return ProcessConfig.builder() //根據名稱指定表生成 .designatedTableName(new ArrayList<>()) //根據表字首生成 .designatedTablePrefix(new ArrayList<>()) //根據表字尾生成 .designatedTableSuffix(new ArrayList<>()) //忽略表名 .ignoreTableName(ignoreTableName) //忽略表字首 .ignoreTablePrefix(ignorePrefix) //忽略表字尾 .ignoreTableSuffix(ignoreSuffix).build(); } }
1.4.3 執行test方法生成
GitHub程式碼地址:
github.com/zhouzhaodong/springboot/tree/master/spring-boot-screw
到此這篇關於SpringBoot整合screw實現資料庫檔案自動生成的範例程式碼的文章就介紹到這了,更多相關SpringBoot資料庫檔案自動生成內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!
相關文章