数据库文档自动生成

MySQL数据库设计文档生成

1. 创建一个springboot项目

2. 依赖

   
       <dependencies>
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter</artifactId>
           </dependency>
   
           <!-- screw核心 -->
           <dependency>
               <groupId>cn.smallbun.screw</groupId>
               <artifactId>screw-core</artifactId>
               <version>1.0.5</version>
           </dependency>
   
           <dependency>
               <groupId>com.zaxxer</groupId>
               <artifactId>HikariCP</artifactId>
               <version>3.4.5</version>
           </dependency>
   
           <dependency>
               <groupId>mysql</groupId>
               <artifactId>mysql-connector-java</artifactId>
               <scope>runtime</scope>
           </dependency>
          
           <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-test</artifactId>
               <scope>test</scope>
           </dependency>
       </dependencies>
   
   
   

3. 配置文件无需配置

4. 测试类

@SpringBootTest
class DbDocApplicationTests {

    /**
     * 自动生成数据库文档
     */
    @Test
    void contextLoads() {

        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://localhost:3306/card-user?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai");
        hikariConfig.setUsername("root");
        hikariConfig.setPassword("123456");
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);

        // 1、生成文件配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径(改成自己的生成路径)
                .fileOutputDir("D:\\mysqldocument")
                //生成后是否立即打开目录
                .openOutputDir(true)
                //文件类型  有HTML、WORD、MD三种枚举选择
                .fileType(EngineFileType.MD)
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .fileName("数据库文档4").build();

        //忽略表名（可选）
        ArrayList<String> ignoreTableName = new ArrayList<>();
        //ignoreTableName.add("xxl_job_group");
        //ignoreTableName.add("xxl_job_info");
        // 忽略表前缀（可选）
        ArrayList<String> ignorePrefix = new ArrayList<>();
        //ignorePrefix.add("xxl_");
        // 忽略表后缀（可选）
        ArrayList<String> ignoreSuffix = new ArrayList<>();
        //ignoreSuffix.add("_user");

        // 2、配置想要忽略的表（可选）
        ProcessConfig processConfig = ProcessConfig.builder()
                .ignoreTableName(ignoreTableName)
                .ignoreTablePrefix(ignorePrefix)
                .ignoreTableSuffix(ignoreSuffix)
                .build();
        //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
        //根据名称指定表生成
        //.designatedTableName(new ArrayList<>())
        //根据表前缀生成
        //.designatedTablePrefix(new ArrayList<>())
        //根据表后缀生成
        //.designatedTableSuffix(new ArrayList<>())
        //忽略表名
        //.ignoreTableName(ignoreTableName)
        //.build();

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

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

    }

}

点击运行测试类即可生成文档！！！