一、简介
🚀 screw (螺丝钉) 英:[
skruː] ~ 简洁好用的数据库表结构文档生成工具
在企业级开发中、我们经常会有编写数据库表结构文档的时间付出，从业以来，待过几家企业，关于数据库表结构文档状态：要么没有、要么有、但都是手写、后期运维开发，需要手动进行维护到文档中，很是繁琐、如果忘记一次维护、就会给以后工作造成很多困扰、无形中制造了很多坑留给自己和后人，于是萌生了要自己写一个插件工具的想法，但由于自己前期在程序设计上没有很多造诣，且能力偏低，有想法并不能很好实现，随着工作阅历的增加，和知识的不断储备，终于在2020年的3月中旬开始进行编写，4月上旬完成初版，想完善差不多在开源，但由于工作太忙，业余时间不足，没有在进行完善，到了6月份由于工作原因、频繁设计和更改数据库、经常使用自己写的此插件、节省了很多时间，解决了很多问题 ，在仅有且不多的业余时间中、进行开源准备，于2020年6月22日，开源，欢迎大家使用、建议、并贡献。
关于名字，想一个太难了，好在我这个聪明的小脑瓜灵感一现，怎么突出它的小，但重要呢？从小就学过雷锋的螺丝钉精神，摘自雷锋日记：虽然是细小的螺丝钉，是个细微的小齿轮，然而如果缺了它，那整个的机器就无法运转了，慢说是缺了它，即使是一枚小螺丝钉没拧紧，一个小齿轮略有破损，也要使机器的运转发生故障的...，感觉自己写的这个工具，很有这意味，虽然很小、但是开发中缺了它还不行，于是便起名为screw（螺丝钉）。
特点
简洁、轻量、设计良好
多数据库支持
多种格式文档
灵活扩展
支持自定义模板
数据库支持
MySQL
MariaDB
TIDB
Oracle
SqlServer
PostgreSQL
Cache DB（2016）
二、依赖文件
<!-- screw核心 --> <dependency> <groupId>cn.smallbun.screw</groupId> <artifactId>screw-core</artifactId> <version>1.0.5</version> </dependency> <!-- HikariCP --> <dependency> <groupId>com.zaxxer</groupId> <artifactId>HikariCP</artifactId> <version>5.0.1</version> </dependency> <!--mysql driver--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.32</version> </dependency>
三、代码实现
@Test void contextLoads() { // 数据源 HikariConfig hikariConfig = new HikariConfig(); hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver"); // hikariConfig.setJdbcUrl("数据库-地址"); hikariConfig.setJdbcUrl("jdbc:mysql://xx.xx.xx.xx:3306/adapt_portal_cloud?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8"); // hikariConfig.setUsername("数据库-用户名"); hikariConfig.setUsername("xxx"); // hikariConfig.setPassword("数据库-密码"); hikariConfig.setPassword("xxx"); // 设置可以获取tables remarks信息 hikariConfig.addDataSourceProperty("useInformationSchema", "true"); hikariConfig.setMinimumIdle(2); hikariConfig.setMaximumPoolSize(5); DataSource dataSource = new HikariDataSource(hikariConfig); // 生成配置 EngineConfig engineConfig = EngineConfig.builder() // 生成文件路径 // .fileOutputDir("生成文档保存本地路径") .fileOutputDir("C:\\Users\\xxx\\Desktop") // 打开目录 设置为true执行完代码后会自动打开对应路径文件夹 .openOutputDir(true) // 文件类型,.html .doc .md类型 // .fileType(EngineFileType.HTML) .fileType(EngineFileType.WORD) // 生成模板实现 .produceType(EngineTemplateType.freemarker).build(); // 忽略表,这些表不会在文档中生成 ArrayList<String> ignoreTableName = new ArrayList<>(); // ignoreTableName.add("test_user"); // ignoreTableName.add("test_group"); // 忽略表前缀,这些表不会在文档中生成 ArrayList<String> ignorePrefix = new ArrayList<>(); ignorePrefix.add("gen_"); ignorePrefix.add("td_"); ignorePrefix.add("ns_"); // 忽略表后缀,这些表不会在文档中生成 ArrayList<String> ignoreSuffix = new ArrayList<>(); ignoreSuffix.add("_test"); ProcessConfig processConfig = ProcessConfig.builder() // 忽略表名 .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(); }
https://gitee.com/leshalv/screw
