数据库表结构生成文档

该方法可以根据数据库的表一键生成想要的word表格说明文档

POM

        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>3.4.5</version>
        </dependency>
        <dependency>
            <groupId>cn.smallbun.screw</groupId>
            <artifactId>screw-core</artifactId>
            <version>1.0.5</version>
        </dependency>
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity</artifactId>
            <version>1.7</version>
        </dependency>

代码

private void documentGeneration(){
        HikariConfig config = new HikariConfig();
        config.setDriverClassName("oracle.jdbc.driver.OracleDriver");
        config.setJdbcUrl("jdbc:oracle......");
        config.setUsername("xxx");
        config.setPassword("xxx");
        config.setSchema("xxx");
        config.addDataSourceProperty("remarksReporting",true); //oracle
//        config.addDataSourceProperty("useInformationSchema",true); //mysql

        HikariDataSource dataSource = new HikariDataSource(config);
        EngineConfig engineConfig = EngineConfig.builder()
                .fileOutputDir("//放置的位置")
                .openOutputDir(true)
                .fileType(EngineFileType.WORD)
                .produceType(EngineTemplateType.velocity)
                .build();

        ProcessConfig processConfig = ProcessConfig.builder()
                .designatedTableName(Arrays.asList("table1", "table2"))
//                .designatedTablePrefix(new ArrayList<>())
//                .designatedTableSuffix()
//                .ignoreTableName()
//                .ignoreTablePrefix()
//                .ignoreTableSuffix()
                .build();

        Configuration configuration = Configuration.builder()
                .version("1.0.0")
                .description("数据库说明文档")
                .dataSource(dataSource)
                .engineConfig(engineConfig)
                .produceConfig(processConfig)
                .build();

        new DocumentationExecute(configuration).execute();
    }