SpringBoot +Freemarker+ Screw 生成数据库文档

水深无声 2023-01-17 10:58 145阅读 0赞

## 最终生成的数据库文档的效果 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpYW5naGVjYWk1MjE3MTMxNA_size_16_color_FFFFFF_t_70]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpYW5naGVjYWk1MjE3MTMxNA_size_16_color_FFFFFF_t_70 1]

## 实现 ##

### 第一步：创建SpringBoot项目，按如下所示添加依赖： ###

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

### 第二步：修改application.yml文件，为其添加如下内容： ###

spring:
      datasource:
        driver-class-name: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://localhost:3306/db_blog?useSSL=false&serverTimezone=GMT%2B8&characterEncoding=utf8&useUnicode=true&allowPublicKeyRetrieval=true
        username: root
        password: root

### 第三步：生成数据库文档的工具类： ###

@SpringBootTest
    class GenDatabaseDescFileUtil { 
    
       @Autowired
       ApplicationContext applicationContext;
    
       @Test
       void genDbDescHtmlFile() { 
          DataSource ds = applicationContext.getBean(DataSource.class);
    
          // 生成文件配置
          EngineConfig engineConfig = EngineConfig.builder()
                // 生成文件路径，自己mac本地的地址，这里需要自己更换下路径
                .fileOutputDir("../db")
                // 打开目录
                .openOutputDir(false)
                // 文件类型
                .fileType(EngineFileType.HTML)
                // 生成模板实现
                .produceType(EngineTemplateType.freemarker).build();
    
          // 生成文档配置（包含以下自定义版本号、描述等配置连接）
          Configuration config = Configuration.builder()
                .version("1.0.0")
                .description("题库数据库文档")
                .dataSource(ds)
                .engineConfig(engineConfig)
                .produceConfig(getProcessConfig())
                .build();
    
          // 执行生成
          new DocumentationExecute(config).execute();
       }
    
    
       /** * 配置想要生成的表+ 配置想要忽略的表 * @return 生成表配置 */
       private static ProcessConfig getProcessConfig(){ 
          // 忽略表名
          List<String> ignoreTableName = Arrays.asList("test_group");
          // 忽略表前缀，如忽略a开头的数据库表
          List<String> ignorePrefix = Arrays.asList("ttb_");
          // 忽略表后缀
          List<String> ignoreSuffix = Arrays.asList("_test","czb_");
    
          return ProcessConfig.builder()
                //根据名称指定表生成
                .designatedTableName(new ArrayList<>())
                //根据表前缀生成
                .designatedTablePrefix(new ArrayList<>())
                //根据表后缀生成
                .designatedTableSuffix(new ArrayList<>())
                //忽略表名
                .ignoreTableName(ignoreTableName)
                //忽略表前缀
                .ignoreTablePrefix(ignorePrefix)
                //忽略表后缀
                .ignoreTableSuffix(ignoreSuffix).build();
       }
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpYW5naGVjYWk1MjE3MTMxNA_size_16_color_FFFFFF_t_70]: /images/20221021/2f88b9e6128e403b8a1b9880912248d7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpYW5naGVjYWk1MjE3MTMxNA_size_16_color_FFFFFF_t_70 1]: /images/20221021/0916ec2654be4362b9f38e1b15fa4a69.png