Screw入门使用

效果：

使用方式一：

1.新建maven项目

2.在pom文件中添加螺丝钉依赖，以及所需数据库连接依赖

<!--数据路连接池-->
        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>3.4.5</version>
        </dependency>
        <!--测试-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>

        <!-- 导入数据库依赖-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.11</version>
            <scope>runtime</scope>
        </dependency>
        <!-- 导入Screw核心依赖-->
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.5</version>
        </dependency>

3.创建测试类

package org.tianshui;

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;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import org.junit.Test;

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

public class Screw {

    @Test
    public void test() {
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/web_tv?characterEncoding=utf-8&serverTimezone=UTC");
        hikariConfig.setUsername("root");
        hikariConfig.setPassword("root");

        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema","true");
        //池中维护的最小空闲连接数
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        HikariDataSource dataSourceMysql = new HikariDataSource(hikariConfig);

        // 生成文件配置
        EngineConfig engineConfig = EngineConfig.builder()
                // 生成文件路径
                .fileOutputDir("D:/sqlFile/ProductExperienceCenter")
                // 打开目录
                .openOutputDir(true)
                // 文件类型
                .fileType(EngineFileType.HTML)
                // 生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .fileName("自定义文件名称").build();
        Configuration config = Configuration.builder()
                //版本
                .version("V1.0")
                //标题
                .title("产品体验中心数据库文档")
                //描述
                .description("web_tv数据库文档信息描述")
                //数据源
                .dataSource(dataSourceMysql)
                //生成文件配置
                .engineConfig(engineConfig)
                //生成表配置
                .produceConfig(getProcessConfig())
                .build();
        // 执行生成
        new DocumentationExecute(config).execute();
    }

    /**
     *
     * @return 生成表配置(配置哪些表信息需要生成)
     */
    public static ProcessConfig getProcessConfig() {
        // 按表名忽略生成
        List<String> ignoreTableName = Arrays.asList("test", "test1");
        // 按表名前缀忽略生成
        List<String> ignorePrefix = Arrays.asList("test", "test2");
        // 按表名后缀忽略生成
        List<String> ignoreSuffix = Arrays.asList("test", "test3");
        return ProcessConfig.builder()
                //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
                //根据名称指定表生成
                //.designatedTableName(Arrays.asList("acl_user"))
                //根据表前缀生成
                //.designatedTablePrefix(Arrays.asList("acl_role"))
                //根据表后缀生成
                //.designatedTableSuffix(new ArrayList())
                //忽略表名
                .ignoreTableName(ignoreTableName)
                //忽略表前缀
                .ignoreTablePrefix(ignorePrefix)
                //忽略表后缀
                .ignoreTableSuffix(ignoreSuffix).build();
    }
}

使用方式二：

1.新建maven项目

2.直接配置maven插件

<build>
        <plugins>
            <plugin>
                <groupId>cn.smallbun.screw</groupId>
                <artifactId>screw-maven-plugin</artifactId>
                <version>1.0.5</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.11</version>
                    </dependency>
                </dependencies>
                <configuration>
                    <!--username-->
                    <username>root</username>
                    <!--password-->
                    <password>root</password>
                    <!--driver-->
                    <driverClassName>com.mysql.cj.jdbc.Driver</driverClassName>
                    <!--jdbc url-->
                    <jdbcUrl>jdbc:mysql://127.0.0.1:3306/web_tv?characterEncoding=utf-8&amp;serverTimezone=UTC</jdbcUrl>
                    <!--生成文件类型-->
                    <fileType>HTML</fileType>
                    <fileOutputDir>D:/sqlFile/ProductExperienceCenter</fileOutputDir>
                    <!--打开文件输出目录-->
                    <openOutputDir>false</openOutputDir>
                    <!--生成模板-->
                    <produceType>freemarker</produceType>
                    <!--文档名称 为空时:将采用[数据库名称-描述-版本号]作为文档名称-->
                    <fileName>测试文档名称</fileName>
                    <!--描述-->
                    <description>数据库文档生成</description>
                    <!--版本-->
                    <version>1.1.2</version>
                    <!--标题-->
                    <title>数据库文档</title>
                </configuration>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>run</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

依赖jar包

https://www.aliyundrive.com/s/4FEbVqx6TrY