devbox
人工智能uu
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

使用Screw一键生成数据库设计文档，解决数据库表太多不利于浏览_数据库文档生成工具

作者：人工智能uu | 2024-07-18 22:20:03

赞

踩

数据库文档生成工具

介绍：Screw是一个用于生成数据库文档的开源工具。它支持从数据库中提取表结构、列信息、索引等元数据，然后将其生成为可视化的文档，Screw支持多种数据库，包括MySQL、Oracle等。

官网地址：https://gitee.com/leshalv/screw

目录

介绍：Screw是一个用于生成数据库文档的开源工具。它支持从数据库中提取表结构、列信息、索引等元数据，然后将其生成为可视化的文档，Screw支持多种数据库，包括MySQL、Oracle等。

1、生成文档

一：添加依赖： 在Spring Boot项目的pom.xml文件中添加Screw的依赖：

二、编写代码工具类

三、生成后的样子

 2、生成html文件

总结

方式一：使用代码生成文档

1：添加依赖： 在Spring Boot项目的pom.xml文件中添加Screw的依赖：

  1. <dependency>
  2.    <groupId>cn.smallbun.screw</groupId>
  3.    <artifactId>screw-core</artifactId>
  4.    <version>1.0.5</version>
  5. </dependency>

2、编写代码工具类

  1. package com.xs.wastesorting.utils;
  2.  
  3. import cn.smallbun.screw.core.Configuration;
  4. import cn.smallbun.screw.core.engine.EngineConfig;
  5. import cn.smallbun.screw.core.engine.EngineFileType;
  6. import cn.smallbun.screw.core.engine.EngineTemplateType;
  7. import cn.smallbun.screw.core.execute.DocumentationExecute;
  8. import cn.smallbun.screw.core.process.ProcessConfig;
  9. import com.zaxxer.hikari.HikariConfig;
  10. import com.zaxxer.hikari.HikariDataSource;
  11.  
  12. import javax.sql.DataSource;
  13. import java.util.ArrayList;
  14. import java.util.List;
  15.  
  16. /**
  17.  * 生成数据库文档工具类
  18.  */
  19. public class DatabaseDesignDocUtil {
  20.  
  21.     public static void main(String[] args) {
  22.         //执行方法
  23.         documentGeneration();
  24.     }
  25.  
  26.     /**
  27.      * 文档生成
  28.      */
  29.     public static void documentGeneration() {
  30.         //数据源
  31.         HikariConfig hikariConfig = new HikariConfig();
  32.         hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
  33.         //数据库连接地址  xxxx是需要连接的数据库名称
  34.         hikariConfig.setJdbcUrl("jdbc:mysql://192.168.1.110:3306/xxxx");
  35.         //数据库用户名
  36.         hikariConfig.setUsername("root");
  37.         //数据库密码
  38.         hikariConfig.setPassword("root");
  39.         //设置可以获取tables remarks信息
  40.         hikariConfig.addDataSourceProperty("useInformationSchema", "true");
  41.         hikariConfig.setMinimumIdle(2);
  42.         hikariConfig.setMaximumPoolSize(5);
  43.         DataSource dataSource = new HikariDataSource(hikariConfig);
  44.         //生成配置
  45.         EngineConfig engineConfig = EngineConfig.builder()
  46.                 //生成文件路径
  47.                 .fileOutputDir("G:\\dbDoc\\")
  48.                 //打开目录
  49.                 .openOutputDir(true)
  50.                 //文件类型
  51.                 .fileType(EngineFileType.WORD)
  52.                 //生成模板实现
  53.                 .produceType(EngineTemplateType.freemarker)
  54.                 //自定义文件名称
  55.                 .fileName("萧山垃圾分类数据库设计文档").build();
  56.  
  57.         //忽略表
  58.         List<String> ignoreTableName = new ArrayList<>();
  59.         ignoreTableName.add("test_user");
  60.         ignoreTableName.add("test_group");
  61.         //忽略表前缀
  62.         ArrayList<String> ignorePrefix = new ArrayList<>();
  63.         ignorePrefix.add("ia_");
  64.         ignorePrefix.add("ie_");
  65.         ignorePrefix.add("sys_");
  66.         ignorePrefix.add("im_");
  67.         //忽略表后缀
  68.         ArrayList<String> ignoreSuffix = new ArrayList<>();
  69.         ignoreSuffix.add("_test");
  70.         ProcessConfig processConfig = ProcessConfig.builder()
  71.                 //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
  72.                 //根据名称指定表生成
  73.                 .designatedTableName(new ArrayList<>())
  74.                 //根据表前缀生成
  75.                 .designatedTablePrefix(new ArrayList<>())
  76.                 //根据表后缀生成
  77.                 .designatedTableSuffix(new ArrayList<>())
  78.                 //忽略表名
  79.                 .ignoreTableName(ignoreTableName)
  80.                 //忽略表前缀
  81.                 .ignoreTablePrefix(ignorePrefix)
  82.                 //忽略表后缀
  83.                 .ignoreTableSuffix(ignoreSuffix).build();
  84.         //配置
  85.         Configuration config = Configuration.builder()
  86.                 //版本
  87.                 .version("1.0.0")
  88.                 //描述
  89.                 .description("数据库设计文档生成")
  90.                 //数据源
  91.                 .dataSource(dataSource)
  92.                 //生成配置
  93.                 .engineConfig(engineConfig)
  94.                 //生成配置
  95.                 .produceConfig(processConfig)
  96.                 .build();
  97.         //执行生成
  98.         new DocumentationExecute(config).execute();
  99.     }
  100.  
  101.  
  102. }

