一、引入依赖
<dependencies> <!--SpringBoot相关依赖--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--screw 数据库文档生成--> <dependency> <groupId>cn.smallbun.screw</groupId> <artifactId>screw-core</artifactId> <version>1.0.5</version> </dependency> <!--mysql 驱动--> <dependency> <groupId>com.mysql</groupId> <artifactId>mysql-connector-j</artifactId> <version>8.0.33</version> </dependency> <!--连接池--> <dependency> <groupId>com.zaxxer</groupId> <artifactId>HikariCP</artifactId> <version>3.4.5</version> </dependency> </dependencies>
二、主要代码
public class ScrewTest { void documentGeneration() { //生成配置 EngineConfig engineConfig = EngineConfig.builder() //生成文件路径 .fileOutputDir("G:\\cql\\wp-db-word") //打开目录 .openOutputDir(true) //文件类型 .fileType(EngineFileType.WORD) //生成模板实现 .produceType(EngineTemplateType.freemarker) //自定义文件名，不填默认数据库名称 // .fileName("自定义文件名称") .build(); //数据库名称 String[] dbNames = {"tenant_management", "tenant", "tenant_cloudcall", "tenant_device", "tenant_members", "tenant_questionnaire", "config"}; for (String dbName : dbNames) { //数据源 HikariConfig hikariConfig = new HikariConfig(); hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver"); hikariConfig.setJdbcUrl("jdbc:mysql://192.168.16.25:3306/"+ dbName +"?characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=GMT%2B8&allowMultiQueries=true&allowPublicKeyRetrieval=true"); hikariConfig.setUsername("root"); hikariConfig.setPassword("root"); //设置可以获取tables remarks信息 hikariConfig.addDataSourceProperty("useInformationSchema", "true"); hikariConfig.setMinimumIdle(2); hikariConfig.setMaximumPoolSize(5); DataSource dataSource = new HikariDataSource(hikariConfig); //配置 Configuration config = Configuration.builder() //版本 .version("1.0.0") //描述 .description("数据库设计文档生成") //数据源 .dataSource(dataSource) //生成配置 .engineConfig(engineConfig) //生成配置 .produceConfig(getProcessConfig()) .build(); //执行生成 new DocumentationExecute(config).execute(); } } /** * 配置想要生成的表+ 配置想要忽略的表 * @return 生成表配置 */ public static ProcessConfig getProcessConfig(){ // 忽略表名 List<String> ignoreTableName = Arrays.asList("testa_testa","testb_testb"); // 忽略表前缀 List<String> ignorePrefix = Arrays.asList("testa","testb"); // 忽略表后缀 List<String> ignoreSuffix = Arrays.asList("_testa","_testb"); return ProcessConfig.builder() //根据名称指定表生成 我需要生成所有表 这里暂时不设置 .designatedTableName(new ArrayList<>()) //根据表前缀生成 我需要生成所有表 这里暂时不设置 .designatedTablePrefix(new ArrayList<>()) //根据表后缀生成 我需要生成所有表 这里暂时不设置 .designatedTableSuffix(new ArrayList<>()) //忽略表名 .ignoreTableName(ignoreTableName) //忽略表前缀 .ignoreTablePrefix(ignorePrefix) //忽略表后缀 .ignoreTableSuffix(ignoreSuffix).build(); }
三、生成文档
