项目实战-自动生成文档工具

1.pom 文件

<dependency><groupId>cn.smallbun.screw</groupId><artifactId>screw-core</artifactId><version>1.0.5</version></dependency>

1.填写 自己连接信息

package com.baoku.database;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 org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import javax.sql.DataSource; import java.util.ArrayList;@SpringBootApplication public class SpringbootDatabaseDocApplication {public static void main(String[] args) {SpringApplication.run(SpringbootDatabaseDocApplication.class, args);}/*** 文档生成*/@Testvoid documentGeneration() {//数据源HikariConfig hikariConfig = new HikariConfig();hikariConfig.setReadOnly(true);//OraclehikariConfig.setDriverClassName("oracle.jdbc.OracleDriver");hikariConfig.setJdbcUrl("");hikariConfig.setUsername("");hikariConfig.setPassword("");//Mysql // hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver"); // hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/database"); // hikariConfig.setUsername("root"); // hikariConfig.setPassword("password");//设置可以获取tables remarks信息hikariConfig.addDataSourceProperty("useInformationSchema", "true");hikariConfig.setMinimumIdle(2);hikariConfig.setMaximumPoolSize(5);DataSource dataSource = new HikariDataSource(hikariConfig);//生成配置EngineConfig engineConfig = EngineConfig.builder()//生成文件路径.fileOutputDir("E:/data")//打开目录.openOutputDir(true)//文件类型.fileType(EngineFileType.WORD)//生成模板实现.produceType(EngineTemplateType.freemarker)//自定义文件名称.fileName("CASME").build();//忽略表ArrayList<String> ignoreTableName = new ArrayList<>();ignoreTableName.add("test_user");ignoreTableName.add("test_group");ignoreTableName.add("REAL_LIST_TABLE");ignoreTableName.add("LOGMNR");ignoreTableName.add("TABLED");//忽略表前缀ArrayList<String> ignorePrefix = new ArrayList<>();ignorePrefix.add("test_");ignorePrefix.add("FREE_");ignorePrefix.add("SALE_");ignorePrefix.add("QRTZ_");ignorePrefix.add("HOTEL_");//忽略表后缀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();}}

总结

以上是生活随笔为你收集整理的项目实战-自动生成文档工具的全部内容，希望文章能够帮你解决所遇到的问题。

如果觉得生活随笔网站内容还不错，欢迎将生活随笔推荐给好友。