3、生成后的样子

 4、生成html文件

  1. import cn.smallbun.screw.core.Configuration;
  2. import cn.smallbun.screw.core.execute.DocumentationExecute;
  3. import cn.smallbun.screw.core.process.ProcessConfig;
  4. import cn.smallbun.screw.core.process.ProcessConfigBuilder;
  5. import cn.smallbun.screw.core.process.ProcessFileType;
  6. import cn.smallbun.screw.core.process.ProcessManager;
  7. import cn.smallbun.screw.core.process.container.AbstractContainer;
  8. import cn.smallbun.screw.core.process.container.DefaultFileOutput;
  9. import cn.smallbun.screw.core.process.container.DefaultTableStructure;
  10. import cn.smallbun.screw.core.process.container.FileOutput;
  11. import cn.smallbun.screw.core.process.control.ProcessControlConfig;
  12. import cn.smallbun.screw.core.util.StringUtils;
  13. import org.springframework.boot.SpringApplication;
  14. import org.springframework.boot.autoconfigure.SpringBootApplication;
  15.  
  16. import javax.sql.DataSource;
  17. import java.util.ArrayList;
  18. import java.util.Arrays;
  19. import java.util.List;
  20.  
  21. @SpringBootApplication
  22. public class DatabaseDocGeneratorApplication {
  23.  
  24.     public static void main(String[] args) {
  25.         SpringApplication.run(DatabaseDocGeneratorApplication.class, args);
  26.  
  27.         // 数据库连接配置
  28.         DataSource dataSource = // 获取您的数据源;
  29.  
  30.         // 文档生成配置
  31.         Configuration config = Configuration.builder()
  32.                 .version("1.0.0")
  33.                 .dataSource(dataSource)
  34.                 .engineConfig(getEngineConfig())
  35.                 .produceConfig(getProcessConfig())
  36.                 .build();
  37.  
  38.         // 文档生成执行
  39.         new DocumentationExecute(config).execute();
  40.     }
  41.  
  42.     private static ProcessConfig getProcessConfig() {
  43.         ProcessConfig processConfig = ProcessConfig.builder()
  44.                 .fileOutput(getFileOutput())
  45.                 .processType(ProcessFileType.HTML)  // 生成HTML格式的文档
  46.                 .build();
  47.         processConfig.getPackageConfig().setUrl("your.package.name");  // 设置需要生成文档的包路径
  48.         return processConfig;
  49.     }
  50.  
  51.     private static FileOutput getFileOutput() {
  52.         return new DefaultFileOutput("database-documentation", "");  // 指定输出目录
  53.     }
  54.  
  55.     private static AbstractContainer getEngineConfig() {
  56.         ProcessControlConfig processControlConfig = ProcessControlConfig.builder()
  57.                 .designatedTableName(new ArrayList<>())
  58.                 .ignoreTableName(Arrays.asList("your_ignore_table_1", "your_ignore_table_2"))  // 忽略不生成文档的表名
  59.                 .build();
  60.         return new DefaultTableStructure(processControlConfig);
  61.     }
  62. }
最后直接运行main方法即可生成数据库设计文档！

方式二：使用maven插件生成

1、注意：使用maven插件依旧要引入screw依赖

  1. <dependency>
  2.     <groupId>cn.smallbun.screw</groupId>
  3.     <artifactId>screw-core</artifactId>
  4.     <version>1.0.5</version>
  5. </dependency>

2、引入maven插件

  1. <build>
  2.     <plugins>
  3.         <plugin>
  4.             <groupId>cn.smallbun.screw</groupId>
  5.             <artifactId>screw-maven-plugin</artifactId>
  6.             <version>${lastVersion}</version>
  7.             <dependencies>
  8.                 <!-- HikariCP -->
  9.                 <dependency>
  10.                     <groupId>com.zaxxer</groupId>
  11.                     <artifactId>HikariCP</artifactId>
  12.                     <version>3.4.5</version>
  13.                 </dependency>
  14.                 <!--mysql driver-->
  15.                 <dependency>
  16.                     <groupId>mysql</groupId>
  17.                     <artifactId>mysql-connector-java</artifactId>
  18.                     <version>8.0.20</version>
  19.                 </dependency>
  20.             </dependencies>
  21.             <configuration>
  22.                 <!--username-->
  23.                 <username>登录名</username>
  24.                 <!--password-->
  25.                 <password>数据库密码</password>
  26.                 <!--driver-->
  27.                 <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
  28.                 <!--jdbc url 数据库连接地址-->
  29.                 <jdbcUrl>jdbc:mysql://127.0.0.1:3306/xxxx?serverTimezone=UTC</jdbcUrl>
  30.                 <!--生成文件类型-->
  31.                 <fileType>HTML</fileType>
  32.                 <!--打开文件输出目录-->
  33.                 <openOutputDir>false</openOutputDir>
  34.                 <!--生成模板-->
  35.                 <produceType>freemarker</produceType>
  36.                 <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->
  37.                 <fileName>测试文档名称</fileName>
  38.                 <!--描述-->
  39.                 <description>数据库文档生成</description>
  40.                 <!--版本-->
  41.                 <version>${project.version}</version>
  42.                 <!--标题-->
  43.                 <title>数据库文档</title>
  44.             </configuration>
  45.             <executions>
  46.                 <execution>
  47.                     <phase>compile</phase>
  48.                     <goals>
  49.                         <goal>run</goal>
  50.                     </goals>
  51.                 </execution>
  52.             </executions>
  53.         </plugin>
  54.     </plugins>
  55. </build>

3、运行maven插件

生成html文档

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/人工智能uu/article/detail/848046
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号