java导出数据库结构 word文档

java导出数据库结构 word文档

1.导入maven包

       
        
            cn.smallbun.screw
            screw-core
            1.0.5
        
        
            mysql
            mysql-connector-java
            8.0.23 
        

2.创建main方法

import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
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;


   /**
     * 主程序入口。
     * 主要功能是通过Hikari连接池配置数据库连接，并使用MyBatis Doc工具生成数据库结构文档。
     * 具体步骤包括：
     * 1. 配置Hikari连接池参数，包括数据库驱动、JDBC URL、用户名和密码等。
     * 2. 配置生成文件的相关参数，如输出目录、文件类型和模板实现方式等。
     * 3. 设置要忽略的表前缀。
     * 4. 配置需要处理的表和生成文档的详细配置，包括版本号、描述和数据源等。
     * 5. 执行文档生成操作。
     */
    public static void main(String[] args) {
        // 配置Hikari连接池
        HikariConfig hikariConfig = new HikariConfig();
        try {
            Class.forName("com.mysql.cj.jdbc.Driver"); // 显式加载数据库驱动类
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
            throw new RuntimeException("数据库驱动类加载失败，请确保驱动包已正确添加到项目中", e);
        }
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=Asia/Shanghai");
        hikariConfig.setUsername("root");
        hikariConfig.setPassword("111111");
        // 设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);

        // 配置生成文件相关参数
        EngineConfig engineConfig = EngineConfig.builder()
                // 生成文件路径
                .fileOutputDir("/Users/Downloads/")
                // 打开目录
                .openOutputDir(false)
                // 文件类型
                .fileType(EngineFileType.WORD)
                // 生成模板实现
                .produceType(EngineTemplateType.freemarker).build();

        // 忽略表前缀
        List<String> ignoreTablePrefix = Arrays.asList("gen_", "old_", "t_");

        // 配置处理表的参数
        ProcessConfig processConfig = ProcessConfig.builder().ignoreTablePrefix(ignoreTablePrefix).build();

        // 配置生成文档的详细信息
        Configuration config = Configuration.builder().version("1.0.0").description("数据库结构说明文档").dataSource(dataSource).engineConfig(engineConfig).produceConfig(processConfig).build();

        // 执行生成文档操作
        new DocumentationExecute(config).execute();
    }

3.效果