数据库文档生成工具screw

迈不过友情╰ 2022-09-13 11:25 144阅读 0赞

# 结果展示 #

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5riF5qyieXN5_size_20_color_FFFFFF_t_70_g_se_x_16]

# 官网 #

https://github.com/pingfangushi/screw

# 添加依赖 #

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

# 代码 #

documentGeneration 直接加载man函数中，执行项目后会生成数据库文档。

public static void main(String[] args) {
            documentGeneration();
        }
            static void documentGeneration() {
                //数据源
                HikariConfig hikariConfig = new HikariConfig();
                hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
                hikariConfig.setJdbcUrl("jdbc:mysql://209:13306/");
                hikariConfig.setUsername("");
                hikariConfig.setPassword("");
                //设置可以获取tables remarks信息
                hikariConfig.addDataSourceProperty("useInformationSchema", "true");
                hikariConfig.setMinimumIdle(2);
                hikariConfig.setMaximumPoolSize(5);
                DataSource dataSource = new HikariDataSource(hikariConfig);
                //生成配置
                EngineConfig engineConfig = EngineConfig.builder()
                        //生成文件路径
                        .fileOutputDir("D:\\code\\")
                        //打开目录
                        .openOutputDir(true)
                        //文件类型
                        .fileType(EngineFileType.WORD)
                        //生成模板实现
                        .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();
            }

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5riF5qyieXN5_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/a47ed25d4ffa44839714dcb4730c0a5f.png