使用screw把现有数据库快速生成一份数据结构文档

在3年前，当时入职一家公司，没有任何文档，进去之后，发现系统非常的乱，对于架构师来说一般关注的主要有：系统业务、数据。系统业务当时熟悉起来很快，但是主要是系统问题比较多，所以需要进行挨个排查并解决。所以第一步的入手就是从数据入手。当时也没有什么数据库设计文档，所以没办法，就只能直接导出对应的数据库库表结构信息，进行挨个整理。在那个时候就解除了screw。现在几年过去了，又要用上这个工具了。在此记录一下。

screw是一个开源的java工具类jar包，他可以很方便的直接连接数据库，把对应数据库的库表结构自动生成对应的文档，方便可视化显示。下面开始演示。

1、首先创建一个maven的项目。

2、在maven项目里面引入如下依赖包

<dependency>
	<groupId>cn.smallbun.screw</groupId>
	<artifactId>screw-core</artifactId>
	<version>1.0.5</version>
</dependency>
<dependency>
	<groupId>mysql</groupId>
	<artifactId>mysql-connector-java</artifactId>
	<version>8.0.20</version>
</dependency>
<dependency>
	<groupId>com.zaxxer</groupId>
	<artifactId>HikariCP</artifactId>
	<version>3.4.5</version>
</dependency>

3、然后新建一个java文件，把如下代码添加进去

package com.test.delete.screw;

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 ScrewDemo {

	public static void main(String[] args) {
		//数据源    
		   HikariConfig hikariConfig = new HikariConfig();    
		   hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");    
		   hikariConfig.setJdbcUrl("jdbc:mysql://192.168.31.30:3306/ga_upload_bigdata");    
		   hikariConfig.setUsername("root");    
		   hikariConfig.setPassword("123456");    
		   //设置可以获取tables remarks信息    
		   hikariConfig.addDataSourceProperty("useInformationSchema", "true");    
		   hikariConfig.setMinimumIdle(2);    
		   hikariConfig.setMaximumPoolSize(5);    
		   DataSource dataSource = new HikariDataSource(hikariConfig);    
		   //生成配置    
		   EngineConfig engineConfig = EngineConfig.builder()    
		         //生成文件路径    
		         .fileOutputDir("C:\\Users\\Administrator\\Desktop\\fsdownload\\aaa")    
		         //打开目录    
		         .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();    
	}
	
}

上面根据实际的配置进行修改。然后点击运行。就可以看到生成的可视化文档了。