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

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

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

    org.freemarker
    freemarker
    2.3.29


    cn.smallbun.screw
    screw-core
    1.0.5

生成数据库文档 方式一

• 1.修改pom.xml，在其中添加内容

    
        
            cn.smallbun.screw
            screw-maven-plugin
            1.0.5
            
                
                
                    com.zaxxer
                    HikariCP
                    3.4.5
                
                
                
                    mysql
                    mysql-connector-java
                    8.0.20
                
            
            
                
                root
                
                root
                
                com.mysql.cj.jdbc.Driver
                
                jdbc:mysql://localhost:3306/db_wego?useSSL=false&serverTimezone=GMT%2B8
                
                HTML
                
                false
                
                freemarker
                
                测试文档名称
                
                数据库文档生成
                
                ${project.version}
                
                数据库文档
            
            
                
                    compile
                    
                        run
                    
                
            
        
    

• 2. 生成

方式二

/**
* 文档生成
*/
public class GenDatabaseDescFileUtil {
    public static void main(String[] args) {
        //数据源
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://localhost:3306/db_wego?useSSL=false&serverTimezone=GMT%2B8");
        hikariConfig.setUsername("root");
        hikariConfig.setPassword("root");
        //设置可以获取tables remarks信息
        hikariConfig.addDataSourceProperty("useInformationSchema", "true");
        hikariConfig.setMinimumIdle(2);
        hikariConfig.setMaximumPoolSize(5);
        DataSource dataSource = new HikariDataSource(hikariConfig);
        //生成配置
        EngineConfig engineConfig = EngineConfig.builder()
                //生成文件路径
                .fileOutputDir("../db")
                //打开目录
                .openOutputDir(true)
                //文件类型
                .fileType(EngineFileType.HTML)
                //生成模板实现
                .produceType(EngineTemplateType.freemarker)
                //自定义文件名称
                .fileName("自定义文件名称").build();

        //忽略表
        ArrayList ignoreTableName = new ArrayList();
        ignoreTableName.add("test_user");
        ignoreTableName.add("test_group");
        //忽略表前缀
        ArrayList ignorePrefix = new ArrayList();
        ignorePrefix.add("test_");
        //忽略表后缀
        ArrayList ignoreSuffix = new ArrayList();
        ignoreSuffix.add("_test");
        ProcessConfig processConfig = ProcessConfig.builder()
                //指定生成逻辑、当存在指定表、指定表前缀、指定表后缀时，将生成指定表，其余表不生成、并跳过忽略表配置
                //根据名称指定表生成
                .designatedTableName(new ArrayList())
                //根据表前缀生成
                .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();
    }
}

方法三

• 1.修改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

• 2. 生成代码

@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 ignoreTableName = Arrays.asList("test_group");
      // 忽略表前缀，如忽略a开头的数据库表
      List ignorePrefix = Arrays.asList("ttb_");
      // 忽略表后缀
      List ignoreSuffix = Arrays.asList("_test","czb_");

      return ProcessConfig.builder()
            //根据名称指定表生成
            .designatedTableName(new ArrayList())
            //根据表前缀生成
            .designatedTablePrefix(new ArrayList())
            //根据表后缀生成
            .designatedTableSuffix(new ArrayList())
            //忽略表名
            .ignoreTableName(ignoreTableName)
            //忽略表前缀
            .ignoreTablePrefix(ignorePrefix)
            //忽略表后缀
            .ignoreTableSuffix(ignoreSuffix).build();
   }
}