Spring Boot 生成数据库文档

「爱情、让人受尽委屈。」 2022-12-13 04:47 278阅读 1赞

# screw 特点 #

*  简洁、轻量、设计良好。
 *  多数据库支持 。支持市面常见的数据库类型。
 *  多种格式文档。支持 MarkDown、HTML、WORD 格式。
 *  灵活扩展。支持用户自定义模板和展示样式。

## 数据库支持 ##

1.  MySQL
2.  Oracle
3.  SQL Server
4.  MariaDB
5.  TiDB
6.  PostgreSQL
7.  Cache DB

## 文档生成支持 ##

1.  HTML
2.  Word
3.  Markdown

# SpringBoot整合screw生成数据库文档 #

## 1. pom.xml增加依赖 ##

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

## 2. 设置数据库连接 ##

spring.datasource.url=jdbc:mysql://127.0.0.1:3306/svccmi?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true
    spring.datasource.username=mydb
    spring.datasource.password=123456
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    spring.datasource.xa.properties.useInformationSchema=true

## 3. 代码生成 ##

单元测试代码中生成文档

package com.jeiker.screw;
    
    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.Arrays;
    import java.util.List;
    
    @SpringBootTest
    class SpringBootScrewApplicationTests { 
    
        @Autowired
        private ApplicationContext applicationContext;
    
        @Test
        void contextLoads() { 
            DataSource dataSourceMysql = applicationContext.getBean(DataSource.class);
    
            // 1.生成文件配置
            EngineConfig engineConfig = EngineConfig.builder()
                    // 生成文件路径
                    .fileOutputDir("./file")
                    // 打开目录
                    .openOutputDir(false)
                    // 文件类型(目前支持 HTML、WORD、MD 格式，个人建议使用html)
                    .fileType(EngineFileType.HTML)
    // .fileType(EngineFileType.WORD)
    // .fileType(EngineFileType.MD)
                    // 生成模板实现
                    .produceType(EngineTemplateType.freemarker).build();
    
            // 2.生成文档配置（包含以下自定义版本号、描述等配置连接）
            Configuration config = Configuration.builder()
                    .version("1.0.0")
                    .description("生成文档信息描述")
                    .dataSource(dataSourceMysql)
                    .engineConfig(engineConfig)
                    .produceConfig(getProcessConfig())
                    .build();
    
            // 3.执行生成
            new DocumentationExecute(config).execute();
        }
    
    
        /** * 配置想要忽略的表 * @return 生成表配置 */
        public static ProcessConfig getProcessConfig(){ 
            // 忽略表名，需要忽略的表将表名放到list中即可
            List<String> ignoreTableName = Arrays.asList("aa","bb");
            // 忽略表前缀，如忽略a开头的数据库表
            List<String> ignorePrefix = Arrays.asList("a_","b_");
            // 忽略表后缀
            List<String> ignoreSuffix = Arrays.asList("_copy","_bak");
    
            return ProcessConfig.builder()
                    //忽略表名
                    .ignoreTableName(ignoreTableName)
                    //忽略表前缀
                    .ignoreTablePrefix(ignorePrefix)
                    //忽略表后缀
                    .ignoreTableSuffix(ignoreSuffix)
                    .build();
        }
    
    }

## 4. 运行单元测试代码 ##

启动run，运行测试类或contextLoads方法，即可在当前目录的file目录下看到生成的文件。

![数据库图片][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2plaWtlcnhpYW8_size_16_color_FFFFFF_t_70_pic_center]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2plaWtlcnhpYW8_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/fae73f1014164980a5d18ba93daf9bf7.png