数据库设计文档好用的工具

 我和大家分享一个数据库设计文档好用的工具,说到数据库设计文档就离不开我们要把数据中表里面的字段,按照一个表格进行展示出来,那么如何快速把表格中的字段成一个表格展示在文档中呢?来来来跟着我的脚步来看看.

1.首先打开下面的连接

https://gitee.com/leshalv/screw/  (打开看见的页面,可以看到表格的效果)

 文档生成的支持

• html
• word
• markdown

2.引入依赖 (写在pom.xml 出现报红记得刷新依赖进行下载)

<dependencies>
    <dependency>
      <groupId>cn.smallbun.screw</groupId>
      <artifactId>screw-core</artifactId>
      <version>1.0.5</version>
    </dependency>
    <dependency>
      <groupId>com.zaxxer</groupId>
      <artifactId>HikariCP</artifactId>
      <version>2.6.1</version>
      <exclusions>
        <exclusion>
          <groupId>slf4j-api</groupId>
          <artifactId>org.slf4j</artifactId>
        </exclusion>
      </exclusions>
    </dependency>
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>8.0.20</version>
    </dependency>
  </dependencies>

3.创建一个类来写实现代码

public class TestSmallbun {

  public static void main(String[] args) {
    TestSmallbun testSmallbun = new TestSmallbun();
    testSmallbun.documentGeneration();
  }
    /**
     * 文档生成
     */
    void documentGeneration() {
      //数据源
      HikariConfig hikariConfig = new HikariConfig();
      hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
      hikariConfig.setJdbcUrl("jdbc:mysql://jdbc:mysql://127.0.0.1:3306/database?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC");  //已写防止乱码
      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("生成文件路径")  //记得修改
          //打开目录
          .openOutputDir(true)
          //文件类型
          .fileType(EngineFileType.HTML) //可以选择文档类型
          //生成模板实现
          .produceType(EngineTemplateType.freemarker)
          //自定义文件名称
          .fileName("自定义文件名称").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();
    }
  }

3.记得修改我写注释的地方

然后打开文档生成路径的地方就可以看见数据库设计文档了(生成速度嘎嘎快),支持自定义模板.

希望我的文章可以帮助到你，如果有什么不足的地方欢迎大家给我评论，让我们每天都进步一点点，加油 ง •_•)ง。