screw一键生成数据库设计文档

本文主要是介绍screw一键生成数据库设计文档，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

文章目录

前言
一、screw 是什么？
二、使用步骤
- 1.pom导入依赖
- 2.生成数据库设计文档代码
总结

前言

提示：这里可以添加本文要记录的大概内容：

今天使用了一款非常简单生成数据库文档的小工具，于是记录一下，这款工具就是screw（螺丝钉）

官网地址：https://gitee.com/leshalv/screw

提示：以下是本篇文章正文内容，下面案例可供参考

一、screw 是什么？

screw 这个工具能帮我们自动生成某个数据库所有表的详情文档，可以生成html、word、md格式，生成示例如下：
在这里插入图片描述

二、使用步骤

1.pom导入依赖

    <!-- screw --><dependency><groupId>cn.smallbun.screw</groupId><artifactId>screw-core</artifactId><version>1.0.4</version></dependency><!-- HikariCP -->	<dependency><groupId>com.zaxxer</groupId><artifactId>HikariCP</artifactId><version>2.5.1</version></dependency><!-- mysql --><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>5.1.47</version></dependency><!-- oracle --><dependency><groupId>com.oracle.database.jdbc</groupId><artifactId>ojdbc8</artifactId><version>21.1.0.0</version></dependency>

2.生成数据库设计文档代码

代码如下（示例）：

package com.test;import java.util.ArrayList;import javax.sql.DataSource;import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;import cn.smallbun.screw.core.Configuration;
import cn.smallbun.screw.core.engine.EngineConfig;
import cn.smallbun.screw.core.engine.EngineFileType;
import cn.smallbun.screw.core.engine.EngineTemplateType;
import cn.smallbun.screw.core.execute.DocumentationExecute;
import cn.smallbun.screw.core.process.ProcessConfig;public class Test{public static void main(String[] args) {HikariConfig hikariConfig = new HikariConfig();
//	    hikariConfig.setDriverClassName("com.mysql.jdbc.Driver");//项目中使用的DriverClassName
//	    hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/test");//项目中使用的jdbcUrlhikariConfig.setDriverClassName("oracle.jdbc.driver.OracleDriver");//项目中使用的DriverClassNamehikariConfig.setJdbcUrl("jdbc:oracle:thin:@192.168.1.151:1521:orcl");//项目中使用的jdbcUrlhikariConfig.setUsername("ucas_shenzhen");hikariConfig.setPassword("ucas_shenzhen");//设置可以获取tables remarks信息hikariConfig.addDataSourceProperty("useInformationSchema", "true");hikariConfig.setMinimumIdle(2);hikariConfig.setMaximumPoolSize(5);DataSource dataSource = new HikariDataSource(hikariConfig);//生成配置EngineConfig engineConfig = EngineConfig.builder()//生成文件路径.fileOutputDir("E:\\项目文档")//打开目录.openOutputDir(true)//文件类型.fileType(EngineFileType.HTML)//生成模板实现.produceType(EngineTemplateType.freemarker).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()//忽略表名.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();}
}