screw-core​生成数据库文档

screw-core​生成数据库文档

1、打开

https://toscode.gitee.com/leshalv/screw

下载zip代码然后解压

2、创建一个srpingboot项目，或者在已有的springboot项目的pom文件中引入screw模块

在项目的pom.xml中加上引用

<dependency>
    <groupId>cn.smallbun.screw</groupId>
    <artifactId>screw-core</artifactId>
    <version>${lastVersion}</version>
 </dependency>

注意：${lastVersion}改为当前最新版本,目前为 1.0.5

3、在项目中添加运行的类，运行后就会在对应的目录下生成数据库文档

public class TestUtil {

    public static void main(String[] args) {
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("mysql连接地址");
        hikariConfig.setUsername("用户名");
        hikariConfig.setPassword("密码");
        // 设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);

        // 1、生成文件配置
        EngineConfig engineConfig = EngineConfig.builder()
                // 生成文件路径
                .fileOutputDir("d:\\user\\80005590\\desktop\\download\\database2MD")
                // 打开目录
                .openOutputDir(false)
                // 文件类型
                .fileType(EngineFileType.WORD)
                // 生成模板实现
                .produceType(EngineTemplateType.freemarker).build();

        List<String> designatedPrefix = Arrays.asList("ts_","tt_");

        // 2、配置想要获取或忽略的表
        ProcessConfig processConfig = ProcessConfig.builder().designatedTablePrefix(designatedPrefix).build();

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

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