1、官方源码地址

https://gitee.com/leshalv/screw#%E7%AE%80%E4%BB%8B

2、支持数据库和 导出的文档格式

image.png

3、使用

方式一：利用maven插件

1）pom.xml 引入核心依赖

  1.                 <dependency>
  2.             <groupId>cn.smallbun.screw</groupId>
  3.             <artifactId>screw-core</artifactId>
  4.             <version>1.0.3</version>
  5.         </dependency>
  7.         <!-- HikariCP  数据库连接池-->
  8.         <dependency>
  9.             <groupId>com.zaxxer</groupId>
  10.             <artifactId>HikariCP</artifactId>
  11.             <version>3.4.5</version>
  12.         </dependency>
  14.         <!--mysql driver-->
  15.         <dependency>
  16.             <groupId>mysql</groupId>
  17.             <artifactId>mysql-connector-java</artifactId>
  18.             <version>5.1.37</version>
  19.         </dependency>

2）pom.xml 配置 maven 插件

缺点：没有找到指定生成表 和 生成文档路径的 设定
其中：

  • mysql-connector-java 版本根据所连接的数据库版本自行修改
  • mysql 6以上驱动为：com.mysql.cj.jdbc.Driver

mysql 6以下驱动为：com.mysql.jdbc.Driver
根据数据库版本自行修改

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

3）双击 run，生成文档

image.png

4）生成文档位置 及 文档预览

image.png
image.png

方式二：利用工具类

优点：可以自行设定指定表、指定前缀、指定后缀、忽略表、忽略前缀、忽略后缀 等自定义设定
缺点：如果指定表很多，ArrayList designTableName 要手动 一个个 add加进去，不太友好，
如果是统一前缀、后缀 还好，所以以后建表尽量统一前缀
1）写工具类

  1. package com.ruyuan.little.project.spring.utils;
  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;
  12. import javax.sql.DataSource;
  13. import java.util.ArrayList;
  15. /**
  16.  * 生成数据库文档
  17.  *
  18.  * @author wmn
  19.  * @date 2021/8/10
  20.  */
  21. public class GenerateSqlFileUtils {
  23.     /**
  24.      * 文档生成
  25.      */
  26.     public static void documentGeneration() {
  27.         //数据源
  28.         HikariConfig hikariConfig = new HikariConfig();
  29.         //mysql 6以上驱动为：<driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
  30.        // mysql 6以下驱动为：<driverClassName>com.mysql.jdbc.Driver</driverClassName>
  31.         hikariConfig.setDriverClassName("com.mysql.jdbc.Driver");
  32.         hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/w_report_irr_dev");
  33.         hikariConfig.setUsername("root");
  34.         hikariConfig.setPassword("123456");
  35.         //设置可以获取tables remarks信息
  36.         hikariConfig.addDataSourceProperty("useInformationSchema", "true");
  37.         hikariConfig.setMinimumIdle(2);
  38.         hikariConfig.setMaximumPoolSize(5);
  39.         DataSource dataSource = new HikariDataSource(hikariConfig);
  40.         //生成配置
  41.         EngineConfig engineConfig = EngineConfig.builder()
  42.                 //生成文件路径
  43.                 .fileOutputDir("E:\\learnWorkspace\\little-project-spring-week02\\doc")
  44.                 //打开目录
  45.                 .openOutputDir(true)
  46.                 //文件类型
  47.                 .fileType(EngineFileType.HTML)
  48.                 //生成模板实现
  49.                 .produceType(EngineTemplateType.freemarker)
  50.                 //自定义文件名称
  51.                 .fileName("20210810_test_生成数据库文档测试").build();
  53.         //指定表
  54.         ArrayList<String> designTableName = new ArrayList<>();
  55.         designTableName.add("design_table");
  57.         //忽略表
  58.         ArrayList<String> ignoreTableName = new ArrayList<>();
  59.         ignoreTableName.add("test_user");
  60.         ignoreTableName.add("test_group");
  61.         //忽略表前缀
  62.         ArrayList<String> ignorePrefix = new ArrayList<>();
  63.         ignorePrefix.add("test_");
  64.         //忽略表后缀
  65.         ArrayList<String> ignoreSuffix = new ArrayList<>();
  66.         ignoreSuffix.add("_test");
  67.         ProcessConfig processConfig = ProcessConfig.builder()
  68.                 //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
  69.                 //根据名称指定表生成
  70.                 .designatedTableName(designTableName)
  71.                 //根据表前缀生成
  72.                 .designatedTablePrefix(new ArrayList<>())
  73.                 //根据表后缀生成
  74.                 .designatedTableSuffix(new ArrayList<>())
  75.                 //忽略表名
  76.                 .ignoreTableName(ignoreTableName)
  77.                 //忽略表前缀
  78.                 .ignoreTablePrefix(ignorePrefix)
  79.                 //忽略表后缀
  80.                 .ignoreTableSuffix(ignoreSuffix).build();
  81.         //配置
  82.         Configuration config = Configuration.builder()
  83.                 //版本
  84.                 .version("1.0.0")
  85.                 //描述
  86.                 .description("数据库设计文档生成")
  87.                 //数据源
  88.                 .dataSource(dataSource)
  89.                 //生成配置
  90.                 .engineConfig(engineConfig)
  91.                 //生成配置
  92.                 .produceConfig(processConfig)
  93.                 .build();
  94.         //执行生成
  95.         new DocumentationExecute(config).execute();
  96.     }
  98.     public static void main(String[] args) {
  99.         documentGeneration();
  100.     }
  101. }

2）main运行即可
image.png
image.png
image.png