GitHub地址

pom

<dependency>
    <groupId>cn.smallbun.screw</groupId>
    <artifactId>screw-core</artifactId>
    <version>1.0.5</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
    <version>5.0.0</version>
    <scope>test</scope>
</dependency>

工具类

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 lombok.Data;

import javax.sql.DataSource;
import java.util.ArrayList;

/**
 * @author JHL
 * @version 1.0
 * @date 2022/10/24 11:50
 * @since : JDK 11
 */
public class DbGenUtil {

    public static void main(String[] args) {
        GenDocConfig config = new GenDocConfig();
        config.setUrl("jdbc:mysql://192.168.2.168:3306/digit_highway?serverTimezone=Asia/Shanghai&useSSL=false&useUnicode=true&characterEncoding=utf-8");
        config.setUsername("root");
        config.setPwd("root");
        config.setOutDir(".");
        config.setFileName("db_doc");
        // 生成
        documentGeneration(config);
    }

    @Data
    private static class GenDocConfig {
        /**
         * 数据库连接地址
         */
        private String url;
        /**
         * 数据库用户名
         */
        private String username;
        /**
         * 密码
         */
        private String pwd;
        /**
         * 输出目录
         */
        private String outDir;
        /**
         * 输出文件名(不包含扩展名)
         */
        private String fileName;
        /**
         * 文件类型
         */
        private EngineFileType fileType = EngineFileType.HTML;
    }

    /**
     * 文档生成
     */
    public static void documentGeneration(GenDocConfig conf) {
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl(conf.getUrl());
        hikariConfig.setUsername(conf.getUsername());
        hikariConfig.setPassword(conf.getPwd());
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径
                .fileOutputDir(conf.getOutDir())
                //打开目录
                .openOutputDir(true)
                //文件类型
                .fileType(conf.getFileType())
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .fileName(conf.getFileName()).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();
    }
}