Screw

Screw是什么

Screw是什么？

Screw简洁好用的数据库表结构文档生成工具。
产生背景：在企业级开发中、我们经常会有编写数据库表结构文档的时间付出，从业以来，待过几家企业，关于数据库表结构文档状态：要么没有、要么有、但都是手写、后期运维开发，需要手动进行维护到文档中，很是繁琐、如果忘记一次维护、就会给以后工作造成很多困扰、无形中制造了很多坑留给自己和后人。基于此种背景，作者开发了此款插件工具Screw，并在2020年6月22日进行了开源。
数字孪生，是充分利用物理模型、传感器更新、运行历史等数据，集成多学科、多物理量、多尺度、多概率的仿真过程，在虚拟空间中完成映射，从而反映相对应的实体装备的全生命周期过程。

名字由来？！
Screw (螺丝钉) ：突出它的小，但很重要。

特点

简洁、轻量、设计良好
多数据库支持
多种格式文档
灵活扩展
支持自定义模板

数据库支持

MySQL
MariaDB
TIDB
Oracle
SqlServer
PostgreSQL
Cache DB（2016）

文档生成支持

html
word
markdown

生成文档截图

Screw使用方式(普通方式和Maven插件)

普通方式

引入依赖

cn.smallbun.screw
screw-core
${lastVersion}

编写代码
文档生成代码（续-1）
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 ignoreTableName = new ArrayList<>();
ignoreTableName.add(“test_user”);
ignoreTableName.add(“test_group”);
//忽略表前缀
ArrayList ignorePrefix = new ArrayList<>();
ignorePrefix.add(“test_”);
//忽略表后缀
ArrayList 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();
}

插件方式

cn.smallbun.screw screw-maven-plugin ${lastVersion} com.zaxxer HikariCP 3.4.5 mysql mysql-connector-java 8.0.20 root password com.mysql.cj.jdbc.Driver jdbc:mysql://127.0.0.1:3306/xxxx HTML false freemarker 测试文档名称 数据库文档生成 ${project.version} compile run # Screw扩展模块