数据库设计文档生成工具类

女爷i 2022-10-07 01:57 144阅读 0赞

**在企业级开发中、我们经常会有编写数据库表结构文档的时间付出，如果数据库表结构更新了还得手动更新维护到文档中，很是繁琐。GitHub 上发现了一个好工具 screw（螺丝钉），在此分享下**

*  1、引入依赖

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

核心 cn.smallbun.screw

*  2、生成工具类

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 javax.sql.DataSource;
    import java.util.ArrayList;
    
    /** * 数据库设计文档生成类 */
    public class BuildDatabaseDoc { 
        /** * 文档生成 */
        public static void main(String[] args) { 
            // 数据源
            HikariConfig hikariConfig = new HikariConfig();
            // 数据库连接信息
            hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
            hikariConfig.setJdbcUrl("jdbc:mysql://localhost:3306/walking?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC");
            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("E:/")
                    // 打开目录
                    .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();
        }
    }

*  3、效果图预览  
    ![效果图1][1]  
    ![效果图2][2]

如您在阅读中发现不足，欢迎留言！！！

[1]: /images/20221005/30cb18c8bae642c5acfed710f34d35d9.png
[2]: /images/20221005/ee746c893f724ff7973a5c4a49976995.png