大家好，我是TJ
一个励志推荐10000款开源项目与工具的程序员
大家后，我是TJ
不知道你是否跟我一样，每天除了写代码之外，还要写不少文档。目前已经有不少工具帮助我们减少工作量，比如使用Swagger自动生成API文档，那么你的数据库表结构文档是不是还在手写呢？
今天给大家推荐的就是一个提高效率的自动生成神器：Screw
关于这个工具的名字，也是很有意思，作者说从小就学过雷锋的螺丝钉精神，摘自雷锋日记：虽然是细小的螺丝钉，是个细微的小齿轮，然而如果缺了它，那整个的机器就无法运转了，慢说是缺了它，即使是一枚小螺丝钉没拧紧，一个小齿轮略有破损，也要使机器的运转发生故障的...，感觉自己写的这个工具，很有这意味，虽然很小、但是开发中缺了它还不行，于是便起名为Screw（螺丝钉）。
目前Screw已经支持大部分我们日常使用的数据库，包括：
MySQL
MariaDB
TIDB
Oracle
SqlServer
PostgreSQL
Cache DB（2016）
H2 （开发中）
DB2 （开发中）
HSQL （开发中）
SQLite（开发中）
瀚高（开发中）
达梦 （开发中）
虚谷 （开发中）
人大金仓（开发中）
而生成的文档包含这些格式：
html
word
markdown
最后生成效果如下：
这么好用的工具是不是使用起来很复杂呢？一点也不！
你只需要下面几步：
1. 引入依赖：
<dependency><groupId>cn.smallbun.screw</groupId><artifactId>screw-core</artifactId><version>${lastVersion}</version></dependency>
2. 添加代码：
/*** 文档生成*/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();}
不知道这个项目是否可以帮助你提高效率饿呢？如果可以的话，记得点赞、关注、分享到朋友圈哦～
项目地址：https://gitee.com/leshalv/screw
往期推荐
点击下方卡片，关注公众号“TJ君”
每天了解一个牛x、好用、有趣的东东