screw生成数据库文档（详细教程）

一、新建springboot项目

1，新建springboot项目，选择必需依赖

说明：这里MySQL和Oracle的驱动我都选了，主要是平时常用的数据库就这两个，这两个添加好之后之后需要生成不同数据库的文档只用修改数据库连接配置文件就行，不同再单独添加依赖。

2、配置数据库连接（Oracle）

说明：配置数据库连接信息就可以，这里配置的是Oracle的连接，如果MySQL不知道如何连接的话百度下，一堆。

二、添加必需依赖

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

这部没有特别说明，这个开源项目还在更新中，后续会支持更多类型数据库吧，如果需要新版本的话，文末会附上开源项目地址。

三、代码部分

在springboot test测试类中编写即可

package com.light.testdbfile;

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 org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.ApplicationContext;

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

@SpringBootTest
class TestdbfileApplicationTests {

    @Autowired
    ApplicationContext applicationContext;
    @Test
    void contextLoads() {
        DataSource dataSourceMysql = applicationContext.getBean(DataSource.class);

        // 生成文件配置
        EngineConfig engineConfig = EngineConfig.builder()
                // 生成文件路径
                .fileOutputDir("E:\\User")
                // 打开目录
                .openOutputDir(false)
                // 文件类型(目前支持html、doc、MD格式，个人体验后还是html格式生成后看起来比较舒服，建议使用)
                .fileType(EngineFileType.HTML)
                // 生成模板实现
                .produceType(EngineTemplateType.freemarker).build();

        // 生成文档配置（包含以下自定义版本号、描述等配置连接）
        Configuration config = Configuration.builder()
                .version("1.0.0")
                .description("生成文档信息描述")
                .dataSource(dataSourceMysql)
                .engineConfig(engineConfig)
                .produceConfig(getProcessConfig())
                .build();

        // 执行生成
        new DocumentationExecute(config).execute();
    }


    /**
     * 配置想要生成的表+ 配置想要忽略的表
     * @return 生成表配置
     */
    public static ProcessConfig getProcessConfig(){
        // 忽略表名，需要忽略的表将表名放到list中即可
        List<String> ignoreTableName = Arrays.asList("aa","test_group");
        // 忽略表前缀，如忽略a开头的数据库表
        List<String> ignorePrefix = Arrays.asList("a","t");
        // 忽略表后缀
        List<String> ignoreSuffix = Arrays.asList("_test","czb_");

        return ProcessConfig.builder()
                //根据名称指定表生成
                .designatedTableName(new ArrayList<>())
                //根据表前缀生成
                .designatedTablePrefix(new ArrayList<>())
                //根据表后缀生成
                .designatedTableSuffix(new ArrayList<>())
                //忽略表名
                .ignoreTableName(ignoreTableName)
                //忽略表前缀
                .ignoreTablePrefix(ignorePrefix)
                //忽略表后缀
                .ignoreTableSuffix(ignoreSuffix).build();
    }

}

说明：注意修改文件输出路径，其余基本没有要修改的地方，可以直接运行测试类。

四、效果图

五、感谢开源作者

简洁好用的数据库表结构文档生成工具: screw