springboot~Screw生成数据库文档(springboot生成csv文件)

  本篇文章为你整理了springboot~Screw生成数据库文档(springboot生成csv文件)的详细内容,包含有springboot生成文件 springboot生成csv文件 springboot生成报表 springboot 文档自动生成 springboot~Screw生成数据库文档,希望能帮助你了解 springboot~Screw生成数据库文档。

  数据库说明文档,在我们开发项目时是非常必要的,有时项目交付时,客户也是需要让我们提供的,而如果人工编写,比如耗时,通过screw组件来生成文档,非常方便。

  源代码和使用:https://github.com/pig-mesh/screw

  

 dependency 

 

   groupId cn.smallbun.screw /groupId

   artifactId screw-core /artifactId

   version 1.0.3 /version

   /dependency

  

 

  编写生成数据库代码

  

@Test

 

  public void documentGeneration() {

   // 数据源

   HikariConfig hikariConfig = new HikariConfig();

   hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");

   hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/pig");

   hikariConfig.setUsername("root");

   hikariConfig.setPassword("123456");

   // 设置可以获取tables remarks信息

   hikariConfig.addDataSourceProperty("useInformationSchema", "true");

   hikariConfig.setMinimumIdle(2);

   hikariConfig.setMaximumPoolSize(5);

   DataSource dataSource = new HikariDataSource(hikariConfig);

   // 生成配置

   EngineConfig engineConfig = EngineConfig.builder()

   // 生成文件路径

   .fileOutputDir("d:\\数据库说明文档screw")

   // 打开目录

   .openOutputDir(true)

   // 文件类型

   .fileType(EngineFileType.HTML)

   // 生成模板实现

   .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()

   // 指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时,将生成指定表,其余表不生成、并跳过忽略表配置

   // 根据名称指定表生成

   .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();

  

 

  以上就是springboot~Screw生成数据库文档(springboot生成csv文件)的详细内容,想要了解更多 springboot~Screw生成数据库文档的内容,请持续关注盛行IT软件开发工作室。

郑重声明:本文由网友发布,不代表盛行IT的观点,版权归原作者所有,仅为传播更多信息之目的,如有侵权请联系,我们将第一时间修改或删除,多谢。

留言与评论(共有 条评论)
   
验证码: