如何导出数据库数据字典

叁歲伎倆 2024-03-26 23:40 86阅读 0赞

1、随便找一个工程项目，在项目build.gradle配置文件添加以下依赖

compile group: 'cn.smallbun.screw', name: 'screw-core', version: '1.0.5'

2、刷新下载依赖  
![在这里插入图片描述][601cf1f56d1549d380d85d7679a20a69.png]

3、将以下代码拷贝到工程任意Java目录  
ScrewDemo.java

package com.xxx;
    
    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;
    import java.util.List;
    
    public class ScrewDemo {
    
        public static void main(String[] args) {
            new ScrewDemo().documentGeneration();
        }
    
        /**
         * 文档生成
         */
        void documentGeneration() {
    
            // 生成在当前工程下,例如C:\Users\S0Z04RU\IdeaProjects\order\global-adapter\source
            String fileOutputDir = System.getProperty("user.dir");
    
            //数据源（修改成对应的DB）
            HikariConfig hikariConfig = new HikariConfig();
            hikariConfig.setDriverClassName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
            hikariConfig.setJdbcUrl("jdbc:sqlserver://xxx\\\\xxx:14481;databaseName=xxx");
            hikariConfig.setUsername("xxx");
            hikariConfig.setPassword("xxx");
            //设置可以获取tables remarks信息
            hikariConfig.addDataSourceProperty("useInformationSchema", "true");
            hikariConfig.setMinimumIdle(2);
            hikariConfig.setMaximumPoolSize(5);
            DataSource dataSource = new HikariDataSource(hikariConfig);
            //生成配置
            EngineConfig engineConfig = EngineConfig.builder()
                    //生成文件路径
                    .fileOutputDir(fileOutputDir)
                    //打开目录
                    .openOutputDir(true)
                    //文件类型
                    .fileType(EngineFileType.MD)
                    //生成模板实现
                    .produceType(EngineTemplateType.freemarker)
                    //自定义文件名称(自己修改)
                    .fileName("xxx数据库数据字典").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");
    
            // 指定表名去生成
            List<String> tables = new ArrayList<>();
    //        tables.add("xxx");
    
            ProcessConfig processConfig = ProcessConfig.builder()
                    //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
                    //根据名称指定表生成
                    .designatedTableName(tables)
                    //根据表前缀生成
                    .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();
        }
    
    }

4、修改示例代码的内容：包括数据库链接，导出文件名称，导出文件类型，是否有忽略表，是否有指定表等

5、点击运行示例代码的main方法，会生成一个数据字典文件，在项目工程的根目录  
![在这里插入图片描述][c58438804a85491fb6544c06978ae01c.png]

[601cf1f56d1549d380d85d7679a20a69.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/f6a2c9c8b3e94e579280c585b02197d6.png
[c58438804a85491fb6544c06978ae01c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/fa3d4446c44c43fb8723e2cbba384157.png