screw 数据库文档生成工具

在企业级开发中、我们经常会有编写数据库表结构文档的时间付出，从业以来，待过几家企业，关于数据库表结构文档状态：要么没有、要么有、但都是手写、后期运维开发，需要手动进行维护到文档中，很是繁琐、如果忘记一次维护、就会给以后工作造成很多困扰、无形中制造了很多坑留给自己和后人，于是萌生了要自己写一个插件工具的想法，但由于自己前期在程序设计上没有很多造诣，且能力偏低，有想法并不能很好实现，随着工作阅历的增加，和知识的不断储备，终于在2020年的3月中旬开始进行编写，4月上旬完成初版，想完善差不多在开源，但由于工作太忙，业余时间不足，没有在进行完善，到了6月份由于工作原因、频繁设计和更改数据库、经常使用自己写的此插件、节省了很多时间，解决了很多问题，在仅有且不多的业余时间中、进行开源准备，于2020年6月22日，开源，欢迎大家使用、建议、并贡献。
关于名字，想一个太难了，好在我这个聪明的小脑瓜灵感一现，怎么突出它的小，但重要呢？从小就学过雷锋的螺丝钉精神，摘自雷锋日记：虽然是细小的螺丝钉，是个细微的小齿轮，然而如果缺了它，那整个的机器就无法运转了，慢说是缺了它，即使是一枚小螺丝钉没拧紧，一个小齿轮略有破损，也要使机器的运转发生故障的...，感觉自己写的这个工具，很有这意味，虽然很小、但是开发中缺了它还不行，于是便起名为screw（螺丝钉）。

特点

数据库支持

文档生成支持

文档截图

使用方式

普通方式

<dependency>  <groupId>cn.smallbun.screw</groupId>  <artifactId>screw-core</artifactId>  <version>${lastVersion}</version>  </dependency>

/**  * 文档生成  */ void documentGeneration() {  //数据源  HikariConfig hikariConfig = new HikariConfig();  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(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(); }

Maven 插件

<build>  <plugins>  <plugin>  <groupId>cn.smallbun.screw</groupId>  <artifactId>screw-maven-plugin</artifactId>  <version>${lastVersion}</version>  <dependencies>  <!-- HikariCP -->  <dependency>  <groupId>com.zaxxer</groupId>  <artifactId>HikariCP</artifactId>  <version>3.4.5</version>  </dependency>  <!--mysql driver-->  <dependency>  <groupId>mysql</groupId>  <artifactId>mysql-connector-java</artifactId>  <version>8.0.20</version>  </dependency>  </dependencies>  <configuration>  <!--username-->  <username>root</username>  <!--password-->  <password>password</password>  <!--driver-->  <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>  <!--jdbc url-->  <jdbcUrl>jdbc:mysql://127.0.0.1:3306/xxxx</jdbcUrl>  <!--生成文件类型-->  <fileType>HTML</fileType>  <!--打开文件输出目录-->  <openOutputDir>false</openOutputDir>  <!--生成模板-->  <produceType>freemarker</produceType>  <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->  <fileName>测试文档名称</docName>  <!--描述-->  <description>数据库文档生成</description>  <!--版本-->  <version>${project.version}</version>  <!--标题-->  <title>数据库文档</title>  </configuration>  <executions>  <execution>  <phase>compile</phase>  <goals>  <goal>run</goal>  </goals>  </execution>  </executions>  </plugin>  </plugins> </build>