screw一键生成数据库文档，再也不用复制粘贴啦

1.screw(螺丝钉)

为了方便生成数据库文档，就不需要我们一个一个的去复制粘贴这么麻烦了

2.screw特点

简洁、轻量、设计良好

多数据库支持

多种格式文档

灵活扩展

支持自定义模板

3.数据库支持

MySQL
MariaDB
TIDB
Oracle
SqlServer
PostgreSQL
Cache DB（2016）
H2 （开发中）
DB2 （开发中）
HSQL （开发中）
SQLite（开发中）
瀚高（开发中）
达梦 （开发中）
虚谷 （开发中）
人大金仓（开发中）

4.文档生成支持

HTML，WORD，MD

5.使用方式

小编在这创建了一个springboot项目，用来测试

5.1.引入pom依赖

  <!-- screw核心 -->
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.3</version>
        </dependency>

        <!-- HikariCP  数据库连接池-->
        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>3.4.5</version>
        </dependency>

        <!--mysql driver-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.20</version>
        </dependency>

5.2.两种实现方式

导入上面的pom依赖之后

①Maven插件

  <build>
        <plugins>
   		   <plugin>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-maven-plugin</artifactId>
                    </plugin>
                    <plugin>
                        <groupId>cn.smallbun.screw</groupId>
                        <artifactId>screw-maven-plugin</artifactId>
                        <version>1.0.3</version>
                        <dependencies>
                            <!-- HikariCP -->
                            <dependency>
                                <groupId>com.zaxxer</groupId>
                                <artifactId>HikariCP</artifactId>
                                <version>3.4.5</version>
                            </dependency>
                            <!--mysql driver-->
                            <dependency>
                                <groupId>mysql</groupId>
                                <artifactId>mysql-connector-java</artifactId>
                                <version>8.0.20</version>
                            </dependency>
                        </dependencies>
                        <configuration>
                            <!--username-->
                            <username>root</username>
                            <!--password-->
                            <password>mima</password>
                            <!--driver-->
                            <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
                            <!--jdbc url-->
                            <jdbcUrl>jdbc:mysql://104.53.53.234:3306/test</jdbcUrl>
                            <!--生成文件类型-->
                            <fileType>HTML</fileType>
                            <!--打开文件输出目录-->
                            <openOutputDir>false</openOutputDir>
                            <!--生成模板-->
                            <produceType>freemarker</produceType>
                            <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->
                            <!--<docName>测试文档名称</docName>-->
                            <!--描述-->
                            <description>数据库文档生成</description>
                            <!--版本-->
                            <version>${project.version}</version>
                            <!--标题-->
                            <title>数据库文档</title>
                        </configuration>
                        <executions>
                            <execution>
                                <phase>compile</phase>
                                <goals>
                                    <goal>run</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>

        </plugins>
    </build>

写入maven插件，然后双击运行

生成文档的位置

②代码实现

package com.wr.learn01;

import java.util.Arrays;
import java.util.List;

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

	public static void main(String[] args) {
		// 数据源
		HikariConfig hikariConfig = new HikariConfig();
		hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
		hikariConfig.setJdbcUrl("jdbc:mysql://104.53.53.245:3306/test");
		hikariConfig.setUsername("root");
		hikariConfig.setPassword("mima");
		// 设置可以获取tables remarks信息
		hikariConfig.addDataSourceProperty("useInformationSchema", "true");
		hikariConfig.setMinimumIdle(2);
		hikariConfig.setMaximumPoolSize(5);
		DataSource dataSource = new HikariDataSource(hikariConfig);

		// 1、生成文件配置
		EngineConfig engineConfig = EngineConfig.builder()
				// 生成文件路径
				.fileOutputDir("E:/")
				// 打开目录
				.openOutputDir(false)
				// 文件类型
				.fileType(EngineFileType.HTML)
				// 生成模板实现
				.produceType(EngineTemplateType.freemarker).build();

		// 忽略表名
		List<String> ignoreTableName = Arrays.asList("test");
		// 忽略表前缀
		List<String> ignorePrefix = Arrays.asList("test_", "test");
		// 忽略表后缀
		List<String> ignoreSuffix = Arrays.asList("_test", "test");

		// 2、配置想要忽略的表
		ProcessConfig processConfig = ProcessConfig.builder().ignoreTableName(ignoreTableName)
				.ignoreTablePrefix(ignorePrefix).ignoreTableSuffix(ignoreSuffix).build();

		// 3、生成文档配置（包含以下自定义版本号、描述等配置连接）
		Configuration config = Configuration.builder().version("1.0.0").description("数据库文档").dataSource(dataSource)
				.engineConfig(engineConfig).produceConfig(processConfig).build();

		// 4、执行生成
		new DocumentationExecute(config).execute();
	}

}

直接运行即可，最后生成 的位置在E目录下

最后效果